Administration

Use these settings to configure the top-level settings for Kofax AP Agility. Most of these settings apply to the Invoice Processing functionality only, However, changes made to the database or help settings affect both Invoice Processing and the AP Agility Workflow.

If you are using Kofax AP Agility in an Azure environment, refer to the Administration in an Azure environment.

The following settings are available.

AP Agility Database

Use this group to configure the connection to the Kofax AP Agility configuration database.

Connection String

This is the connection string needed to connect to the Kofax AP Agility configuration database.

Save Database Settings

Saves any changes made to the Kofax AP Agility configuration database settings and updates the Kofax TotalAgility server variables.

Licensing

Use this group to view the state of the Kofax AP Agility licensing. The group displays the license status for the following.

Invoice Processing license

Indicates if the Invoice Processing functionality of Kofax AP Agility is licensed. If a license is available, you can add invoices using the Scan activity or process invoices using the Validation activity, the Line Pairing Correction activity, or the PIX Correction activity. You can process invoices as long as they are scanned before the license expires.

When this Invoice Processing license is not available, the following functionality is not supported.

  • The Scan activity does not include any organizations, so cannot be used

  • Any jobs created using file or email import are suspended without processing

  • You cannot create or update an organization

AP Agility Workflow license

Indicates if the AP Agility Workflowfunctionality of Kofax AP Agility is licensed. If a license is available, you can process invoices using the Coding activity, the Approval activity, the Exception activity, the Line Pairing Exception activity, the Comment Request activity, or the Hold activity. You can process invoices as long as they are scanned before the license expires.

When the AP Agility Workflow license is not available, the following functionality is not supported.

  • You cannot create or update an organization that includes the AP Agility Workflow

  • You cannot start a job in the AP Agility Workflow

Restart Jobs

Click to restart the LICENSEUPDATE event and restart any jobs that may have stopped due to a missing license.

User Exits

Use this group to configure the user exits if you are using custom scripts. All of the user exit fields are optional.

The group has the following settings.

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 any changes made to the user exit 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

Logging

Use this group to configure how Kofax AP Agility logging behaves for your installation. This group has the following settings.

Directory

The name of the Kofax AP 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 values.

  • 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.

  • Trace.

    Records tracing information such as database queries and results for deeper analysis during troubleshooting.

  • None.

    Records no log entries at all.

Log files are generated based on the level of logging selected here. (Default: Info)

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

Saves any changes made to the logging 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 Kofax AP Agility Installation Guide.

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 any changes made to the PIX settings.

Invoice Portal

Use this group to configure a connection to Invoice Portal. Once a connection is established it is not necessary to make changes to this section unless Invoice Portal changes server or connection details.

Submit status updates

If selected, following status updates are submitted to Invoice Portal. (Default: Cleared)

  • Verified. This status is sent to Invoice Portal when a document is sent after manual validation or after the document has automatically bypassed validation.

    This status is supported if only the Invoice Processing functionality is enabled.

  • Approved. This status is sent to Invoice Portal when a document is sent after is has passed the approval workflow and has been successfully exported or posted to the target system.

    This status is supported only if the AP Workflow is enabled.

  • Rejected. This status is sent to Invoice Portal when a document is rejected during and Invoice Processing activity or an AP Workflow activity.

    This status is supported if only the Invoice Processing functionality is enabled.

Initialize Connection

This setting is enabled when the Submit status updates setting is selected above.

Before you can initialize a connection it is necessary to provide values for the Client Id, Client Secret Key, and Server Public Key settings below. Once you have this information, click this button to open the Initialize Connection to Invoice Portal window to initialize an Invoice Portal connection.

Client Id

This setting is enabled when the Submit status updates setting is selected above.

The client identification number that is needed to connect to Invoice Portal. This field is required before you can create a connection using the Initialize Connection to Invoice Portal window.

Client Secret Key

This setting is enabled when the Submit status updates setting is selected above.

The secret key needed to connect to Invoice Portal. This field is required before you can create a connection using the Initialize Connection to Invoice Portal window.

Server Public Key

This setting is enabled when the Submit status updates setting is selected above.

The public key needed to connect to Invoice Portal. This field is required before you can create a connection using the Initialize Connection to Invoice Portal window

Save Invoice Portal Settings

Saves any changes made to the Invoice Portal 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 Kofax AP Agility is hosted, the default value for the base URL is https://docshield.kofax.com/.

Do not make changes to this field unless you are configuring offline help. For more information about configuring offline help, see the Kofax AP Agility Installation Guide.

Save Help Settings

Saves the help settings.