The Configuration tab contains the following properties.

Case: The name of the Case.

Icon: The Icon that will be displayed for each Case instance. Clicking on the default icon will open the Icon Chooser dialog box to select the desired icon for the case.

Case Instance Name: The naming format for each case instance that is created. The Instance name can include System Variables, as shown in the example below:

Claim {CASE:Claim Number} for Policy #{CASE:Policy Number} Submitted on {CASE:Claim Date}

In this example, the instance name includes three of the Case property system variables to create a unique name for each instance.

Case Description: A brief description of the Case's purpose.

Audit property data changes: Checking this box will create an audit trail for each change to any of the case properties, enabling all changes to be tracked.

Create Case Instances for existing Form Instances: If you click this button, Process Director will find any form definitions that point to this case definition or properties in this case definition. It will create the appropriate case instances and add all the appropriate objects to the case instance. It will search through all form instances, the process associated with the form instance, and all those attachments. You can then select the Instance for which to create a new case.

The Properties tab contains the list of case properties that create the data context for the case. To add a property, simply click the Add Property button. When you do so, a property row will appear with the following columns to configure.

Case Properties Section

Name: The name of the property that will appear in the dropdown menus for field values and in the Choose System variable dialog box if a Friendly Name isn't assigned, and which will be used as the identifier for the property when typing a Case system variable.

Friendly Name: A value you can use, if needed, that will display in the user interface instead of the Name. This is a useful feature if the case property names are too technical or confusing. For users of Process Director v5.12 or higher, using a Camel Case value (e.g., MyProperty) for the Property's Name will automatically create a Friendly Name based on the Camel Case Name (e.g., My Property).

Description: A description of the property's purpose.

Data Type: The property's data type. The default data type is Text, and the following data types are available:

• Text
• Number
• Date
• Date/Time
• Yes/No
• User

Default Value: The value of the property that will be applied automatically when a new instance is created.

Encrypt: A check box that, when checked, will encrypt the value for storage in the database. This is useful for storing sensitive information.

Knowledge View Filters that use an encrypted Case property in the filter condition will NOT return the expected values! Knowledge View filters operate at the database level, and thus do not decrypt the property prior to filtering.

Unique: The value won't be repeated, and will be unique to the case instance, i.e., no two case instances will have this same value for the property.

Order and Delete Icons: The order in which the properties appear in the Case definition is the same order in which they'll appear in all System Variable dropdown menus. You can change the order by clicking on the up or down arrows for the property's row. Properties can be deleted by clicking the red "X" icon.

Dashboards Section

The Dashboards Section enables you to choose a Dashboard object to use to display the case folder. The dashboard should contain Knowledge Views, Charts, reports, or other objects related to the Case definition. When the dashboard is opened in the context of a Case, only results that are applicable to the selected case instance will be displayed in the Dashboard. For information about how to configure a Dashboard, please see the Dashboards topic.

To set a case property click the Add Row button to add a property row to the page. Each row consists of three columns to configure.

The Case Property column contains a dropdown from which you can choose the Case property whose value you wish to set.

The Set Case Property column contains an object picker that opens the Choose System Variable dialog box to enable you to choose the value you wish to use to set the property value. You can choose any available System Variable, or can manually configure a string or text value.

The Condition column contains a link to open the Condition Builder. You can configure any desired condition or condition set that, when evaluated as true, will set the Case property to the configured value. The condition is continuously evaluated, much like Start When conditions in a Process Timeline.

You can change the order of the rows by clicking on the up or down arrow buttons (), and you can delete rows by clicking on the red X icon button().

Create a Case definition