clsOutputJSON Step

Use this feature to write processed ETL data to a JSON file and optionally store the generated virtual file path in a FlowWright Variable or Global Variable for use by downstream workflow activities.

Last published at: July 22nd, 2026

Description:

The JSON Output File step is an ETL destination component that exports the processed dataset to a JSON file.

This step receives the transformed data from upstream ETL components, serializes the dataset to JSON, and writes the output to the specified file location. Optionally, it can store the generated virtual file path in a FlowWright Variable or Global Variable, allowing subsequent workflow steps to reference, distribute, archive, or publish the generated file.

The JSON Output File step is typically used as the final component in an ETL pipeline after all data extraction, transformation, validation, and enrichment operations have been completed.

The generated JSON file can be consumed by external applications, REST APIs, reporting tools, cloud services, document management systems, or additional FlowWright workflows.

The step supports:

  • Exporting ETL datasets to JSON format
  • Writing JSON files to a specified location
  • Optional storage of the generated virtual file path
  • Integration with ETL destination pipelines
  • Structured data export
  • Integration with downstream workflow automation

This step can be used for:

  • Data export
  • REST API integration
  • System integration
  • Cloud application synchronization
  • Data migration
  • Report generation
  • Enterprise ETL automation

 

Inputs

  • Enter Output File Path – Specify the full path where the generated JSON file will be written.
  • Enter Variable/Global to Hold Virtual Path – Specify a Variable or Global Variable that will receive the virtual path of the generated JSON file for use by downstream workflow steps.
 

 

Returns

  • The JSON Output File step does not define explicit return paths.

Note: Once the JSON file is successfully written, the ETL process completes or continues according to the configured ETL definition. Any execution or configuration errors are reported through the ETL execution log.

 

 

 

Usage:

The JSON Output File step is typically placed at the end of an ETL pipeline after all required transformations have been completed.

During execution, the component receives the processed dataset, converts it into JSON format, writes the output file to the specified location, and optionally stores the virtual file path in the configured Variable or Global Variable.

A typical ETL pipeline might look like this:

 

Once the JSON file has been generated, downstream workflow steps can:

  • Upload the file to a Document Management System (DMS)
  • Send the file as an email attachment
  • Publish the file to external systems
  • Archive the exported data
  • Transfer the file using FTP/SFTP
  • Invoke REST APIs that consume JSON files
  • Continue enterprise workflow automation

The output directory should exist and be accessible to the FlowWright server before the ETL process is executed.

 

Prerequisite:

The ETL process engine service should be running to execute the ETL definitions.

 

Example:

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

  • Create a new ETL definition named “clsOutputJSONDef” and open it in designer mode. 
  • Drag “clsInputExcel, clsTransformFormatNumberToString, and clsOutputJSON” steps to the canvas. 
  • Connect the dots between the “clsInputExcel” and other steps, as shown above.
  • Define a variable or a global to hold the virtual path.
  • Click the "clsInputExcel" step to configure its "Required" properties. Provide a name for the step. Specify the path to the input Excel file on the application server. Select the ETL data schema from the drop-down list. Note: The schema's column names should match those in the input file. Click the Save button. Click here to learn about the ETL Data Schema Designer.

 

  • Click the "clsInputExcel" step to view its "Optional" properties. Select the Show Schema button. The pop-up window displays the schema columns as shown below. This function helps to understand the schema at a glance.  

 

  • Click the "clsTransformFormatNumberToString" step to configure its "Required" properties. Provide a name for the step. Click the button to configure the transform list, then click Save. 

 

  • Click the "clsTransformFormatNumberToString" step to configure the transform list. The configuration pop-up window appears. Click the Add Row (+) button to insert an empty row. Select “integer or value” as the input source column and string as the output target column. Click the Save button. You may add multiple columns for transformation by using the Add Row button. 

 

  • Click the "clsOutputJSON" step to configure its "Required" properties. Enter a name for the step. Enter the path to the output JSON file on the application server. Click the Save button. 

 

  • Click the "clsOutputJSON" step to configure its "Optional" properties. Provide a name for the step. Provide a variable or global reference to store the virtual output path. Click the Save button. 

 

  • 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 ETL Definition. Execute the ETL process. During execution, the JSON Output File component receives the transformed dataset, serializes the records to JSON, writes the file to the specified output location, and optionally stores the virtual file path in the configured Variable or Global Variable. Subsequent workflow steps can use the generated file for integration, reporting, distribution, or archival purposes.

 

Tips:

  • Ensure the output directory exists before executing the ETL process.
  • Verify that the FlowWright server has write permissions to the destination folder.
  • Use descriptive file names that identify the exported dataset.
  • Store the virtual file path in a Global Variable if it will be referenced by multiple downstream workflow steps.
  • Validate the exported JSON file before distributing it to external systems.
  • Consider timestamp-based file names when generating recurring exports to avoid overwriting previous files.
  • Combine this destination component with JSON Input File, Filter Transform, Lookup Transform, Derived Column, Aggregate Transform, or SQL Input components to build complete ETL pipelines.

 

Notes:

  • This component functions as an ETL destination and typically appears as the final step in an ETL definition.
  • The output location must be accessible by the FlowWright server.
  • Existing files may be overwritten depending on the configured output path and ETL execution behavior.
  • The optional Variable or Global Variable stores the generated virtual path rather than the exported dataset itself.
  • File system permission issues, invalid paths, or write failures may prevent successful file generation.
  • This component exports the processed dataset and does not modify the source data.
  • Verify the exported JSON structure before using it in production integrations.
  • JSON Output File is commonly used for application integration, cloud synchronization, API data exchange, reporting, archival, and enterprise data migration.

 

Definition Sample:

You may download the sample ETL definition(s) from the link provided and later import them into your FlowWright ETL Designer.

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

  • Output file path
  • Variable or Global Variable mapping (if used)
  • Destination folder permissions
  • Upstream transformation mappings
  • ETL connection settings
  • Environment-specific configuration

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

Click here to download the sample file.