Rerun and Review modes
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 KCM control uses a Data backbone property that outputs the data from the snapshot that was updated during the rerun. 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 created. Hence, there is a possibility of data loss, or data overwritten.
Use the following procedure to configure the KCM control in a rerun or review mode.
- In the properties panel of the KCM control, click the Configuration tab.
- For Mode of operation, select Rerun. (Default: Compose)
-
Under
Initialization, configure the following properties:
- KCM instance: The KCM instance to use.
- Pack ID: A global variable, form variable, or form control that holds the ID of the Pack (zip file) created in KCM (after Compose) and stored in TotalAgility. You can also pass an existing Pack ID.
-
Tracking ID (optional): A global variable, form variable, form field,
or an inline value such as JobID or Case Ref, to track the activity in the KCM logs.
You can only use alphanumeric characters for Tracking ID.
-
Under
Distribution, configure the control to perform distribution.
Distribution is not supported for a cloud deployment of KCM. If an unsuitable instance is consumed, an error appears.
-
To allow distributing documents, select
Distribute (default: Clear).
All documents in the pack are sent to the KCM server and the KCM server performs the distribution.
-
On the
Distribute mechanism list, select a mechanism to distribute documents.
-
Archive: The KCM server sends the documents to archive storage configured within the KCM server.
-
Email: The KCM server distributes the documents through email.
-
Portal: The KCM server posts the documents to a Web portal so that recipients can view them online.
An email with a URL 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.
TotalAgility does not support SignDoc for the KCM control.
-
KCM 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 metadata. This is a set of key-value pairs.
-
To allow distributing documents, select
Distribute (default: Clear).
-
To configure the metadata, do the following:
- Click .
- Enter a Key name (free text).
- In the Value field, select a variable (global or form) or form control or click and enter an inline value.
- Click Add. The key-value pair appears in the table.
- Save or release the form.
Review mode
In the Review mode, the control is displayed in read-only mode to allow reviewing of generated documents.
- In the properties panel of the KCM control, click the Configuration tab.
- For Mode of operation, select Review. (Default: Compose)
-
Under
Initialization, configure the following properties:
- KCM instance: The KCM instance to use.
- Pack ID: A global variable, form variable, or form control that holds the ID of the Pack (zip file) created in KCM and stored in TotalAgility. You can also pass an existing Pack ID.
-
Tracking ID (optional): A global variable, form variable, form
field, or an inline value such as JobID or Case Ref, to track the activity in the KCM logs.
-
You can only use alphanumeric characters for Tracking ID.
-
Distribution is not supported in Review mode.
-
- Save or release the form.