Description:

The Get Item Properties workflow step retrieves specified properties for a selected FlowWright item. The item is identified by its item ID and item type, and the Properties to Get Mapping configures the Properties to retrieve.

The step is specifically defined for retrieving properties from Task, User, Process, or Form items.

The step supports:

• Specifying the item ID.
• Selecting the item type.
• Selecting and mapping the properties to retrieve.
• Retrieving selected properties during workflow execution.
• Using retrieved item information in subsequent workflow activities.
• Routing the workflow through True or False return paths.

Usage:

The Get Item Properties step is typically used when a workflow needs to retrieve selected properties from an existing FlowWright item during process execution.

The workflow provides the item ID, identifies the item type, and specifies which properties to retrieve.

A typical workflow pattern is:

Identify Item → Get Item Properties → Process Retrieved Properties

For example:

Get Item ID → Get Item Properties → Evaluate Retrieved Information → Continue Process

The Properties to Get Configuration allows the workflow designer to specify the properties required for subsequent processing.

Because the step's label specifically identifies Task, User, Process, and Form items, it can be incorporated into workflows that need to retrieve properties from these FlowWright item types.

Typical Workflow Suggestions:

Retrieve Task Properties Before Processing

Use the step when a workflow needs selected properties from a Task before performing additional processing.

Example:

Identify Task → Get Item Properties → Evaluate Task Information → Continue Process

Select the appropriate item type and configure the required task properties.

Retrieve User Properties for Workflow Processing

Use this step when workflow processing requires selected properties associated with a User item.

Example:

Identify User → Get Item Properties → Process User Information → Continue Process

The item ID identifies the User item, while Properties to get specifies the required properties.

Retrieve Process Properties

Use the step when a workflow needs selected properties from a Process item during execution.

Example:

Identify Process → Get Item Properties → Evaluate Process Information → Continue Process

The workflow can retrieve the required Process properties before continuing with subsequent activities.

Retrieve Form Properties

Use the step when a workflow needs selected properties from a Form item.

Example:

Identify Form → Get Item Properties → Process Form Information → Continue Process

Configure the item type appropriately and specify the required properties through Properties to get.

Retrieve Item Properties Before a Decision

Use the step when retrieved Task, User, Process, or Form properties are needed as input to subsequent workflow logic.

Example:

Identify Item → Get Item Properties → Evaluate Decision → Branch Workflow

The retrieved properties can be used by subsequent workflow activities to determine the next processing path.

Example:

Let’s build and execute the “clsGetPropertiesDef” example.

• Create a new definition named “clsGetPropertiesDef” and open it in designer mode. 
• Drag the “getWorkflowUserID, clsSetProperties, clsGetProperties” step to the canvas.
• Connect the dots between the “Start” step and the “clsGetProperties” steps, as shown above.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Define a variable or a global to store the user ID.
• Click the "getWorkflowUserId" step to configure its "Required" properties. Provide a name for the step and the user name. Provide a variable or global reference to store the user ID. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the "clsSetProperties" step to configure its "Required" properties. Provide a name for the step. Provide a variable or global that contains the userID from the previous execution. Select the item type from the dropdown list. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the button to set the properties. A pop-up window appears for configuration. Click the Add Row (+) button to insert an empty row. Enter the property name and value. Click the Save button. You may insert multiple properties by using the Add Row button. 

• Click the "clsGetProperties" step to configure its "Required" properties. Provide a name for the step. Provide a variable or global that contains the userID from the previous execution. Select the item type from the dropdown list. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the button to set the properties. A pop-up window appears for configuration. Click the Add Row (+) button to insert an empty row. Enter the property name and value. Click the Save button. You may insert multiple properties by using the Add Row button. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Check the step properties by rendering the process instance. The process step clsGetProperties should return the configured Item properties (Task, User, Process Definition, Process Instance, Form Definition, Form Instance). 

Tips:

• Always provide a valid Item ID before executing the step.
• Select the appropriate item type for the item being queried.
• Configure Properties to get the properties required by the workflow.
• Use workflow Variables when the item ID is determined dynamically.
• Verify that the selected item type corresponds to the item ID being supplied.
• Keep property mappings aligned with the requirements of downstream workflow activities.
• Use the True path for normal processing after successful property retrieval.
• Use the False path for appropriate error handling or alternate processing.
• Test the property mapping with representative Task, User, Process, or Form items before deploying the workflow.
• Retrieve only the properties required for the intended workflow processing.
• Test both True and False workflow paths.
• Use meaningful workflow documentation when the step is part of a complex item-processing workflow.
• When the same workflow handles different item types, verify the item type and property mapping for each supported scenario.

Definition Sample:

You may create a FlowWright process definition that includes the Get Item Properties step and configure it to meet the workflow requirements.

When configuring the step, verify:

• Item ID.
• Item type.
• Properties to get.
• Workflow Variable references, when the item ID is determined dynamically.
• True workflow path.
• False workflow path.
• Environment-specific workflow configuration.

After verifying the configuration, save the process definition before executing a process instance.

Click here to download the sample file.