Configure a document set

  1. Navigate to Workflow > Business processes.
    The list of processes appears.
  2. Select the process for which you want to configure a document set.
    The process opens in a new browser tab.
  3. On the process Modeling bar, click Document set.
  4. Turn on the toggle for Define document set for this process. (Default: Off)
    Note Once you turn on the document set, you cannot turn off if the process contains a document set node configured.
  5. Click Add document.
    The Add document dialog box is displayed.
  6. Configure the following properties.

    Details

    Name

    A name for the document set.

    Description

    Optional. A description to provide additional information for the document set.

    Document type

    A document type to use for the document set.

    Document upload process

    A process on which a job is started at runtime when a document of the selected document type is uploaded. This process must have the following initialization variables of string type in the defined order: Job ID, Document ID and Resource ID. At runtime, when you upload a document or add a document to the document set, a job starts on the uploaded process map.

    Rule: Configure rules for a document set so that a process can only continue if certain criteria are met. A document set rule gives complete visibility to the status of the documents required to complete a process. You can halt the process if the required documents are not received. For example, halt the process at a stage until document 1 of type A and 2 of type B are received.

    Note You can define only one rule per document type.

    Type

    The type of rule:

    • Basic: If you require document, then keep the Document required selected and specify the Number of documents.

    • Advanced: To define an advanced rule, such as three documents of a particular type all dated within the last three months, on the Business rule list, select a business rule that must have Job ID (string) as the input parameter, and Rule Success (boolean) and Error String (string) as output parameters.

    Time Limit

    Date required

    A date by when the documents must be received. Select a date variable or milestone.

    Document due exception

    An exception to raise at the specified interval so that action can be taken when the required documents are not received by the specified date.

    Note Use Job ID and Document type name as input parameters.

    Exception recurrence: By default, an exception is raised only once. To raise the exception multiple times until the document rule has passed, select Every and specify the interval in number of days and or hours after which the exception should be raised again.

    Customer Mode

    Restricted

    If selected, restricts the document type. At runtime, if you view the document set in Customer mode, the restricted document type is not displayed.

  7. Click Add and save the process.
    Documents with defined rules are added to the document set. When you create a job based on a process that contains a document set and the due date on a document type has passed without the rule being met, the exception is fired and a job is created based on the process specified.