Integrate TotalAgility with KCM
Before setting up the integration to KCM (Kofax Communication Manager), either manually update the KCM server URL in the TotalAgility Web.config or run the KCM proxy configuration (which automatically updates the Web.config). See the Kofax TotalAgility Installation guide.
-
Navigate to
.
The KCM page appears. Any existing instances are displayed.
-
Click
New.
The New KCM configuration dialog box is displayed. You can add one or more KCM instances.
If the KCM server is not preconfigured in the TotalAgility Web.config file, a message appears and you cannot add an instance. -
Enter an
ID for the KCM instance.
The system identifies the KCM instance with this ID.
You cannot edit the ID once the configuration is saved.
- Enter a Display name for the KCM instance. This helps you identify the KCM instance in the list.
-
The
URL to the KCM server is
displayed.
The URL provides access to all the projects available in the KCM server.This read-only field is pre-populated based on the information available in TotalAgility Web.config.
-
The
Port number is displayed.
(Default: 8081)
This read-only field is pre-populated based on the information available in TotalAgility Web.config.
-
Enter a
Partner ID.
The Partner ID is case sensitive.
-
Enter a
Customer ID to connect to
a KCM server.
Multiple developers working on a solution can use the same customer ID to access the same projects and templates.
-
To use the application keys set on the KCM server so that
TotalAgility
can be used within KCM in security aware environments, select
Use application
authentication and do the following. (Default: Clear)
-
Enter the
Application name,
such as
TotalAgility.
The application name can be chosen by the system administrator.
The application name can only contain alphanumeric characters (a-z, A-Z, 0-9) and an underscore (_). The maximum length is 50.
-
Enter the
Application key. The
key is a generated password of fixed length (64 characters).
The connection to KCM fails if the application name or key is invalid.
-
Enter the
Application name,
such as
TotalAgility.
The application name can be chosen by the system administrator.
-
To add the projects, do the following:
-
Click
Add for
Projects.
The Add projects dialog box displays the list of projects associated with the KCM server.
If the connection to the KCM server fails, an error is displayed and you cannot add the projects.
-
Select the required projects from the
Available items list.
The selected projects are added to the Selected items list.
-
Click
Done.
The selected projects appear under Projects in the New KCM configuration dialog box.
-
Click
Add for
Projects.
-
Select a
Document template version
to use for this KCM instance.
- Published (Default)
- Current
- Accepted
The documents are generated based on the selected document template version. For example, if you select the published version and generate a document, the published version of the template is used.
You can modify the template version for a KCM instance. For example, if you switch the template version from published to current and generate the documents, the current version of the template is used.
-
Click
Save.
The KCM instance is integrated with TotalAgility and is listed on the KCM page.
Maintain a KCM instance
You can modify or delete a KCM instance.
-
To modify a KCM instance:
-
Navigate to
.
The KCM page displays the list of KCM instances.
-
Click the KCM instance to modify.
The Edit KCM configuration dialog box is displayed.
- Make the changes as needed.
- Click Save.
-
Navigate to
.
-
To delete a KCM instance, on the context menu for the KCM
instance to delete, click
Delete. The system
displays a warning message before deleting the instance.
On confirmation, the KCM instance is deleted.