Skip to main content

Get Excel Sheets

Description

Get Excel Sheets retrieves the names of all sheets in an Excel workbook and outputs them in a configurable format — as separate rows, a JSON array, or a comma-separated string. Use this step when your workflow needs to dynamically discover which sheets exist in a workbook before reading their data, which is especially helpful when processing files with variable or unknown sheet structures. The step can function as a standalone input or as an intermediate step that accepts filenames from a previous step.

Supported File Formats: The step reads and extracts data from the following file types:

  • XLS
  • XLSB
  • XLSX (Includes support for password-protected files)

Configurations

Field NameDescription
Step NameSpecify the name of the step. This name has to be unique in a single workflow.
Start NodeSelect the checkbox if you want to use the step as an input step.

Note:: If the step is used as an input step, then you cannot pass previous step values.

And, if the checkbox is clear then the step will work as an intermediate step and previous step fields can be passed to step.
Input Tab:Use the Input tab to specify the exact Excel file you want the workflow to process. This tab acts as the primary data source configuration for the step. In the tab configuration define the target Excel file, specify its format, and provide credentials for protected files.

This ensures the workflow step can successfully locate, decrypt, and read the target file.

Excel File TypeSelect the format of your target Excel file. Your selection determines how the step processes the file:

- Excel 2007 XLSX (Apache POI): Select this for .xlsx files. It reads data quickly, supports password protection, and handles medium-sized files well.

    Note: This option consumes more memory (RAM).

- Excel 97-2003 XLS (JXL): Select this for older .xls files. This is the default option for backward compatibility. It does not support .xlsx files.

- Excel Binary XLSB: The option reads .xlsb (Excel Binary) files efficiently and works well for very large datasets. It provides fast performance but reads all columns as strings. Use this option only for very large files and when string-only columns are acceptable.

Excel File PathSpecify the full file path of the target Excel file.

Or

Select Browse to locate it on your system. You can specify only one file path.

The data type is String and the field is mandatory.

Note: If the Start Node checkbox is selected, then you must specify the file path as an environment variable or a static value.

And, if the Start Node checkbox is clear then you can pass the value from the previous step.

Accept value as a variable/staticSelect the checkbox to specify the password as variable or static value.

Note: Accept value as a field is not visible if Start Node is selected.

File Password?Enter the password required to open the target file. The step uses this password to decrypt and read secured XLSX (Apache POI) files.

Note: This field is available only when you set the Excel File Type to Excel 2007 XLSX (Apache POI).

Output Tab:Use the Output tab to define how the step formats and stores the retrieved Excel sheet names. By configuring this tab, you structure the extracted data and assign it a specific field name, ensuring the information passes correctly to the subsequent steps in your workflow.
Output FormatSelect how the step structures the retrieved sheet names. Choose one of the following options based on what your downstream steps require:

- Separate Row: Outputs each sheet name on an individual row.

- Json Array: Outputs all sheet names formatted as a single JSON array.

    For example, [ "Accountant _Ledger", "Bank_Data" ]

- Comma Separated: Outputs all sheet names as a single text string separated by commas.

    For example, Accountant _Ledger, Bank_Data
Output field nameSpecify the name of the variable that stores the retrieved list of sheet names upon successful execution. Use the field name as the input field in the subsequent steps of your workflow.

Default value: sheetName