Description:

The Get Dictionary Value workflow step retrieves the value associated with a specified key from a dictionary stored in a FlowWright Variable or Global.

The step identifies the dictionary to read, specifies the key to use, and stores the retrieved value in a specified Variable or Global.

The step supports:

• Retrieving a value from a dictionary.
• Reading dictionary entries by key.
• Storing the retrieved value in a Variable or Global.
• Using dictionary data in subsequent workflow activities.
• Separating dictionary storage from later value processing.
• Returning a True or False result.

This step can be used for:

• Reading previously stored workflow information.
• Retrieving customer or transaction data.
• Extracting calculated values from a dictionary.
• Using dictionary values in workflow decisions.
• Passing dictionary values to subsequent workflow steps.
• Reading status or processing information maintained in a dictionary.
• Supporting workflows that use dictionaries as collections of named values.

Usage:

The Get Dictionary Value step is typically used after one or more workflow activities have populated a dictionary with named values.

The workflow supplies:

• The Variable or Global containing the dictionary.
• The key whose value should be retrieved.
• The destination Variable or Global.

The retrieved value is then available to subsequent workflow activities.

Typical Workflow Suggestions:

Retrieve a Stored Status

Use the step to retrieve a status previously stored in a dictionary.

Example:

Set Dictionary Value → Get Dictionary Value → Decision

For example:

Dictionary: ProcessData
Key: Status
Value: Approved

Retrieve Customer Information

Use a dictionary to maintain customer-related information and retrieve individual values when needed.

Example:

Build Customer Dictionary → Get Dictionary Value → Process Customer

Potential keys include:

• CustomerID
• CustomerName
• CustomerType
• Status

A workflow can retrieve only the value required by a particular downstream activity.

Use a Dictionary Value in a Decision

Retrieve a dictionary value before branching the workflow.

Example:

Get Dictionary Value → Decision → Route Workflow

For example:

Get CustomerData["Status"] → CustomerStatus

followed by a decision:

CustomerStatus = "Approved"

This allows dictionary data to participate in workflow routing.

Retrieve Calculated Results

Use the step to extract a value previously calculated and stored in a dictionary.

Example:

Calculate Values → Set Dictionary Value → Get Dictionary Value → Continue

For example:

OrderData["TotalAmount"]

can be retrieved into a Variable for use by another workflow step.

Read External-System Results

If external-system processing results have been stored in a dictionary, retrieve individual results when required.

Example:

External Integration → Populate Dictionary → Get Dictionary Value → Process Result

Potential entries could include:

• ExternalStatus
• ReferenceNumber
• ResponseCode

Retrieve Multiple Values

Use multiple Get Dictionary Value steps when several dictionary entries need to be used independently.

Example:

Get Customer ID → Get Customer Name → Get Customer Status → Continue

Each step can retrieve a different key from the same dictionary and store the result in a separate Variable or Global.

Retrieve a Value Before an Approval

Use this step to retrieve the information an approval task needs.

Example:

Get Dictionary Value → Prepare Approval Data → Approval Task

For example, retrieve:

ApprovalAmount

into a workflow Variable before presenting the information to the approver.

Retrieve Values for Notifications

Extract a dictionary value before sending a notification.

Example:

Get Dictionary Value → Build Notification → Send Notification

For example, retrieve a customer name or processing status and use it in the notification workflow.

Read Values Stored Earlier in the Workflow

A dictionary can act as a shared collection of named workflow values.

Example:

Activity A → Set Dictionary Value → Activity B → Activity C → Get Dictionary Value

This allows Activity C to retrieve a value that was stored earlier in the workflow.

Use Set and Get Together

The most direct complementary pattern is:

Set Dictionary Value → Get Dictionary Value

For example:

Set

CustomerData["Status"] = "Approved"

Get

CustomerStatus = CustomerData["Status"]

This provides a straightforward dictionary write/read workflow pattern.

Retrieve a Dynamically Selected Key

The key can be supplied dynamically by workflow data.

Example:

Determine Key → Get Dictionary Value → Process Value

Because the key name is a string property, the key can be supplied from workflow data, where supported by the designer.

Success and Failure Handling

Use the two return paths to distinguish successful retrieval from unsuccessful execution.

Example:

Get 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 “getDictionaryValueDef” example.          

• Create a new process definition named “getDictionaryValueDef” and open it in designer mode. 
• Drag a "setDictionaryValue, and getDictionaryValue" step to the canvas.
• Connect the dots between the “Start” and 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 configuration options are available.
• Define a variable or a global to store the dictionary value.
• Click the "setDictionaryValue" step to configure its "Required" properties. Provide a name for the step. Provide a variable or a global reference 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 below. Configure the “Logging” using the following properties.

• Click the "getDictionaryValue" step to configure its "Required" properties. Provide a name for the step. Provide the variable or global reference that contains the dictionary value. Provide the key name to use. Provide a variable or global reference to store the value. Click the Save button. Note: Click the "AI Predict" button for the Copilot to 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 below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, execute it, and then render the process instance. When the workflow reaches the Get Dictionary Value step, FlowWright uses the configured dictionary and key to retrieve the corresponding value and stores it in the specified Variable or Global. The workflow then follows the True or False return path according to the execution result.

• Click the process step to view its properties. The step should retrieve the stored value from the dictionary and store the result in an output or global variable.

Tips:

• Make sure the dictionary Variable or Global is available before the step executes.
• Verify that the specified Variable or Global contains the intended dictionary.
• Use the exact key name required by the dictionary.
• Maintain consistent dictionary key naming throughout the workflow.
• Ensure the destination Variable or Global is appropriate for the retrieved value.
• Use meaningful destination Variable names such as CustomerStatus rather than generic names such as Value.
• Test the workflow with keys that exist in the dictionary.
• Test behavior when the requested key does not exist.
• Test behavior when the dictionary is empty or uninitialized.
• Test behavior when the dictionary Variable or Global reference is invalid.
• Use the True path to continue successful processing.
• Use the False path for appropriate error handling.
• When retrieving several values, use clear destination Variables for each value.
• Keep dictionary keys documented when multiple workflow activities depend on them.
• Use Get Dictionary Value after Set Dictionary Value when a workflow needs to explicitly write and subsequently read a dictionary entry.
• Verify that the destination Variable or Global is not unintentionally overwritten by another workflow activity.
• When using dynamic keys, test all expected key values.
• Test dictionary retrieval after importing a Process Definition into another environment.
• Use representative values when testing downstream decisions or calculations.
• If the retrieved value drives workflow routing, test all expected values and branches.
• Do not assume how missing keys, null values, or invalid dictionaries are handled unless that behavior has been verified in the target FlowWright version.

Notes:

• The Get Dictionary Value step is defined in the Engine category with the internal name getdictionaryvalue, label “Get a value from the dictionary”, and display name “Get Dictionary Value.”
• The step is implemented by FlowWright.Workflow.GetDictionaryValue 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 that holds the dictionary
  • dictionaryKey – Name of the key to use
  • variableToStore – Variable/Global to store the value 
• 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.
• Destination Variable or Global.
• Environment-specific Variable or Global references.
• Downstream True and False workflow paths.

Verify that the dictionary contains the expected key and that the destination Variable or Global is available to receive the retrieved value.

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

Click here to download the sample file.