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. For Type, select either option:

    • Document Pack Template: Displays the document templates available within the document pack. For each template name, any import slots defined in the pack template are also displayed. A document pack template can have zero or more import slots, and these slots can be mandatory or optional. An asterisk adjacent to the name of the slot indicates that it is a mandatory slot. To configure the documents in the pack, do the following:

      1. On the Document Pack Template list, select a document pack template.

        The document templates within the document pack with details such as template name and output type, are displayed.

      2. For each template name, select the Output Type format as Word, PDF, Secure PDF, PDF-A or Secure PDF-A. (Default: PDF)

      3. To add additional documents to a document pack, map a document variable, or a string variable with a document path, or provide an inline path to a document which is to be imported. If you map a document variable, you can select a File Type for the document.

        When you distribute or review the pack, the imported documents are included in the pack.

        Note If you do not provide a document for an import slot that is mandatory, an error occurs.

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

      • 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 CCM project associated with the data backbone. To configure the document template, do the following:

      1. On the Document Template list, select a document template.

        The document template with details such as template name and output type are displayed.

      2. For the template name, select the Output Type format as Word, PDF, Secure PDF, PDF-A or Secure PDF-A. (Default: PDF)

  6. By default, the pack (ZIP file) returned by CCM is stored in the TotalAgility database.

    When you select the Output Management distribute mechanism, the Store Pack will automatically be set to No so the document pack will not be returned.

  7. Consume a String variable in 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.

  8. In the Distribution group, configure the activity to perform distribution.
    Note Distribution is not supported for a cloud deployment of CCM.
    1. To allow distribution of 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. (Default: Email)

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

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

  9. Configure the Organizational 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.
  10. Click Save.
    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.

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.