Description:

The Generate JSON workflow step generates JSON using the configured JSON node information and stores the resulting JSON in the specified Variable or Global variable. The step is defined in the Development category as a Process step with two incoming and two outgoing connections.

The step supports:

• Mapping JSON node information.
• Generating JSON from the configured node values.
• Using workflow data in the JSON-generation process.
• Storing the generated JSON in a Variable or Global variable.
• Reusing the generated JSON in subsequent workflow steps.
• Preparing structured JSON data for downstream workflow processing.
• Returning a True or False result for subsequent workflow processing.

Usage:

The Generate JSON step is typically placed after you collect, generate, or prepare data within a workflow.

The workflow provides the JSON node information and identifies the Variable or Global in which the generated JSON should be stored.

A typical workflow pattern is:

Prepare Data → Generate JSON → Use Generated JSON

The resulting JSON can then be used by later workflow steps to:

• Populate Variables.
• Prepare integration data.
• Build structured messages.
• Prepare API payloads.
• Create workflow output.
• Pass JSON to another activity.
• Perform additional JSON processing.
• Store the generated JSON for reuse.

Typical Workflow Suggestions:

Generate JSON from Workflow Data

Use the step when information collected during workflow execution needs to be represented as JSON.

Example:

Collect Data → Map JSON Nodes → Generate JSON → Continue Processing

Prepare JSON for an API Request

Generate JSON can be used to prepare structured data before a downstream API or integration activity.

Example:

Retrieve Data
      ↓
Map JSON Nodes
      ↓
Generate JSON
      ↓
REST/API Call

Generate Customer JSON

A customer-processing workflow can construct JSON containing customer-related information.

Example:

Get Customer Data
      ↓
Map JSON Node Information
      ↓
Generate JSON
      ↓
Store Customer JSON

{
  "Customer": {
    "CustomerID": "...",
    "Name": "...",
    "Email": "..."
  }
}

Generate Order JSON

You can use Generate JSON in an order-processing workflow after collecting order information.

Example:

Receive Order
      ↓
Collect Order Data
      ↓
Map JSON Nodes
      ↓
Generate JSON
      ↓
Process Order JSON

Build JSON from Variables and Globals

Use the step when the data required for the JSON is already available in workflow Variables or Globals.

Example:

Workflow Variables
       ↓
Map JSON Nodes
       ↓
Generate JSON
       ↓
Store Generated JSON

Prepare JSON for External Integration

Use Generate JSON as an intermediate step before an external integration.

Example:

Retrieve Business Data
        ↓
Generate JSON
        ↓
External Integration

Generate JSON for a Notification or Message

Where a downstream activity requires structured JSON message information, Generate JSON can be used to prepare the message data.

Example:

Process Request
      ↓
Generate JSON
      ↓
Send/Process Message

Generate JSON for Document or Metadata Processing

A document-related workflow can use Generate JSON to represent document information or metadata in a structured form.

Example:

Get Document Information
          ↓
Map JSON Nodes
          ↓
Generate JSON
          ↓
Document Processing

Create Structured Workflow Output

Use Generate JSON when a workflow needs to produce structured output.

Example:

Process Results
      ↓
Map JSON Nodes
      ↓
Generate JSON
      ↓
Store JSON

Generate JSON Conditionally

You can place Generate JSON on a particular branch when JSON output is required only under specific business conditions.

Example:

                 ┌─ Generate JSON
Decision ────────┤
                 └─ Other Processing

Reuse Generated JSON

The result is explicitly configured to be stored in a Variable or Global variable.

This allows the generated JSON to be reused by multiple subsequent workflow activities.

A typical pattern is:

Generate JSON
      ↓
Store Result
   ↙      ↘
Step A   Step B

Generate JSON Before Additional Processing

Generating JSON can act as an intermediate step before another JSON-processing activity.

Example:

Source Data → Generate JSON → JSON Processing → Final Output

Create Standardized JSON Structures

When several workflow instances need to generate the same general JSON structure, use consistent JSON node mapping.

Example:

Business Data
      ↓
Map Standard JSON Nodes
      ↓
Generate JSON
      ↓
Standard JSON Output

Example:

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

• Create a new process definition named “generateJSONDef” and open it in designer mode. 
• Drag a “generateJSON” step to the canvas.
• Connect the dots between the “Start” and “generateJSON” 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, you can configure additional values.
• Define a variable or a global to store the result after execution.
• Click the “generateJSON” step to configure its “Required” properties. Provide a name for the step. Click the button to enter node information. Specify a variable or a global reference to store the result. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Click the button to enter node information. Click the Add Row (+) button to insert an empty row. Enter the JSON node name and value. Click the Save button. You may add multiple JSON node values using the Add Row button. 

• The “Logging” configuration is necessary for documentation and to track workflow progress and completion percentage. Configure 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, and execute it. Render the process instance and click the Generate JSON step to view its properties. When the workflow reaches the Generate JSON step, FlowWright uses the configured JSON node information to generate the JSON and stores the resulting value in the specified Variable or Global variable. The generated Variable or Global can then be referenced by subsequent workflow activities.

Tips:

• Configure the JSON node information before executing the step.
• The jsonNodeData property is required. 
• Use meaningful JSON node names that clearly represent the data being generated.
• Use a meaningful Variable or Global name for the generated JSON, such as GeneratedJSON.
• Prepare and validate source values before mapping them into JSON nodes.
• Test the JSON generation with representative workflow data before deploying the workflow.
• Verify that the expected Variable or Global contains the generated JSON after execution.
• Use a consistent JSON structure when the same type of output is generated repeatedly.
• Keep JSON node mappings organized and maintainable.
• Test the workflow after changing the JSON node mapping.
• When preparing JSON for an external API, verify that the generated structure matches the receiving application's requirements.
• Keep JSON generation separate from downstream JSON consumption when designing larger workflows.
• Reuse the generated JSON Variable or Global rather than rebuilding the same JSON in multiple activities.
• Connect the True return path to the normal workflow continuation.
• Consider connecting the False return path to appropriate error handling.
• Test the workflow with missing, empty, and unexpected source values.
• Verify the generated JSON before passing it to a downstream integration.
• Keep standardized JSON structures consistent across workflows where the same integration contract is used.
• Avoid assuming behavior such as property ordering, null-value handling, escaping, or duplicate-node handling unless it has been confirmed in the FlowWright implementation.
• When the generated JSON will be exposed to external systems or users, avoid unnecessarily including sensitive information.
• Document the expected JSON structure when the generated value is consumed by another application or integration.

Definition Sample:

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

Before executing a workflow containing the Generate JSON step, verify:

1. The Generate JSON step has been added to the Process Definition.
2. JSON node information has been configured.
3. The JSON node mapping contains the values required by the workflow.
4. A Variable or Global has been defined to store the generated JSON.
5. The upstream workflow activity is connected to the Generate JSON step.
6. The True path is connected to the normal continuation path.
7. The False path is connected to appropriate alternate or error handling where required.
8. Logging has been configured if workflow progress needs to be documented.
9. The generated JSON has been tested using representative workflow data.
10. The output Variable or Global contains the expected JSON.
11. Downstream activities reference the correct output Variable or Global.

Click here to download the sample file.