Configure a document set
See Document set.
- On the Home page, click .
-
On the Process Modeler, click
Document Set.
The Document Set page appears.
- To allow configuring document type rules or consuming any of the document set activities, click On for Document Set. (Default: Off)
- Enter a document type display Name.
- Consume a document type in the Document Type box.
- Enter a Description for document type to provide additional information within the document set control.
- Specify a date in the Date Required box by consuming a date variable or milestone.
-
Consume a process in the
Document Upload Process
box. 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.
-
To restrict the document type from display, click
Yes for
Restricted.
At runtime, if you view the document set in Customer mode, the restricted document type is not displayed.
-
Define a rule, either basic or advanced:
- To define a
basic rule and to specify whether the document is required, click
Basic. If the
Document Required is
set to
Yes, specify the
Number of Documents.
You can define only one rule per document type.
- To define an advanced rule, such as three documents of a particular type all dated within the last three months, click Advanced and consume a business rule in the Business Rule box.
-
You can use a business rule in multiple processes.
-
A business rule must have Job ID (string) as the input parameter, and Rule Success (boolean) and Error String (string) as output parameters.
- To define a
basic rule and to specify whether the document is required, click
Basic. If the
Document Required is
set to
Yes, specify the
Number of Documents.
-
Configure exceptions so that action can be taken when the
required documents are not received.
-
Consume a process in the
Document Due Process
box. This process is used when the required date on a document is passed and an
exception is raised.
Use the following input parameters: Job ID and Document Type Name.
-
Select either option for
Due Process Interval
to specify the interval after which the exception should be raised:
- Once (Default): Exception fires only once.
- Custom: Specify the interval in number of days and or hours. The exception is raised each time the interval passes until the document rule has passed.
-
Consume a process in the
Document Due Process
box. This process is used when the required date on a document is passed and an
exception is raised.
-
Click
Add
.
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.
-
Click
Save.
The process is saved.
- Click Close .