GetProperties Step

Use this step to get item properties.

Last published at: August 16th, 2025

Description:

This step gets the properties of the Item (Task, User, Process Definition, Process Instance, Form Definition, Form Instance).

 

Inputs

  • itemID- Enter item id
  • itemType- Select item type
  • propsToGet- Properties to get
 

 

Returns

  • True – step executed successfully 
  • False – step failed to execute
 

 

 

Usage:

 

 

Example:

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

  • Create a new definition called “clsGetPropertiesDef” and open the definition in designer mode. 
  • Drag the “getWorkflowUserID, clsSetProperties, clsGetProperties” step to the canvas.
  • Connect the dots between the “Start” step and “clsGetProperties” steps, as shown above.
  • Define a variable or a global to store the userID.
  • 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 hold the user ID. Click the Save button. Note: Click the "AI Predict" button for the Copilot to 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 holds the userID from the previous execution. Select the item type from the dropdown list. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.  

 

  • Click the button to set the properties. A pop-up window is displayed for configuration. Click the Add Row (+) button to insert an empty row. Provide 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 holds the userID from the previous execution. Select the item type from the dropdown list. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

 

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

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved 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 then execute it. Check the step properties by rendering the process instance. The process step clsGetProperties should get Item properties (Task, User, Process Definition, Process Instance, Form Definition, Form Instance) as configured. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.

Click here to download the sample file.