Welcome > Process Designer module > Activity types > Common activities > CCM Compose activity > Configure a CCM Compose activity

Configure a CCM Compose activity

  1. Add a CCM Compose activity to the map. See Add an activity.
  2. On the Extended Properties page of the CCM Compose activity, click the Configuration tab.
  3. Consume a Data Backbone variable.

    The data held in the data backbone variable is passed to CCM and is used to generate a document based on the selected template. The document is created in the format specified. The template version used is dependent on the setting for the CCM instance associated with the data backbone.

  4. Consume a variable or enter a static value (alphanumeric) for the Tracking ID.

    This value is reflected in the CCM logs on the CCM server if an error occurs. For example, you can enter the value of a JobID or a Case Ref to correlate between your job in TotalAgility and document production in CCM.

  5. On the Type list, select either option:

    • Document Pack Template: Displays the document templates within the document pack with details such as Template Name and Output Type.

      Note

      • The document pack templates belong to the projects associated with the data backbone.

      • The version of the template depends on the setting in the CCM server.

      • You cannot delete the document templates from the list.

      • If you change the selected document pack template, all document templates in the list get cleared.

    • Document Template (Default): Displays document templates that belong to the Customer Communication Manager (CCM) project associated with the data backbone.

  6. Select the Output Type as Word, PDF, Secure PDF, PDF-A or Secure PDF-A format. (Default: PDF).
    The document is created in the format specified.
  7. To store the pack (ZIP file) returned by CCM, in the TotalAgility database, click Yes to Store Pack. (Default: Yes)
  8. Consume a String variable to hold the Pack ID.

    This variable holds the ID of the pack created in CCM and is stored in TotalAgility. The pack ID option is only available if the Store Pack option is set to Yes.

  9. In the Distribution group, configure the control to perform distribution.
    Note Distribution is not supported for a cloud deployment of CCM.
    1. To allow distributing documents, click Yes for Distribute. (Default: No)

      The pack is sent to CCM server and CCM server performs the distribution.

    2. Select a Distribute Mechanism.

      • Archive: The CCM server sends the documents to archive storage configured within the CCM server.

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

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

  10. Configure the metadata.
    1. Enter a Key (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.
  11. Click Close.
    Note To remove a Pack (zip file) from the TotalAgility database, call the DeleteAsset API and pass in the Pack ID. This can be done at the end of the process.

    Alternatively, configure a retention policy to delete unnecessary packs after the retention period has passed. See Retention policies.