Welcome > Integration module > CCM > Integrate TotalAgility with CCM

Integrate TotalAgility with CCM

Before setting up the integration to CCM (Customer Communication Manager), either manually update the CCM server URL in the TotalAgility Web.config or run the CCM proxy configuration (which automatically updates the Web.config). See the Kofax TotalAgility Installation guide.

  1. On the Home page, click Integration > CCM.

    The CCM Instances page appears. Any existing instances appear on the list.

  2. Click Add for the CCM Instance.

    On the CCM Instance Configuration page that appears, you can add one or more CCM instances.

    Note If the CCM server is not preconfigured in the TotalAgility Web.config file, a message appears and you cannot add an instance.
  3. Enter an ID for the CCM instance.
    Note You cannot edit the ID once it is saved.
  4. Enter a Display Name for the CCM instance to help identify the CCM instance.
  5. The URL to the CCM server is displayed.
    The URL provides access to all the projects available in the CCM server.
    Note This read-only field is pre-populated based on the information available in TotalAgility Web.config.
  6. The Port number is displayed. (Default: 8081)
    Note This read-only field is pre-populated based on the information available in TotalAgility Web.config.
  7. Enter a Partner Id. If left blank, a message appears.
    Note The Partner Id is case sensitive.
  8. Enter a Customer Id to connect to a CCM server. If left blank, a message appears.
    Note Multiple developers working on a solution can use the same customer ID to access the same projects and templates.
  9. To use the application keys set on the CCM server so that TotalAgility can be used within CCM in security aware environments, click Yes for Use Application Autentication and do the following. (Default: No)
    1. In the Application Name box, enter the application name, such as Kofax TotalAgility. The application name can be chosen by the system administrator.
      The application name can only consist of alphanumeric characters (a-z, A-Z, 0-9) and an underscore (_). The maximum length is 50.
    2. In the Application Key box, enter the key. The key is a generated password of fixed length (64 characters).
      The connection to CCM fails if the application name or key is invalid.
  10. Click Connect to test the connection to CCM.

    A list of projects associated with the CCM server appears on the Available list. If the connection fails, an error is displayed.

  11. Click Refresh to regenerate the project list and retrieve the latest projects added to the CCM server.
    If any of the selected projects has been removed, a message is displayed.
  12. Move the needed projects from the Available list to the Selected list.
  13. Select a Document Template Version to use for this CCM instance.
    • Published
    • Current
    • Accepted

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

  14. Click OK.

    The CCM instance is integrated with TotalAgility.

    Note To delete an instance, select the instance and click Delete. The system displays a warning message before deleting the instance. Click OK to confirm deletion.