clsOutputJSON Step

Use this step to specify the path for the output JSON file.

Last published at: January 14th, 2026

Description:

This step is used to specify the path for the output JSON file.

 

Inputs

  • filePath – output file path
  • variableOrGlobal - variable/global to hold the virtual file path
 

 

Returns

  • None
 

 

 

Usage:

 

 

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 out-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 process definition, create a new instance, and then execute it. Render the process instance. Click the process step to view its properties. The “clsOutputJSON” step facilitates the transformation of the JSON output file. The variable or global holds the output file’s virtual path as shown below. 

 

 

Definition Sample:

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

Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after the import. Then, save the definition to confirm the changes. 

Click here to download the sample file.