tweakstreet-logo
  • Enter search terms

Excel Input

Read rows from an Excel file

Processing

For every input row, the step opens an Excel (*.xlsx) file and writes the rows from a given sheet into the row stream.

Settings

Name Type Description
Filesystem
 dict

The filesystem to use.

If the filesystem is nil, the local filesystem is used.

Evaluated for each input row
File
 string

The path of the Excel file to read.

Relative paths are interpreted as relative to the flow file.

Evaluated for each input row
Sheet
 string

The name of the sheet to read from.

Evaluated for each input row
Starting Cell
 string

The cell to start reading at, i.e. A1

Evaluated for each input row
Header Line
 boolean

If checked, the line at the starting cell is interpreted as containing field names. In this case read fields can use both field names and positional indexes in field mappings.

If not checked, the line at the starting cell is interpreted like a regular data line. In this case read fields can use only positional indexes in field mappings.

Evaluated for each input row
Timezone for Dates
 string

The timezone use for datetime values

Evaluated for each input row
Row Limit
 long

Limit data lines read from the file.

  • when nil, no limit is applied
  • when >=0, this number is the maximum number of data lines read from the file
  • any other value results in an error

Evaluated for each input row

Read fields

Defines how fields are extracted from source fields.

Evaluated for each input row

Type
Data type of the field. Field values are implicitly cast to this type.
Name
Name of the field.
Mapping
Index used to access the data in the source record.
  • Use an integer number n to access the n-th field.
    Fields are indexed starting at 0.
  • Use a string to access a source field by name.
    This is only possible if there is a header line containing field names.
Conversion
Optional function parsing the source field from string to its target type.
  • Use nil to leave the source data as it is. It will be cast to the target type.
  • Supply a function (string x) -> any, the source field value is passed in as x and the return value is used for the output field.

Results

Name Type Description
record
 dict current data row as a dict indexed by field name
values
 list current data row as a list of values
On this page