Description:

The Get JSON Value workflow step retrieves values from JSON held in a FlowWright Variable or Global variable. The step can use a single JSON Path expression or a mapping containing multiple JSON Path expressions and corresponding returns.

The step supports:

• Reading JSON from a Variable or Global variable.
• Specifying a JSON Path expression.
• Mapping multiple JSON Path expressions and returns.
• Storing the resulting value in a Variable or Global variable.
• Processing JSON data received from other workflow activities.
• Using the retrieved value in subsequent workflow steps.
• Returning Match or noMatch for subsequent workflow processing.

Usage:

The Get JSON Value step is typically placed after a workflow activity has obtained, generated, or received JSON data.

The JSON is stored in a Variable or Global variable. The Get JSON Value step then uses the configured JSON Path expression or mapping to retrieve the required value and optionally stores the result in another Variable or Global variable.

A typical workflow pattern is:

Get/Build JSON → Get JSON Value → Use Result

For example:

Get JSON Response
       ↓
Get JSON Value
       ├── Match → Process Result
       └── noMatch → Handle No Match

• Populate Variables.
• Evaluate workflow conditions.
• Prepare notifications.
• Build messages.
• Populate form or business data.
• Prepare integration values.
• Perform additional JSON processing.
• Pass a retrieved value to another workflow activity.

The step is particularly useful when an integration or Web Service operation returns a larger JSON response but the workflow only needs one or more values from that response.

Typical Workflow Suggestions:

Extract a Value from a Web Service Response

Use the step after a Web Service or integration activity returns JSON.

Example:

Call Web Service → Get JSON Value → Process Result

For example, a service response might contain customer information, but the workflow may need only a specific value from the response.

The response is first stored in a Variable or Global, and the JSON Path expression identifies the required value.

Retrieve a Customer Value

Use the step to extract a specific customer-related value from JSON data.

Example:

Retrieve Customer Data → Get JSON Value → Update Customer Processing

A JSON response could contain several customer attributes. The workflow can use a JSON Path expression to retrieve the value the next activity needs.

Extract an Order Value

Use Get JSON Value to retrieve a value from JSON returned by an order-processing integration.

Example:

Submit Order → Receive JSON Response → Get JSON Value → Continue Order Processing

You can store the retrieved value in a Variable or Global variable and pass it to subsequent activities.

Retrieve an API Response Value

Use the step as an intermediate activity after an API call.

Example:

API Request → Store JSON Response → Get JSON Value → Evaluate Result

This pattern is useful when the API response contains more information than the workflow needs to process.

Prepare a Value for a Decision

Use the retrieved JSON value as an input to subsequent workflow decision logic.

Example:

Get JSON Response → Get JSON Value → Evaluate Retrieved Value

For example, the workflow can retrieve a value from the JSON response and use it in a later decision or conditional workflow activity.

Store a Retrieved Value for Reuse

Use the Store result in a Variable/Global property when multiple subsequent workflow activities need the retrieved JSON value.

Example:

Get JSON Data → Get JSON Value → Store Result → Multiple Subsequent Steps

The XML defines the result destination as a Variable/Global property, allowing you to assign the retrieved result to a workflow Variable or Global when configured.

Extract Multiple JSON Values

Use the Mapping property when you need to configure multiple JSON Path expressions and returns.

Example:

Retrieve JSON → Get JSON Value → Process Multiple Results

The Mapping property is specifically labeled “Map multiple JSON Path expressions and returns.”

A mapping-oriented workflow can be structured as:

Retrieve JSON
     ↓
Get JSON Value
     ↓
Process Retrieved Values

Prepare Data for an Email

Use the step to extract information from JSON before constructing an email message.

Example:

Retrieve JSON → Get JSON Value → Build Email → Send Email

You can store the extracted value in a Variable or Global and then use it in the email-processing activity.

Extract a Status from JSON

Use the step when a downstream workflow decision depends on a status value returned in JSON.

Example:

Call Service → Get JSON Value → Evaluate Status → Continue Appropriate Path

You can also incorporate the Match and noMatch paths into the workflow when the lookup result needs to control subsequent processing.

Extract Data Before Additional JSON Processing

Use the step as an intermediate JSON-processing activity.

Example:

Retrieve JSON → Get JSON Value → Additional Processing → Complete

This allows the workflow to isolate the required value before passing it to another activity.

Prepare Integration Data

Use this step to retrieve a value required by a subsequent integration operation.

Example:

Receive JSON → Get JSON Value → Prepare Integration → Execute Integration

You can store the retrieved value in a Variable or Global and supply it to the integration activity.

Process JSON from a Previous Workflow Activity

The JSON source does not have to originate directly from an external service. Any preceding activity that makes JSON available in a Variable or Global can provide the input.

Example:

Generate JSON → Get JSON Value → Process Result

The Variable/Global that holds the JSON property identifies the JSON source.

Route Processing When a Match Is Not Available

Use the two return paths to provide separate processing routes.

Example:

             ┌── Match → Process Value
             │
Get JSON Value
             │
             └── noMatch → Handle Alternative

The XML defines Match and noMatch as the step's two returns.

Example:

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

• Create a new definition called “JsonPathGetValueDef” and open the definition in designer mode. 
• Drag the “updateVariable” and “JsonPathGetValue” steps 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, Match, NoMatch, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Define a variable or a global to store the result. 
• Click the “updateVariable” step to configure its “Required” properties. Provide a name for the step, then click Save. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Select the “Advanced” tab. Select “Yes” for the “Has Expression” field. Click the button below to update multiple variables. Click the Add Row (+) button to insert an empty row. Enter the variable name and value. Use the add row buttons to insert multiple variables and values. 

• The JSON script used in this example is provided below. 

{"store": 
{"book": 
[{"category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95},
{"category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99},
{"category": "fiction", "author": "Herman Melville", "title": "Moby Dick", "isbn": "0-553-21311-3", "price": 8.99},
{"category": "fiction", "author": "J. R. R. Tolkien", "title": "The Lord of the Rings", "isbn": "0-395-19395-8", "price": 22.99}],          "bicycle": {"color": "red", "price": 19.95}},"expensive": 10
}

• Click the "JsonPathGetValue" step to configure its "Required" properties. Give the step a name and specify the variable or global reference to store the JSON result. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the "JsonPathGetValue" step to configure its "Optional" properties. Provide a JSON Path expression and a variable or global reference for the JSON result. Click the button to map multiple JSON Path expressions to variable or global references. You can retrieve JSON values using either a single path expression or multiple path expressions, but not both. Here, the $.Row[*].length path expression returns the total count of records in the SQL result set. Click the Save button. 

• You can refer to this website for more information about JSONPath expression syntax. 

https://jsonpath.com/ 

• 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 and click the Get JSON Value step to view its properties. When the workflow reaches the step, FlowWright processes the JSON contained in the configured Variable or Global using the configured JSON Path expression or mapping. If it produces a result, the workflow continues through the Match path; the noMatch path provides an alternative route. Verify that:
  • The correct Variable or Global contains the JSON.
  • The JSON Path expression corresponds to the intended JSON structure.
  • The Mapping is configured correctly when multiple expressions are required.
  • The result destination is configured when you need to reuse the result.
  • The expected Match/noMatch path is followed.
  • The resulting Variable or Global contains the expected value.

Tips:

• Make sure the Variable/Global that holds JSON contains the expected JSON before the step executes.
• The JSON source property is required, so configure it before you save or execute the step. 
• Use a meaningful Variable or Global name for the JSON source.
• Use a meaningful Variable or Global name for the result when you reuse the extracted value.
• Test the JSON Path expression against representative JSON before deploying the workflow.
• Verify the JSON structure whenever the upstream API or integration response changes.
• Use the Mapping property when the workflow needs to configure multiple JSON Path expressions and returns. 
• Keep mappings organized when retrieving multiple JSON values.
• Validate that the expected JSON property exists before relying on the extracted result.
• Consider connecting the noMatch return path to appropriate alternative or error handling.
• Verify the resulting Variable or Global before using it in downstream workflow activities.
• Keep JSON-processing logic close to the activity that produces the JSON when this makes the workflow easier to understand.
• Use logging to identify the JSON-processing stage without exposing sensitive JSON content.
• Test the workflow with representative responses, including responses where the expected value is not available.
• If the JSON structure changes, review the associated JSON Path expressions and mappings.
• Do not assume a particular JSON Path syntax, matching behavior, array handling, or expression feature set beyond what is supported by the FlowWright implementation.
• Do not assume that an optional JSON Path expression and the optional Mapping property are interchangeable in every situation. The XML defines both properties but does not document their precedence or exact runtime relationship. 
• Do not assume the precise runtime conditions represented by Match and noMatch solely from their names. The XML defines the return values but does not describe their internal conditions.

Notes:

• The Get JSON Value step is defined in the WebServices category with the internal name jsonpathgetvalue, label “Perform to get JSON Result value”, and display name “Get JSON Value.”
• The step is implemented by FlowWright.Workflow.JSONPathGetValue in FlowWright.Workflow.dll and is defined as a Process step with 2 incoming connections and 2 outgoing connections.
• The step defines four properties:
  • varGlobalHoldingJson – Variable/Global that holds JSON.
  • jsonPathExp – JSON Path expression.
  • Mapping – Map multiple JSON Path expressions and return.
  • varGlobalResult – Store result in Variable/Global. 
• Only varGlobalHoldingJson is marked as required in the XML. The other three properties are marked optional.
• The varGlobalHoldingJson, jsonPathExp, and varGlobalResult properties use the string data type, implemented by FlowWright.DataTypes.ClsTextBox.
• The Mapping property uses the MapJsonString data type, implemented by FlowWright.DataTypes.MapJsonString.
• The step provides two return values:
  • Match
  • noMatch

Definition Sample:

You may download the sample definition from the link provided and later import it 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:

• Variable or Global containing the JSON.
• JSON Path expression.
• JSON Path mappings, if applicable.
• Variable or Global used to store the result.
• Workflow Variable references.
• Environment-specific integration settings.
• Downstream Match and noMatch workflow paths.
• Logging configuration.

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

Click here to download the sample file.