Configure a Customer Communication Control in Re-Run and Review modes

  1. On the Extended Properties page of the Customer Communication control, click the Advanced tab.
  2. For , select either of the following (default: Compose):
    • Compose: See Configure a Customer Communication control in Compose Mode.
    • Re-Run: Displays the control in a rerun mode. You can modify the previous selections and documents in the pack are updated on rerun.
    • Review: Displays the control in read-only mode to allow reviewing generated documents.

Re-Run Mode

Note In the rerun mode, a pack is passed to the control. The pack contains the document that was generated and a snapshot of the data (data backbone) used to create the document. The CCM Control uses a Data Backbone property that outputs the data from the snapshot that was updated during Re-Run. If needed, you can pass this data back into the business process to update the data backbone. But the data output from the control does not contain any updates to the data backbone in your process that were made since the documents were originally created. Hence, there is a possibility of losing data or overwriting.

  1. Consume a CCM Instance.
  2. Consume a String variable for Pack ID. An existing Pack ID must be passed into the control in rerun mode.
  3. Optionally, specify the Tracking ID to track the activity in the CCM logs. Consume a global variable, form variable or a form field, or provide an inline value such as JobID or Case Ref.
    Note You can only use Alpha Numeric character for Tracking ID.
  4. In the Distribution group, configure the control to perform distribution.
    1. To allow distributing documents, click Yes for Distribute (default: No).
      Note Distribution is not supported for a cloud deployment of CCM and an error will appear if an unsuitable instance is consumed.

      All documents in the pack are sent to CCM server and CCM server performs the distribution.

    2. Select a Distribute Mechanism from the list.
      • 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.

      Note TotalAgility does not support SignDoc for the Customer Communication control.

    CCM uses scripts to perform the distribution. The scripts are custom written and are shared across projects. The only way to pass data into the script is via the concept of Meta-Data. This is a set of key/value pairs.

  5. In the Meta-Data group, configure the metadata:
    1. Enter a Key name (free text).
    2. In the Value box, consume a variable or enter an inline value.
    3. Click Add. The key-value pair appears in the table.

Review Mode

  1. Consume a CCM Instance.
  2. Consume a String variable for Pack ID. An existing Pack ID must be passed into the control in review mode.
  3. Optionally, specify the Tracking ID to track the activity in the CCM logs. Consume a global variable, form variable or a form field, or provide an inline value such as JobID or Case Ref.
    Note the following:
    • You can only use Alpha Numeric character for Tracking ID.

    • Distribution is not supported in Review mode.