3.10 - Process Properties

Process Properties allow for dynamic configuration of global variables that can be referenced by many shapes and components can use  throughout the process and any subprocesses that are called during execution time.  Process Properties can represent data from a document field, the current system date/time, a static value, results of a database query, or a number of other values. 

Real World Usage

In the Great Plains application, a group of invoices that are processed together are part of the same batch.  The batch id is a unique identifier for that group of invoices.  If the batch id is not present within the inbound data, a process property can be used.  The process property can be set to the current date in the format of yyyyMMddHHmmss within a Set Properties shape.  This value will be the same for all of the invoices processed during one execution.  The process property can be retrieved within a Map Function and can be mapped to the Batch field within Great Plains. 

To use the Process Property:

1. Set the Process Property. This can be done within the Set Properties shape or within a Map Function.
2. Get the Process Property. This can be done within the Message, Exception, Program Command, Set Properties, Decision, Map Function, and Route.

Set the Process Property

Setting the Process Propety can be done within the Set Properties shape or within a Map Function.

Set Properties shape:

1. Select Process Property.
2. Type in the Name of the Property. This name must be used consistently when referencing this Process Property.
3. Click OK.
4. Highlight the new Process Property and click on the Add button ( ) to add and configure a new parameter.
5. Repeat step 4 as many times as required.
6. Click OK.

Map Function:

1. Use the Add button ( ) to add a new map function.
2. Select Properties as the function Category.
3. Select Set Process Property.
4. Click OK.
5. Type in the Name of the Property or leave blank if the name will be detrived dynamically from the inbound data. This name must be used consistently when referencing this Process Property.
6. Type in the Property Value or leave blank if the name will be detrived dynamically from the inbound data.
7. Click OK.
8. If the Name of the Property is derived dynamically from the inbound data, map the inbound data element to the Property Name parameter of the function.
9. If the Property Value is derived dynamically from the inbound data, map the inbound data element to the Property Value parameter of the function.

Get the Process Property

The Process Property can be retrieved after the Process Property has been set dynamically.  Process Properties can be retrieved within the Message, Exception, Program Command, Set Properties, Decision, Map Function, and Route.

Although the configuration options vary from shape to shape, they all share a few common concepts.

• Use the Add button ( ) to add a process property.
• Use the Edit button ( ) to modify the selected process property.
• Use the Delete button ( ) to remove the selected process property.