clsGetProperties Step

Use this step to get item properties.

Last published at: January 2nd, 2024

Description:

Get Item (Task, User, Workflow Definition, Workflow Instance, Form Definition, Form Instance) properties.

 

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” 
  • Select the definition and click the “design” button
  • Drag and connect the the controls as shown above
  • Define a variable/global to store the UserID after execution
  • Click on the "getWorkflowUserId" step to configure its "Settings" properties. Provide a name to the step. Provide the user name of the user. Provide a variab/global to hold the userID after execution. 
  • Click on the "clsSetProperties" step to configure its "Settings" properties. Provide a name to the step. Provide a variable/global which holds the userID from previous execution. Select item type from the dropdown list. 
  • Click on the "clsSetProperties" step to configure its "Settings" properties. Click on the button to set the properties. 
  • Click on the "clsGetProperties" step to configure its "Settings" properties. Provide a name to the step. Provide a variable/global which holds the userID from previous execution. Select item type from the dropdown list. 
  • Click on the "clsGetProperties" step to configure its "Settings" properties. Click on the button to set the properties. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition, create a new process instance and execute. Check the step properties by rendering the process instance. The process step clsGetProperties should get Item properties (Task, User, Workflow Definition, Workflow Instance, Form Definition, Form Instance) as configured.