This section explains each of the properties in the configuration blade.




This associates the Agent to a specific Collection (default to that of the current Data Stream).

Refer to Collections and Stream Hosts to understand more about Collections.

File Properties


Worksheet Name

The name of the Excel worksheet in the file that should be read. If left blank, the first worksheet in the file will be read.

Pivot Data?

Tick to read row as columns.

Get File From

The option of Excel data source in the stream that the Agent should be read.

  • Streaming - Get Excel file from Base64 binary string

  • File Path - Get Excel file from a file directory

Use File Definition

Tick to upload an example Excel file to read property names from and use to fill in the Record Definition table; or enter the properties manually.

Definition File

An example Excel file used to auto-populate the Record Definition's Field Names (applies if Use File Definition is ticked).

Record Definition (Field Name, Field Type)

Define the field names and types to expect in the Excel files.

Row Offset

The number of rows from the top that the record headers will be found. For example, if the headers are located on row 3, this should be set to 2.

Column Offset

The number of columns from the left that the records' first property column will be found. For example, if the first property to read is located on column D, this should be set to 3.

Row Limit

The number of row will be read from the Excel file.

Derived Column Settings

This Agent can extract additional data from the Excel file by translating the colors of the cells into meaningful values. A derived attribute is added to the output payload for every record definition field, which contains the transformed value of the cell's color.


Read Cell Colour Values

Tick to pull additional data from the colour of the cells in the Excel file.

Value Map

The mapping of color values to string output. For example, a yellow cell could translate to an output of "Warning".

Field Suffix

The suffix to append to the attribute names to create derived attribute names.

Before configuring the Function, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.

Input Mapping


FilePath (String)

The column or attribute of the input payload that contains the file path of the Excel file to be read. Applies to File Path only.

FileContent (String)

The column or attributes of the input payload that contains the base64 binary string of the Excel file to be read. Applies to Streaming only.

Refer to Setup Input Mappings for step-by-step instructions.




This endpoint is used to receive data from the parent agent: the file path to read.


Events received from the parent Agent are read and their FilePath input map read as the location of an Excel file on the device running the Stream Host. This file is read and its rows are made available to this endpoint with attributes defined in the Record Definition grid.


Errors encountered during the execution of this Agent will be published on this endpoint.

Last updated