Description:

This step extracts one or more values from a JSON document using a JSONPath expression.

The JSON Items to List workflow step reads a JSON document stored in a FlowWright Variable or Global Variable, evaluates a JSONPath expression against the document, and stores the matching values as a list.

The extracted values can optionally be separated using a configurable delimiter, making them suitable for iteration, reporting, notifications, API calls, or downstream workflow processing.

This step provides an efficient way to process JSON responses returned from REST APIs, web services, AI integrations, or custom applications.

The step supports:

• JSONPath expression evaluation
• Extraction of multiple values from JSON documents
• Reading JSON from FlowWright Variables or Global Variables
• Configurable list separators
• Storage of extracted values into FlowWright Variables or Global Variables

This step can be used for:

• Processing REST API responses
• Extracting values from web service payloads
• Preparing lists for workflow iterations
• AI response processing
• Data transformation
• Report generation
• Business process automation

Usage:

The JSON Items to List step is typically placed after a REST API call, AI request, or web service response has returned a JSON payload.

The workflow reads the JSON document, evaluates the specified JSONPath expression, and stores the matching values as a list for later processing.

A typical workflow might look like this:

Once the list has been created, later workflow steps can:

• Iterate through each item
• Generate reports
• Populate dropdown lists
• Build notifications
• Perform additional API requests
• Synchronize external systems
• Continue workflow processing

This step requires a valid JSON document to be available before execution.

Typically, the JSON document is produced by:

• REST Call
• Web Service call
• AI activity step
• Custom workflow step
• Variable assignment

Example:

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

• Create a new process definition named “JSONPathToListDef” and open it in designer mode. 
• Drag an “executeSQL and JSONPathToList” step to the canvas.
• Connect the dots between the “Start” and other steps, as shown above. 
• Define a variable or a global to store the JSON values and the List.
• Click the first "executeSQL" step to configure its "Required" properties. Provide a name for the step. Select the connection string from the list. Enter the SQL SELECT statement. Select the result format as XML or JSON. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Click the first "executeSQL" step to configure its "Optional" properties. If the database differs from the connection string configured in Integration - Connections, provide the database name. Provide a variable or a global to store the result. Select the result to return a single row or column (if necessary). Set the SQL command timeout value in seconds. Click the button to configure the SQL parameters and values. A pop-up window appears for configuration.

• Click the “JSONPathToList” step to configure its “Required” properties. Provide a name for the step. Provide the variable or global reference that holds the JSON value. Provide the JSON path expression. Provide a variable or a global reference to store the list. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Click the “JSONPathToList” step to configure its “Optional” properties. The default list separator is a pipe character ("|") unless otherwise specified. If the separator differs from the default, enter it. Then click the Save button. 

• The “Logging” configuration is necessary for documentation and to track workflow progress and completion percentage. 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 Process Instance and execute it. When the workflow reaches the JSON Items to List step, FlowWright reads the JSON document from the specified Variable or Global Variable and evaluates the configured JSONPath expression. If matching values are found, they are converted into a list and stored in the configured Variable or Global Variable. The workflow then follows the True return path. If the JSON document is invalid, the JSONPath expression is incorrect, or no processing can be completed, the workflow follows the False return path.
• Click the process step to view its properties. The step should successfully extract the requested values and return True upon completion. Verify that the configured output Variable or Global Variable contains the expected list of extracted values.

Tips:

• Verify that the input Variable or Global Variable contains valid JSON before executing this step.
• Test your JSONPath expression against sample JSON before deploying the workflow.
• Use a separator appropriate for downstream processing when generating delimited lists.
• Store the extracted list in a Variable or Global Variable that will be consumed by subsequent workflow steps.
• Use workflow variables to dynamically provide JSON content and JSONPath expressions when appropriate.
• Use the True and False return paths to implement appropriate success and error handling.
• Combine this step with REST Call, For Each, Update Variable Values, or Ask AI workflow steps to automate complex JSON processing workflows.

Notes:

• The input JSON must be valid JSON syntax.
• The JSONPath expression should conform to the supported JSONPath syntax used by FlowWright.
• Invalid JSON documents or malformed JSONPath expressions may cause the step to return False.
• If no matching values are found, the output list may be empty depending on the JSONPath expression and input data.
• The optional separator is used when formatting the extracted values into a list representation.
• Network connectivity is not required unless the JSON document is produced by a preceding external activity.
• The workflow should include appropriate error handling for the False return path.
• The extracted values are stored in the configured Variable or Global Variable for use by subsequent workflow steps.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) 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 Variable containing the JSON document
• JSONPath expression
• Output Variable or Global Variable mapping
• Optional list separator
• Workflow variable mappings
• Environment-specific settings

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

Click here to download the sample file.