Welcome > Settings

Settings

You can view and update several Invoice Processing Agility configuration settings on the Settings page.

The options available on this page are different if you are using Invoice Processing Agility in and Azure environment.

Note You must be a member of the IPA_Administrators resource group in order to have access to this page and the Solution Configuration Manager.

You can configure information, such as the configuration database connection string, the database connection password, and the Solution Configuration Manager variable.

The configuration database is used to perform activities, such as extraction, validation, export, and line pairing within Invoice Processing Agility. Solution Configuration Manager enables you to update the configuration database tables.

The options on the Settings page are saved to the Kofax TotalAgility server variable. For more information, refer to the Kofax TotalAgility Help.

The following settings are available.

Solution Configuration Manager

Use this group to configure the connection to the Solution Configuration Manager website and has the following options.

URL

The URL for the Solution Configuration Manager.

Launch SCM

Launches the Solution Configuration Manager in a separate browser tab or window.

Save SCM Settings

Saves the settings for this group.

Client Database

Use this group to configure the connection to the Invoice Processing Agility configuration database.

Connection String

This is the connection string needed to connect to the Invoice Processing Agility configuration database.

Save Client Database Settings

Saves the Invoice Processing Agility configuration database settings and updates the Kofax TotalAgility server variables.

Any changes to this group requires a restart of the following services.

  • Kofax TotalAgility Core Worker

  • Kofax Transformation Server

  • World Wide Web Publishing Service

User Exits

Use this group to configure the user exits if you are using custom scripts.

Note All of the user exit fields are optional.

The group has the following options.

Extraction Assembly

This is the strong name of the assembly that contains the user exit implementations for extraction. A strong name is not just a DLL name and resembles something like UserExitExtraction, Version=1.0.0.0, Culture=neutral, PublicKeyToken=3057196b1314d857, processorArchitecture=MSIL. When you store the user exit settings, a plausibility test is done and an error is raised if the passed value does not look like a strong name.

Extraction Class

This is the fully qualified name of the class that implements the ICustomInitializer interface within the extraction assembly.

Validation Assembly

This is the strong name of the assembly that contains the user exit implementations for validation. A strong name is not just a DLL name and resembles something like UserExitValidation, Version=1.0.0.0, Culture=neutral, PublicKeyToken=3057196b1314d857, processorArchitecture=MSIL. When you store the user exit settings, a plausibility test is done and an error is raised if the passed value does not look like a strong name.

Validation Class

This is the fully qualified name of the class that implements the ICustomInitializer interface within the validation assembly.

Save User Exit Settings

Saves the user exit settings and update the Kofax TotalAgility server variables.

Any changes to this group requires a restart of the following services.

  • Kofax TotalAgility Core Worker

  • Kofax Transformation Server

  • World Wide Web Publishing Service

Logging

Use this group to configure how Invoice Processing Agility logging behaves for your installation. This group has the following options.

Directory

The name of the Invoice Processing Agility logging directory. You can set the logging directory to a local drive location of your choice.

Log level

Choose a log level from one of the following options.

  • "Error." Records error events.

  • "Warning." Records potentially harmful situations.

  • "Info." Records informational messages that highlight the progress of the application at a detailed level.

  • "Debug." Records fine-grained informational events that are used to troubleshoot and debug the application.

Log files are generated based on the level of logging selected here.

Log files count

The maximum number of log files that can be generated. If you set this to 50, then 50 log files can be created, which can have a collective size of 5MB. If the 50th log file exceeds the 5MB limit, then the first log file is deleted.

Save Logging Settings

Click to save the logging directory settings.

Help

Use this group to modify the location of the help when using offline files. Do not edit this path otherwise.

Help Base URL

Since the help for Invoice Processing Agility is hosted, the default value for the base URL is https://docshield.kofax.com/.

Important Do not make changes to this field unless you are configuring offline help. For more information about configuring offline help, see the Invoice Processing Agility Installation Guide.
Save Help Settings

Saves the Help settings.

PIX

Use this group to configure the connection to PIX after it is installed. These settings are required only when you are processing XML documents. For more information on installing PIX, see the Invoice Processing Agility Installation Guide.

Note The PIX settings must be configured after PIX is installed. You can install PIX on the same server as Kofax TotalAgility. Alternatively, you can install PIX Client and PIX Server together on a separate server, or separately on different servers.

These settings are empty when support for electronic invoices is not required.

Web client URI

Enter the PIX Web client in Kofax TotalAgility. This variable is dependant on how PIX is installed.

Web server URI

Enter the PIX Web server variable Kofax TotalAgility, by entering information, such as the port and the protocol (HTTP or HTTPS) used.

Save PIX Settings

Saves the PIX settings.