› Workflow › Business processes › Design a basic process › Add an activity › Activity types › Kofax activities › KCM distribute activity › Configure a KCM distribute activity

Configure a KCM distribute activity

Use the following procedure to configure a KCM distribute activity.

  1. Add an activity to the map.

    By default, the Configuration tab is open in the properties panel of the activity.

  2. Change the default Name of the activity to something meaningful.
  3. On the Type list, select Kofax > KCM distribute.
  4. Select a KCM instance.

    Distribution is not supported for the cloud deployment of KCM, and an error appears if the instance is unsuitable.

  5. Select a process or server variable of type String for Pack ID. The Pack ID holds the ID of the pack that will be distributed.

    You must pass in the ID of a pack that is previously created in KCM and stored in TotalAgility.

    The pack generated for KCM does not contain the signed documents.

  6. Select a process or server variable, or enter a static value (alphanumeric) for Tracking ID.

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

  7. Select a Distribute mechanism for the generated pack from the list.

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

    • Email (Default): The KCM server distributes the documents through email.

    • Output management: The KCM server distributes each document pack based on the centralized rules that are configured in the KCM Rules engine. See Configure the Output management distribution mechanism.

      The Output management distribution 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) returned by KCM 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.

    • Portal: The KCM server posts the documents to a Web portal so that recipients can view them online.

      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 KCM server sends the documents to a printer so that they can be printed.

    • SignDoc: The KCM server sends the documents for eSigning.

      Configure the following SignDoc properties:

      1. Server: Select the SignDoc server.

      2. Package ID: Select a process or server variable (string), that will be updated to contain the package ID for the new package in SignDoc once the activity has become pending.

      3. Signed PDF: Select a document variable that will be updated to reference the final PDF containing all the signed documents.

      4. Package state: Select a process or server variable (string), that will be updated to contain the SignDoc package state when it is completed or canceled.

        At runtime, the activity completes only after the signing ceremony is completed. The signers are defined in the template and the data in the backbone determines the actual signers. See Configure a SignDoc activity.

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

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

  8. To configure the Organizational metadata, do the following:
    1. Click .
    2. Enter a Key name. (Free text)
    3. For Value, select a process or server variable or enter an inline value.
    4. Click Add.

      The key-value pair appears in the table.

    5. Add more key-value pairs as needed.

      The key-value pairs will be available to the distribution script in KCM.

  9. Save the process map.

    If you configure the KCM Distribute activity on the Integration Server, the activity executes using the KCM server that is configured on the Integration Server.

  10. Configure other properties for the activity. See Activity properties.