clsOutputExcel Step

Use this step to configure the output file for Excel transform result.

Last published at: August 13th, 2025

Description:

This step is used to configure the path of the output Excel 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 “clsInputCSVDef” example.          

  • Create a new ETL definition called “clsInputCSVDef” and open the definition in designer mode. 
  • Drag “clsInputExcel, clsTransformFormatNumberToString, and clsOutputExcel” 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. Provide the input Excel file path on the application server. Select the ETL data schema from the drop-down list. Note: The column names in the schema should match the columns in the input file. Click the Save button. Click here to learn about ETL Data Schema Designer.

 

  • Click the "clsInputExcel" step to view its "Optional" properties. Select the Show Schema button. The pop-up window renders 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. Click the Save button. 

 

  • Click the "clsTransformFormatNumberToString" step to configure the transform list. The pop-up window is displayed for configuration. Click the Add Row (+) button to insert an empty row. Select the “integer or value” as the input source column. Select the 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 "clsOutputExcel" step to configure its "Required" properties. Provide a name for the step. Provide the output Excel file path on the application server. Click the Save button. 

 

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

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the 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 “clsInputExcel” step facilitates the transformation of the input file.  The variable or global holds the output file virtual path as below. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import them (drag-and-drop) to 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 import. Then, save the definition to confirm the changes. 

Click here to download the sample file.