Description:

The Get Item Detail Properties workflow step retrieves specified detail properties for an item identified by an item ID and item type.

The step lets the workflow designer specify the item, select its type, and map the detail properties to retrieve.

The step supports:

• Specifying an item ID.
• Selecting the item type.
• Selecting and mapping the detail properties to retrieve.
• Using the retrieved property values in subsequent workflow processing.
• Dynamically retrieving item information during workflow execution.
• Routing the workflow through True or False return paths.

Usage:

The Get Item Detail Properties step is typically used when a workflow needs to retrieve specific properties associated with an item during process execution.

The workflow provides the item ID, identifies the item type, and configures the detail properties to retrieve.

A typical workflow pattern is:

Identify Item → Get Item Detail Properties → Process Retrieved Properties

You can place the step before a decision, notification, data-processing, or other workflow activity that requires information from the selected item's detail properties.

For example:

Get Item Information → Get Item Detail Properties → Evaluate Result → Continue Process

The Detail properties to get input provide the mechanism for selecting or mapping the properties that the step should retrieve.

Typical Workflow Suggestions:

Retrieve Properties Before a Decision

Use the step when workflow processing depends on specific properties of an item.

Example:

Identify Item → Get Item Detail Properties → Evaluate Decision → Continue Process

The retrieved detail properties can be used by subsequent workflow logic.

Retrieve Item Information for Notifications

Use the step when a workflow needs selected item properties before preparing a notification.

Example:

Identify Item → Get Item Detail Properties → Prepare Notification → Send Notification

You can use the retrieved values to construct the notification content.

Retrieve Properties Before Data Processing

Use this step to obtain selected item details before passing the information to another processing activity.

Example:

Get Item ID → Get Item Detail Properties → Process Data → Complete

The workflow can retrieve only the detail properties required by the subsequent processing.

Retrieve Dynamic Item Details

Use this step when the item ID is determined during workflow execution rather than being fixed in the process definition.

Example:

Receive Request → Determine Item ID → Get Item Detail Properties → Continue Process

The Enter Item ID input can be populated from workflow data.

Retrieve Selected Properties for a Downstream Workflow Step

Use the step when a downstream activity requires specific properties from an item.

Example:

Identify Item → Get Item Detail Properties → Use Retrieved Properties → Subsequent Activity

Configure Detail properties to get the properties required by the downstream activity.

Example:

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

• Create a new definition named “clsGetDetailPropertiesDef” and open it in designer mode. 
• Drag a "clsGetDetailProperties" step to the canvas.
• Connect the dots between the “Start” and "clsGetDetailProperties" 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 result.
• Click the "clsGetDetailProperties" step to configure its "Required" properties. Provide a name for the step and the item's GUID. Select the item type (task, user, process definition, process instance, form definition, form instance). Then 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 configure the detailed properties you want to retrieve. A pop-up window opens for configuration. Click the Add Row (+) button to insert an empty row. Enter the column name (property name) from the deUserDetails table. Enter a variable or global reference to store the result after execution. Click the Save button. You can add multiple properties by using the Add Row button. 

• The “Logging” configuration is necessary for documentation and to measure workflow progress and percent complete. This is done by configuring 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. The process step should retrieve the item detail properties and store them in a variable or a global, as configured. 

Tips:

• Always provide a valid Item ID before executing the step.
• Select the appropriate Item Type for the item being queried.
• Configure Detail properties to get only the properties required by the workflow.
• Use workflow Variables when the item ID is determined dynamically.
• Verify that the selected property mappings correspond to the requirements of the downstream workflow activities.
• Use the True path for normal processing after successful retrieval.
• Use the False path for appropriate error handling or alternate processing.
• Test the property mapping with representative item data before deploying the workflow.
• Use meaningful Variable names when storing or referencing retrieved property values.
• Avoid configuring unnecessary properties when only a subset of item details is required.
• Test both return paths as part of workflow validation.
• Document the expected item type and property mappings when the step is used in complex workflows.

Definition Sample:

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

When configuring the step, verify:

• Item ID.
• Item type.
• Detail properties to get.
• Any workflow Variables used for the item ID or retrieved information.
• 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.