# Excel Reader Extension

Starting from **ONEWEB version 4.0.19.11**, the platform supports **Custom Extensions** that can be used across both **Process Designer** and **Microflow Designer**.\
In addition to user‑defined extensions, ONEWEB also provides a set of **built‑in extensions**, one of which is the **Excel Reader**.

The **Excel Reader extension** enables Microflows and Process Flows to **read data from Microsoft Excel files** and process that data as part of backend logic or workflow execution.\
This capability is particularly useful for file‑based integrations and batch‑oriented data processing scenarios.

***

### Purpose of Excel Reader

The Excel Reader extension is designed to:

* Read structured data from Microsoft Excel files
* Support batch and file‑based data integration
* Enable Excel‑driven workflows and data imports
* Integrate legacy or external Excel data with backend systems

#### Typical Use Cases

* Importing master or reference data from Excel files
* Processing bulk records supplied via spreadsheets
* Reading Excel files from file systems or network‑based locations

Excel Reader helps bridge traditional Excel‑based data exchange with modern automated workflows.

***

### Installing the Excel Reader Extension

Before the Excel Reader can be used, the extension must be **installed and enabled** in the application.

To install the extension:

* Follow the steps described in **Section 6.4.16 – Custom Extensions**
* Install and enable the **Excel Reader** extension for the target application

Once installed:

* The Excel Reader appears in the **diagram palette**
* It can be used like any other standard activity node in Microflow or Process Designer

<figure><img src="/files/GmSndkf4g20nytqZLiUm" alt=""><figcaption></figcaption></figure>

***

### Configuring Excel Reader

After placing the Excel Reader node onto the canvas, users can configure how and from where the Excel file is read.

***

#### File Source Configuration

The Excel Reader supports reading Excel files from multiple sources:

* File System
* Network locations
* FTP
* SFTP
* FTPS

Users can:

* Specify file paths and connection details directly, or
* Retrieve file location details from a **Business Object**

This flexibility allows Excel Reader to integrate seamlessly with both **local** and **remote file‑based systems**.

<figure><img src="/files/BeRUmrvQoMdGmghDUsO3" alt=""><figcaption></figcaption></figure>

***

#### Reading Data from Multiple Sheets

The Excel Reader supports processing **multiple worksheets** within a single Excel file.

* Sheet names or identifiers can be provided as input
* Sheet‑specific configuration can be mapped using input Business Objects

This capability enables flexible handling of complex Excel files containing multiple datasets.

<figure><img src="/files/MLtwqS4Qtlzy5CdC5aqp" alt=""><figcaption></figcaption></figure>

***

#### Column‑Level and Row‑Level Reading

Excel Reader provides two primary data‑reading modes, configurable per worksheet:

* **Specific Field (Column‑level)**
  * Reads values from specified columns only
* **Records (Row‑level)**
  * Reads complete rows as records

These options provide fine‑grained control over how Excel data is extracted and processed within a flow.

<figure><img src="/files/DtqzEyNZOlrq9rEUtIAs" alt=""><figcaption></figcaption></figure>

***

### Best Practices

To ensure reliable and maintainable Excel‑based integrations:

* Use Excel Reader primarily for **batch or file‑driven scenarios**
* Validate Excel file format and structure before processing
* Use Business Objects to define clear input and output data contracts
* Avoid hard‑coding file paths; prefer environment variables where possible
* Combine Excel Reader with Database or Web Service tasks for downstream processing

***

### Summary

The **Excel Reader extension** is a built‑in Custom Extension that allows Microflows and Process Flows to **read and process Excel data**.

With Excel Reader, developers can:

* Read Excel files from local or remote sources
* Process multi‑sheet Excel documents
* Extract data at column‑level or row‑level
* Integrate Excel‑based data into backend workflows and integrations

Excel Reader is a key capability for building **file‑driven integration** and **data‑import workflows** within the ONEWEB platform, especially in enterprise environments where Excel remains a common data exchange format.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.onewebstack.com/designer-reference/microflow-designer/excel-reader-extension.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
