clsSetProperties Step
Description:
Set Item (Task, User, Process, Form) properties.
Inputs
- itemID- Enter item id
- itemType- Select item type
- propsToSet- Properties to set (Task, User, Process, Form)
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “clsSetPropertiesDef” example.
- Create a new process definition called “clsSetPropertiesDef”
- Select the definition and click the “design” button
- Drag a “getWorkflowUserID” step to the canvas
- Drag a “clsSetProperties” and “clsGetProperties” step to the canvas
- Connect the dots between the steps as show in the above graphic
- Click on the “getWorkflowUserID” step to configure its “Settings” properties. Provide a name for the step. Provide the user name to fetch. Provide the variable/global to hold the user ID after execution.
- Click on the “clsSetProperties” step to configure its “Settings” properties. Provide a name for the step. Select the item type (User, Task, Process, Form) from the dropdown list. Provide the variable/global reference which contains the approprite GUID reference value.
- Click on the “Properties to set” button. Provide the column name and the new value to hold. Click on “Save” to confirm the settings.
- Click on the “clsGetProperties” step to configure its “Settings” properties. Provide a name for the step. Select the item type (User, Task, Process, Form) from the dropdown list. Provide the variable/global reference which contains the approprite GUID reference value.
- Click on the “Properties to get” button. Provide the column name and the new variable/global reference to hold the value. Click on “Save” to confirm the settings.
- 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. The process completes without human intervention.
- Check the step properties by rendering the process instance. The clsSetProperties step should set Item (Task, User, Process, Form) properties as configured.