Chapter 3. Case files

A case instance is a single instance of a case definition and encapsulates the business context. All case instance data is stored in the case file, which is accessible to all process instances that might participate in the particular case instance. Each case instance and its case file are completely isolated from the other cases. Only case instance participants can access the case file.

A case file is used in case management as a repository of data for the entire case instance. It contains all roles, data objects, the data map, and any other data. The case can be closed and reopened at a later date with the same case file attached. A case instance can be closed at any time and does not require a specific resolution to be completed.

The case file can also include embedded documentation, references, PDF attachments, web links, and other options.

3.1. Configuring case ID prefixes

The caseId parameter is a string value that is the identifier of the case instance. You can configure the Case ID prefix in Red Hat Process Automation Manager designer to distinguish different types of cases.

The following procedures uses the IT_Orders sample project to demonstrate how to create unique case Id prefixes for specific business needs.

Prerequisites

  • The IT_Orders sample project is open in Business Central.

Procedure

  1. In Business Central, go to Menu → Design → Projects. If there are existing projects, you can access the samples by clicking the MySpace default space and selecting Try Samples from the Add Project pull-down menu. If there are no existing projects, click Try samples.
  2. Select IT_Orders and click Ok.
  3. In the Assets window, click the orderhardware business process to open the designer.
  4. Click on an empty space on the canvas and in the upper-right corner, click the Properties diagram properties icon.
  5. Scroll down and expand Case Management.
  6. Input the Case ID Prefix in the format ID-XXXXXXXXXX, where XXXXXXXXXX to create a generated number that provides a unique ID for the case instance. If a prefix is not provided, the default prefix is CASE with the following identifiers:

CASE-0000000001

CASE-0000000002

CASE-0000000003

You can specify any prefix. For example, if you specify the prefix IT, the following identifiers are generated:

IT-0000000001

IT-0000000002

IT-0000000003

Figure 3.1. Case ID Prefix field

case prefix

3.2. Configuring case ID expressions

The following procedures uses the IT_Orders sample project to demonstrate how set metadata attribute keys to customize expressions for generating the caseId.

Prerequisites

  • The IT_Orders sample project is open in Business Central.

Procedure

  1. In Business Central, go to Menu → Design → Projects. If there are existing projects, you can access the samples by clicking the MySpace default space and selecting Try Samples from the Add Project pull-down menu. If there are no existing projects, click Try samples.
  2. Select IT_Orders and click Ok.
  3. In the Assets window, click the orderhardware business process to open the designer.
  4. Click on an empty space on the canvas and in the upper-right corner, click the Properties diagram properties icon.
  5. Access the Metadata Attributes fields by expanding the Advanced menu.

  6. Specify one of the following functions for the customCaseIdPrefix metadata attribute:

    • LPAD - Left padding
    • RPAD - Right padding
    • TRUNCATE - Truncate
    • UPPER - Upper case

Figure 3.2. Setting the UPPER function for the customCaseIdPrefix metadata attribute

expressions

In this example, type is a variable set in the Case File Variables field, which during runtime a user may define to it the value type1. UPPER is a pre-built function to uppercase a variable and "`IT`-" is a static prefix. The results are dynamic case ids like: IT-TYPE1-0000000001, IT-TYPE1-0000000002, and IT-TYPE1-0000000003.

Figure 3.3. Case File Variables

case vars

If the customCaseIdPrefixIsSequence case metadata attribute is set to false (default value is true), the case instance will not create any sequence and the caseIdPrefix expression is the case Id. For example, if generating case IDs based on social security numbers, no specific sequence or instance identifiers are required.

The customCaseIdPrefixIsSequence metadata attribute is optionally added and set to false (default value is true) to disable the numeric sequences for the case IDs. This is useful if an expression used for custom case IDs already contains a case file variable to express unique business identifiers instead of the generic sequence values. For example, if generating case IDs based on social security numbers, no specific sequence or instance identifiers are required. For the example below, SOCIAL_SECURITY_NUMBER is also a variable declared as a case file variable.

Figure 3.4. customCaseIdPrefixIsSequence metadata attribute

prefix false

The IS_PREFIX_SEQUENCE case file variable is optionally added as a flag during runtime to disable or enable the sequence generation for case IDs. For example, there is no need to create a sequence suffix for medical insurance coverage for an individual. For a multi-family insurance policy, the company might set the IS_PREFIX_SEQUENCE case variable to true to aggregate a sequence number for each member of the family.

The result of using the customCaseIdPrefixIsSequence metadata attribute statically as false or using the IS_PREFIX_SEQUENCE case file variable and setting during runtime for it the value false, is the same.

Figure 3.5. IS_PREFIX_SEQUENCE case variable

prefix sequence