Get item propreties

Use this step to get item properties.

Last published at: July 13th, 2023

clsGetProperties Step

Description:

Get the properties of the Item (Task, User, Workflow Definition, Workflow 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” 
  • Select the definition and click the “design” button
  • Drag and connect 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. Give the step a name. Provide a variable or global that holds the userID from the previous execution. Select the 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 the "clsGetProperties" step to configure its "Settings" properties. Give the step a name. Provide a variable or global that holds the userID from the previous execution. Select the item type from the dropdown list. 

 

  • Click 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 measures the workflow progress and the percent complete. This is achieved 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. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-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.