The Excel(Output) component updates the specified ExcelBuilder defined content in the specified Excel file, and then outputs the data.
To use this component, it is necessary to define the Excel cells to which the input data is to be written and the format that this data will take. This can be done in the following steps:
1. open the ExcelBuilder
2. specify the Excel template file to read
3. specify work book cells on which this component is to operate
4. define the ASTERIA field's data type for each cell
| Input | Format | Record |
|---|---|---|
| Number of Inputs | 1 | |
| Description |
The record to write to the Excel file.
Writes the data to the area specified by the ExcelBuilder.
It is possible to define the access details using the Fields are defined in the ExcelBuilder, not ASTERIA Designer. If all the input records cannot be written to the specified area, an Exception is thrown. |
|
| Output | Format | Binary |
| Description |
The modified Excel file image data. |
| Name | Data Type/Selection | Mapping | Description | |
|---|---|---|---|---|
| Cell | category | Input Only |
Specifies the Excel cells, as defined by the ExcelBuilder, to which the input record data is to be written. When a flow is executed, these cells' values are written to the Excel file's respective cells. Fields are defined in the ExcelBuilder, not ASTERIA Designer. |
|
| FilePath | string | Yes |
Specifies the file location of the Excel file. If this file does not exist, an empty file is created and the appropriate cell data updated. The new file is then output.
If
When this property uses a relative path, the |
|
| HomeDirectory | choice | None |
Specifies the base directory used by the
|
|
| Mode | choice | Yes |
Specifies the way data is written to the ExcelBuilder specified cells and records.
|
|
| UpdateFile | boolean | Yes |
True updates the Excel file defined by the |
|
| AllowBlankRecord | boolean | Yes |
Specifies whether an empty record, which is defined as a record in which all its fields are empty, is allowed in the output record area or not. This property is used to effect how empty records are handled when the Mode property is set to Append, Insert, or Update. True allows empty records. Cells that have defined cell formatting such as fonts or line settings are not treated as empty. Furthermore, if doing cell formatting within the record area, the record will be determined to be 'full' and an Exception will occur. If doing cell formatting within the record area is necessary, specify this property as False. False prohibits an empty record. |
|
| OutputSheetName | string | Yes |
Specifies the name of the Excel sheet to which the ExcelBuilder defined cells and records are to be updated in the Excel file. If the defined work sheet does not exist, a new work sheet is created. This property can be defined in a preceding Mapper component. |
|
| OutputSheetCreateMode | choice | Yes |
If the
New creates a new, empty worksheet. |
|
| ConvertNull | choice | Yes |
The value to be written to a sheet's number cell if the value being written is NULL. |
|
This component cannot be the starting point for a loop.
| Commit |
Do Nothing |
|---|---|
| Rollback |
Do Nothing |
| Type | Parameters | Flow Input Stream | Error Code | Cause | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Exception |
|
This component's input stream. | none | Cannot write to the specified record area. This Exception is generated even if AllowBlankRecord is set to True, but the record area's formatting is different than specified.
|
||||||
| none | Cannot write to the FilePath. |
|||||||||
| none | If HomeDirectory=ExecuteUser but the execute user for this flow wasn't set at runtime. |
|||||||||
| none | Opening an Excel file of an unsupported format. Excel files formatted prior to Excel 97, such as Excel95 or older versions, must be saved as an Excel97 formatted file to be used by this component. |
This component can read Excel formatted files since Excel97. However, this component does not support the reading of Excel files formatted prior to Excel 97, such as Excel95 or older.
This component can write a file as large as 5MB. Only up to 8K of character data (4096 full length characters) per cell is processed.
The amount of data that can be input decreases as the number of cells increases. This occurs because the Excel format stores an additional 10 to 20 bytes of cell formatting data for each cell.
Category Maximum Cell Limit Number 300,000 cells Text 200,000 cells of 4 bytes (2 full length characters) 50,000 cells of 80 bytes (40 full length characters) 600 cells of 8K (4096 full length characters)