› Integration › TCM › Integrate TotalAgility with TCM

Integrate TotalAgility with TCM

Before setting up the integration to TCM (Tungsten Communications Manager), either manually update the TCM server URL in the TotalAgility Web.config file or run the Setup.exe from the TCMProxyInstallation folder available at \\TungstenTotalAgility-8.1.0\TCMProxyInstallation in the TotalAgility installation files. Running this setup automatically updates Web.config. Refer to "TCM Proxy installation" in the Tungsten TotalAgility Installation guide for more information.

See TCM.

  1. Navigate to Integration > TCM.

    The TCM page appears. Any existing instances are displayed.

  2. Click New.

    The New TCM configuration dialog box is displayed. You can add one or more TCM instances.

    If the TCM 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 TCM instance. The system identifies the TCM instance with this ID.
    You cannot edit the ID once the configuration is saved.
  4. Enter a Display name for the TCM instance. This helps you identify the TCM instance in the list.
  5. The URL to the TCM server is displayed.
    The URL provides access to all the projects available on the TCM server.

    • This read-only field is pre-populated based on the information available in TotalAgility Web.config.

    • If the "Allow all" system setting is not enabled, you can only provide a whitelisted URL; otherwise, a message appears stating the connection is denied because the URL connection string is not whitelisted.

  6. The Port number is displayed. (Default: 8081)

    This read-only field is pre-populated based on the information available in TotalAgility Web.config.

  7. Enter a Partner ID.
    The Partner ID is case sensitive.
  8. Enter a Customer ID to connect to a TCM server.
    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 TCM server so that TotalAgility can be used within TCM in security-aware environments, select Use application authentication and do the following. (Default: Clear)
    1. 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.
    2. Enter the Application key. The key is a generated password of a fixed length (64 characters).
      The connection to TCM fails if the application name or key is invalid.
  10. To add the projects, do the following:
    1. Click Add for Projects.

      The Add projects dialog box displays the list of projects associated with the TCM server.

      If the connection to the TCM server fails, an error is displayed, and you cannot add the projects.

    2. Select the required projects from the Available items list.

      The selected projects are added to the Selected items list.

    3. Click Done.

      The selected projects appear under Projects in the New TCM configuration dialog box.

  11. Select a Document template version to use for this TCM 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 TCM 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.

  12. To test the connection, click Test connection.
  13. Click Save.

    The TCM instance is integrated with TotalAgility and is listed on the TCM page.

How to: Maintain a TCM integration