excel file reader

Excel File Reader

Icon
Use When	Data needs read from an Excel file
Samples
Description	The Excel File Reader is used to read data from one or more Excel based files. The Excel File Reader can read one or more files and pass the data read to downstream components. The file name(s) and path(s) of the file(s) to be read can be specified in the File Path parameter below, or can be specified in the payload of the inbound message. Excel files that are read are parsed as defined within the component editor.
Inbound Message Type	Text Based Message
Output Message Type	Entity Based Message
Control Message Handling	Input: When a control message is received and 'Run When' is 'PER UNIT OF WORK' start the processing of this component or when any message other than a control is received and 'Run When' is 'PER MESSAGE'. Output: A single control message will be forwarded to downstream components once all files have been processed through this step unless the 'Send Control Message on EOF' property is checked (see below).

Properties

Name	Description
Resource	The file based resource (either local or remote) on which the file to be read resides.
Output Model
Error Suspense Step	Whether to forward failed messages and continue processing. This is the name of a linked component to forward the failed messages to.
Enabled
Run When
Get File Name From Message	If selected, the path and file name to be read will be determined by the payload of the incoming message. This option is used frequently with the File Poller component. If this setting is not selected, the path and file to be read is based on the File Path property below.
Must Exist	Whether the file to read must exist for the flow to execute.
Ignore on Formula Error	Whether to substitute null values for cells containing an error.
File Path	The relative path and file of the file to be read. The relative path and file are concatenated with the absolute path specified in the File based resource.
Rows Per Message	Records in the Excel file reader are defined by a row of data.
Action On Flow Success
Archive On Success Path
Action On Error
Archive On Error Path
Header Lines to Skip	The number of header lines in the file that should be skipped and not sent to downstream components
Send Control Message on EOF	Whether to send a control message at EOF to downstream components for each file read
Log Input
Log Output
Inbound Queue Capacity

Important

Specifying None on the Action on Error does NOT stop the flow from failing when a file cannot be read. It simply specifies what should be done with the file when the error condition does occur.

Component Editor

Double clicking on the Excel File Reader component in the flow will result in the Excel File Reader editor being displayed as shown below.

The editor displays a row for every entity and attribute of the output model, and allows setting the Sheet:Column of each.

The syntax is: Sheet Name:Column Letter

Sheet Name is the exact name as it appears on the tab to be imported.

Column Letter is the corresponding column the desired data exists in.