excel file writer

Excel File Writer

Icon
Use When	Data needs written to an Excel based file
Samples
Description	The Excel File Writer is used to write data to an Excel based file. The Excel File Writer can write to one output file either locally or to a remote destination. Excel files that are written can be in either Microsoft Excel (.xls) or Microsoft Excel XML (.xlsx) format. Note: The current version of the Excel File Writer only allows the writing of a single tab in a workbook and does not allow updates to a file, it will only replace the file if the file already exists.
Inbound Message Type	Entity Based Message
Output Message Type	Text Based Message
Control Message Handling	Input: If a unit of work boundary is received and no input data messages received and 'Empty File On No Input' is checked then create a blank file. Otherwise create a file with the entity messages received. Once a control message is received or a unit of work boundary is reached then complete the file write process and forward a status text message. Output: A single control message will be forwarded to downstream components once all messages have been processed through this step.

Properties

Name	Description
Resource	The file based resource (either local or remote) on which the file will be written.
Input 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
Excel Output Type	The type of Excel file to generate. (.xls or .xlsx)
Must Exist	Requires the file to exist prior to writing
Empty File On No Input	Output an empty file if no input messages occur
Path and File	The relative path and file of the file to be written. The relative path and file are concatenated with the absolute path specified in the File based resource. Note, the extension must match the output type selected or flow will error. Also, if no extension is provided the component will automatically add the proper extension based on the type.
Sheet Name	String to use as the Excel worksheet (tab) name. Must follow Excel guidelines for naming. If invalid characters are identified they will be replaced with spaces. Not providing will use the default of Sheet1.
Include Header Row	Whether to add a header row with attribute names as column headings in the output file.
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. If this setting is not selected, the path and file to be read is based on the File Path property.
Param Name For Msg Based File Name	Name of the parameter containing the file to be read.
Log Input
Log Output
Inbound Queue Capacity
Notes	General notes about this component.

Note	The output rows/columns will start in cell A1.