Configure a CCM Distribute activity

  1. Add a CCM Distribute activity to the map. See Add an activity.
  2. On the Extended Properties page of the CCM Distribute activity, click the Configuration tab.
  3. Consume a CCM Instance.
    Note Distribution is not supported for a cloud deployment of CCM and an error appears if the instance is unsuitable.
  4. Consume a String variable for Pack ID.

    You must pass in the ID of a pack previously created in CCM and stored in TotalAgility.

    Note The pack generated for CCM does not contain the signed documents.
  5. Consume a variable or enter a static value (alphanumeric) for the Tracking ID.

    This value is reflected in the Customer Communication Management logs on the CCM server, if an error occurs. For example, you can enter a value for the job ID or case reference to correlate between your job in TotalAgility and document distribution in CCM.

  6. Select a Distribute Mechanism from the list.
    • Archive: The CCM server sends the documents to archive storage configured within the CCM server.
    • Email (Default): The CCM server distributes the documents through email.
    • Portal: The CCM server posts the documents to a Web portal so that recipients can view online.
      Note An email with a URL to access the documents, is sent to the user who must logon to a secure portal to view the documents.
    • Print: The CCM server sends the documents to a printer so that they can be printed.
    • SignDoc: The CCM server sends the documents for eSigning. Consume the SignDoc Server, Package ID, Signed PDF and the Package State. See Configure a SignDoc activity. At runtime, the activity completes only after the signing ceremony has been completed. The signers are defined in the template and the data in the backbone determines the actual signers.
    • Output Management: The CCM server distributes each document pack based on the centralized rules that are configured in the CCM Rules engine.

      Note The Output Management distribute mechanism is only available for the Document Pack Template type. When this distribution mechanism is selected, the document output type cannot be specified, and the pack (ZIP file) returned by CCM cannot be stored in the TotalAgility database. This is because the Batch Output Management engine determines the channel to send the documents, and the channel drives the output type.

      See Configure the Output Management distribution mechanism.

    Note When composing and distributing documents to SignDoc, the pack that is returned is the pack that is generated in CCM for signing; it does not contain the signed documents. The signed documents are held in a document variable mapped to the signedPDF property.

    CCM uses scripts to perform the distribution. The scripts are custom written and are shared across projects. Therefore scripts have no access to the data in the data backbone. The only way to pass data into the script is through metadata (a set of key/value pairs).

  7. Configure the Organizational Metadata:
    1. Enter a Key name. (free text)
    2. In the Value box, consume a variable or enter an inline value.
    3. Click . The key-value pair appears in the table.
  8. Click Save.
    Note If you configure the CCM Distribute activity on the Integration Server, the activity executes using the CCM server that is configured on the Integration Server.

Configure the Output Management distribution mechanism

  1. In the Import Request Reference box, consume a variable or enter an inline value. (Maximum: 100 characters)
  2. In the Import Correspondence Reference, consume a variable or enter an inline value. (Maximum: 100 characters)
  3. Optionally, consume a variable or enter an inline value in the Brand box. (Maximum: 250 characters)

    The Brand attribute is used by communication rules specified in the Output Management and is used in certain distribution scenarios for styling where an HTML file needs to be generated from a non-HTML source.

  4. Specify at least one recipient and the recipient type should be unique for each recipient. Do the following to configure the recipients:
    1. Consume a variable or enter an inline value in the Type box.

      Note The recipient type specified should match the recipient type defined in the CCM Rules engine.

    2. Click Configure.

      The Contact Items page appears.

    3. Enter the Name of the contact item.

      The name cannot be more than 50 characters, and must consist following characters: "0-9", "a-z", "A-Z", "_" (Latin alphanumeric underscore) and "-" (minus).

      Note The contact item name specified should match the name defined in the CCM Rules engine.
    4. Consume a variable or enter an inline value in the Value box.
    5. Click . The name-value pair appears in the table.
    6. Add more contact items as needed.
    7. Click OK.

      The Configuration page appears.

    8. In the Recipients group, click .

      The configured recipient type is displayed in the Type table.

    9. Configure more recipients as needed.
  5. Optionally, define the Sender details.
    1. Enter a Name.

      The sender name cannot be more than 50 characters, and must consist following characters "0-9", "a-z", "A-Z", "_" (Latin alphanumeric underscore) and "-" (minus).

    2. In the Value box, consume a variable or enter an inline value.
    3. Click . The name-value pair appears in the table.

      Note You can configure only one sender.

  6. Click Save.