Description:

The Excel Output File step is an ETL destination component that writes processed datasets into a Microsoft Excel file.

As data moves through an ETL pipeline, it is often cleansed, validated, filtered, transformed, and enriched before being delivered to business users. The Excel Output File step provides a simple and efficient mechanism for exporting the final dataset into a spreadsheet format that is widely supported across enterprise environments.

The step is configured by specifying:

• The output Excel file location
• An optional workflow variable or global variable that stores the generated virtual file path

During execution, the ETL engine writes every incoming row into the Excel workbook while preserving the dataset structure produced by previous ETL transformations.

The optional Variable/Global to Hold Virtual Path property enables subsequent workflow steps to reference the generated Excel document without requiring the file location to be hard-coded. This is particularly useful when the spreadsheet will later be attached to emails, uploaded to a document repository, or referenced by other FlowWright workflow activities.

The Excel Output File step is typically the final component in an ETL pipeline.

The step supports:

• Microsoft Excel export
• Enterprise reporting
• Spreadsheet generation
• Business data distribution
• Virtual path storage
• Integration with FlowWright ETL pipelines

Typical business uses include:

• Sales reports
• Financial reports
• Inventory exports
• Customer data exports
• Audit reports
• Executive dashboards
• Business data distribution

Usage:

The Excel Output File step is typically placed as the final component in an ETL definition.

During execution:

1. The incoming dataset is received from upstream ETL components.
2. Each row is written into the Excel workbook.
3. The completed workbook is saved to the configured output location.
4. If configured, the workbook's virtual path is stored in the specified workflow variable or global variable.
5. ETL execution completes successfully.

A typical ETL pipeline might look like this:

Typical usage scenarios include:

• Exporting customer master data
• Producing monthly sales reports
• Creating financial summaries
• Generating inventory spreadsheets
• Delivering operational reports
• Producing compliance documentation
• Sharing processed datasets with business users

The generated workbook can then be distributed by email, uploaded into a document management system, archived, or opened directly in Microsoft Excel for additional analysis.

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 named “clsInputCSVDef” and open it in designer mode. 
• Drag the “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 variable 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 you 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 the Save button. 

• 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 "clsOutputExcel" step to configure its "Required" properties. Provide a name for the step and specify 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 for 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 “clsInputExcel” step facilitates transforming the input file. The variable or global holds the output file’s virtual path as shown below. 

Tips:

• Verify that the destination folder exists and that the FlowWright ETL service account has write permissions.
• Use meaningful workbook names that include reporting periods or business identifiers.
• Store the generated virtual path when later workflow steps need to email, archive, or upload the workbook.
• Validate the dataset before exporting to reduce downstream corrections.
• Export only the columns required by business users to improve readability.
• Maintain consistent spreadsheet layouts across recurring ETL processes.
• Combine this step with Validate Data, Transform Text Case, Transform Date by Format, Group By Transform, Sorting Transform, Filter with Conditions, Excel Input File, or SQL Input File to build complete enterprise reporting workflows.

Notes:

• The output path must be accessible to the FlowWright ETL server.
• The generated workbook reflects the structure of the incoming ETL dataset.
• The optional workflow variable or global variable stores the workbook's virtual path for downstream workflow activities.
• File permission issues or invalid output paths may prevent successful workbook creation.
• Because this is an ETL destination component, it has no outgoing connections.
• Workbook creation status and any execution errors are recorded in the ETL execution log.
• This step is commonly used for business reporting, executive dashboards, financial exports, operational reporting, customer data distribution, regulatory reporting, and enterprise analytics.

Excel Output File vs. CSV Output File:

Both components export ETL datasets, but they are designed for different reporting and integration scenarios.

As a general guideline:

• Use Excel Output File when producing reports intended for business users, management, or spreadsheet analysis.
• Use CSV Output File when creating lightweight files for system integrations or large-scale data exchange.

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 location
• Destination folder permissions
• Workflow variable or global variable (if required)
• Workbook naming conventions
• Environment-specific file paths
• Downstream workflow configuration

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

Click here to download the sample file.