Description:

The Set Dictionary Value workflow step sets the value for a specified key in a dictionary stored in a FlowWright Variable or Global.

The step identifies the dictionary, specifies the key to set, and provides the value to associate with that key.

The step supports:

• Setting a value for a dictionary key.
• Updating an existing dictionary entry.
• Building dictionary data dynamically during workflow execution.
• Using workflow Variables or Globals for dictionary, key, and value information.
• Storing related key/value data in a single dictionary.
• Preparing dictionary data for subsequent workflow steps.
• Returning a True or False result.

This step can be used for:

• Building collections of workflow data.
• Maintaining named values throughout a workflow.
• Storing calculated results.
• Updating status or processing information.
• Preparing data for another dictionary-based workflow step.
• Dynamically adding or updating values based on workflow conditions.
• Passing related key/value information between workflow activities.

Usage:

The Set Dictionary Value step is typically used when a workflow needs to maintain a collection of named values in a dictionary.

The workflow supplies:

• The Variable or Global containing the dictionary.
• The dictionary key.
• The value associated with that key.

The operation can then be followed by another workflow activity that uses the updated dictionary.

Typical workflow pattern:

Collect Data → Set Dictionary Value → Continue Processing

For example, a workflow can progressively build a dictionary containing customer, request, processing, or status information.

The step can also be used with Get Dictionary Value to create a write/read pattern:

Set Dictionary Value → Get Dictionary Value → Process Retrieved Value

Typical Workflow Suggestions:

Build a Dictionary Dynamically

Use multiple Set Dictionary Value steps to progressively build a dictionary.

Example:

Get Customer → Set Name → Set Email → Set Status → Continue

For example:

CustomerData
    Name   = Ravi
    Email  = customer@example.com
    Status = Approved

Store Processing Status

Use the step to maintain workflow status information in a dictionary.

Example:

Process Request → Set Dictionary Value → Continue

Configuration:

• Dictionary: ProcessData
• Key: Status
• Value: Processed

This provides a named value that can be consumed later in the workflow.

Store Calculated Results

Set a dictionary entry after performing a calculation.

Example:

Calculate Total → Set Dictionary Value → Continue

Configuration:

• Dictionary: OrderData
• Key: TotalAmount
• Value: calculated total

This pattern is useful when several calculated values need to be maintained together.

Store External-System Results

Use the step after retrieving information from an external system.

Example:

Call External System → Process Response → Set Dictionary Value → Continue

For example:

• Key: ExternalStatus
• Value: returned status

The dictionary can then store external system information alongside other workflow data.

Maintain Customer Information

Use a dictionary to maintain related customer information.

Example:

Get Customer → Set Dictionary Values → Process Customer

Potential keys include:

• CustomerID
• CustomerName
• CustomerType
• Status

This provides a convenient named collection for subsequent workflow processing.

Store Values for Later Workflow Steps

Use Set Dictionary Value when a value is produced early in a workflow but will be consumed later.

Example:

Calculate Result → Set Dictionary Value → Other Processing → Get Dictionary Value

This separates the creation of the value from the point at which it is consumed.

Update an Existing Dictionary Entry

Use this step when a workflow needs to change a value associated with a known key.

Example:

Check Request → Set Dictionary Value → Continue

For example:

Status = Pending

can later be changed to:

Status = Approved

The exact overwrite behavior for an existing key should be verified in the target FlowWright implementation.

Build Data for Another Workflow Operation

Use Set Dictionary Value to prepare a collection of named values for subsequent processing.

Example:

Collect Inputs → Set Dictionary Value → Set Dictionary Value → Process Dictionary

This is particularly useful when downstream processing expects multiple related values to be maintained together.

Use Dynamic Keys

A workflow can provide the key dynamically rather than hard-coding it.

Example:

Determine Key → Determine Value → Set Dictionary Value → Continue

This can be useful when dictionary entries depend on workflow data.

Because the Name of the key property is a string field, workflow-generated values can be supplied to it.

Set Values Before a Dictionary Read

Use Set Dictionary Value before Get Dictionary Value when a workflow needs to write and subsequently read a value.

Example:

Set Dictionary Value → Get Dictionary Value → Evaluate Value

For example:

Set: CustomerData / Status / Approved

followed by:

Get: CustomerData / Status / CustomerStatus

Store Workflow Decision Results

Record the outcome of a decision in a dictionary.

Example:

Evaluate Request → Set Dictionary Value → Route Workflow

For example:

Decision = HighPriority

The stored value can then be retrieved or passed to later processing.

Success and Failure Handling

Use the two return paths to distinguish successful dictionary updates from unsuccessful executions.

Example:

Set Dictionary Value → True → Continue Processing

** ↳ False → Log Failure / Retry / Notify Administrator**

The XML explicitly provides True and False return values.

Example:

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

• Create a new process definition called “setDictionaryValueDef” and open the definition in designer mode.
• Drag the “setDictionaryValue, getDictionaryValue, and placeHolder” steps to the canvas.
• Connect the dots between the “Start” and the other steps, as shown above.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, additional values are available for configuration.
• Define a variable or a global to store the dictionary value and results.
• Click the "setDictionaryValue" step to configure its "Required" properties. Provide a name for the step. Provide a variable or a global to store the dictionary value. Provide the key name and key value. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and 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.

• Click the "getDictionaryValue" step to configure its "Required" properties. Provide a name for the step, then click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 instance, and execute it. Render the process instance. When the workflow reaches the Set Dictionary Value step, FlowWright uses the configured dictionary, key, and value to perform the dictionary update. The step is specifically defined as setting the value for a given dictionary key. The workflow then follows the True or False return path according to the operation result.

Tips:

• Create or identify the dictionary Variable or Global before executing the step.
• Verify that the configured Variable or Global contains the intended dictionary.
• Use meaningful key names that clearly describe the stored values.
• Keep key naming consistent throughout the workflow.
• Use workflow Variables or Globals to supply dynamic keys and values where appropriate.
• Test the workflow with representative dictionary data.
• Verify the resulting dictionary after the step executes.
• When building a dictionary with multiple steps, keep related entries logically grouped.
• Use descriptive dictionary names such as CustomerData, OrderData, or ProcessData.
• Avoid ambiguous key names such as Value1 or Data when more descriptive names are possible.
• Test what happens when the specified key already exists.
• Test behavior when the dictionary is empty.
• Test behavior when the dictionary Variable or Global is not initialized.
• Test empty or dynamically generated key and value inputs where applicable.
• Use the True path to continue successful processing.
• Use the False path for appropriate error handling.
• Consider logging the key being updated when troubleshooting dictionary-related workflows.
• Use Set Dictionary Value together with Get Dictionary Value when implementing explicit dictionary write/read operations.
• If multiple values are stored in the same dictionary, document the expected keys to maintain clarity.
• Keep dictionary key names stable when downstream workflow steps depend on them.
• Test dictionary updates after importing a Process Definition into another environment.
• Do not assume duplicate-key, null-value, or invalid-dictionary behavior unless it has been verified in the target FlowWright version.

Notes:

• The Set Dictionary Value step is defined in the Engine category with the internal name setdictionaryvalue, label “Sets the value for a given dictionary key”, and display name “Set Dictionary Value.”
• The step is implemented by FlowWright.Workflow.SetDictionaryValue in FlowWright.Workflow.dll and is a Process step with 2 incoming connections and 2 outgoing connections.
• The XML defines three configurable properties, all of which are required.
• The three properties are:
  • dictionaryVariable – Variable/Global to store the dictionary
  • dictionaryKey – Name of the key
  • dictionaryValue – Value of the item 
• All three properties use the string data type.
• The string property type is implemented by FlowWright.DataTypes.ClsTextBox in FlowWright.DataTypes.dll.
• The step provides two predefined return values: False and True.

Feature Comparison:

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Verify and complete any missing configuration after importing the sample, including:

• Dictionary Variable or Global.
• Dictionary key.
• Dictionary value.
• Environment-specific Variable or Global references.
• Downstream True and False workflow paths.

Verify that the target Variable or Global contains the intended dictionary and that the configured key and value are appropriate for the workflow.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.