setDictionaryValue Step

Use this step to store a value to the dictionary.

Last published at: July 13th, 2023

Description:

Sets the value for a given dictionary key

Inputs

  • dictionaryKey – name of the key
  • dictionaryValue – value to store against the key
  • dictionaryVariable – name of the variable to store the dictionary 
 

 

Returns

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

 

Usage:

Example:

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

  • Create a new definition called “setDictionaryValueDef”
  • Select the definition and click the “design” button
  • Drag and connect the steps as shown in the image above
  • Define a variable/global to store the dictionary value and results after execution
  • Click on the "setDictionaryValue" step to configure its "Settings" properties. Provide a name to the step. Provide a variable/global to store the dictionary value. Provide the key name and key value. 
  • 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.
  • Click on the "getDictionaryValue" step to configure its "Settings" properties. Provide a name to the step.
  • 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. 
  • Render the process instance. Click on the process step. The “setDictionaryValue” step should set value to the dictionary.