Fast Excel: Writer
Description
Use the step to generate Excel-compatible spreadsheets in xlsx format and write the data to the generated file.
Limitation:
- If a file with the same name already exists in the location, the FastExcel: Writer step overwrites the existing file.
- The step creates a new file and sheet for each execution and doesn't write to an existing file or sheet.
- When configuring fields, enter the format manually for the field type Timestamp.
For example, yyyy-MM-dd HH:mm:ss, yyyy/MM/dd, yyyy-MM-dd'T'HH:mm:ss.SSSX, yyyyMMdd, and so on.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Specify the unique name for the single workflow. The field is mandatory. |
| File Tab | ||
| File | ||
| 1 | Filename | Specify the name and location of the Excel file to write the incoming row data. Recommendation: Exclude the file extension (for example, use MyReport instead of MyReport.xlsx). The step automatically adds the .xlsx extension. If you include an extension, dynamic parts such as the date or step number insert after it. For example, the file name excelWriterOutput2.xlsx becomes excelWriterOutput2.xlsx_20250801_184508_0.xlsx. OR Click Browse to browse and select the file location. Note: If a file with the same name exists at the target location, the plugin completely overwrites the file each time. The field is mandatory. |
| 2 | Include Stepnr in Filename? | Check Include Stepnr in Filename? to append a copy number to the file name (for example, _0) when you run the step in parallel copies, such as launching several copies of a step simultaneously. Note: • Use the feature to run the step in parallel copies. • The number appended to the file name (such as _0, _1, _2, etc.) indicates the step instance copy number—not the row number or execution count. In a typical workflow, only one copy of the step runs, which uses copy number 0. How to use: To generate multiple numbered Excel files: 1. Right-click the Fast Excel: Writer step in your workflow. 2. Select Number of copies to start... from the context menu. 3. Enter a number greater than 1 in the dialog box. For example, if you enter 3, the workflow starts three parallel instances of the step. 4. The step creates multiple files simultaneously with numbered names: FileName_0.xlsx, FileName_1.xlsx, FileName_2.xlsx |
| 3 | Include Date in Filename? | Check Include Date in Filename? to append the system date in the file name. Or Uncheck to keep the file name unchanged. The system date will not be appended. |
| 4 | Include Time in Filename? | Check Include Time in Filename? to append the system time to the file name, for example, _235959. Or Uncheck to keep the file name unchanged. The system time will not be appended. |
| 5 | Specify Date Time Format | Check Specify Date Time Format to append the system date and time to the file name and select a format from Date Time format field. Or Uncheck to not append system date and time and keep the file name unchanged. Note: On checked the Specify Date Time Format option, the system disables the fields Include Date in Filename? and Include Time in Filename? |
| 5.1 | Date Time format | Select the date and time format from the list to append to the filename. Available options are: • yyyyMMddHHmmss • yyyy-MM-dd • yyyymmdd • MM-DD-yyyy • MM-dd-yy • dd-MM-yyyy |
| 6 | Add Filename to Result | Check to add the downloaded file to the result set and display the download link on AE, else uncheck. By default the option is unchecked. |
| Sheet | ||
| 1 | Sheet Name (max. 31 characters) | Specify the name of the worksheet within the Excel file in which to write the incoming rows. Note: Sheet Name can have a maximum of 31 characters. |
| 2 | Make this the Active Sheet | On checked, the MS Excel file opens with the specified sheet in Sheet name field displayed by default. |
| 3 | Protect Sheet? | Check to protect the sheet with password. Note: On checked, the Password field will be enabled. |
| 3.1 | Password | Specify a password to protect the sheet. The protected sheet is not editable. Limitation: The Fast Excel: Reader step cannot read a protected sheet. When you try to use Get Fields on a protected sheet, the operation fails. |
| Content Tab | ||
| Content Options | ||
| 1 | Start Writing At Row Index | Specify the row index in the MS Excel spreadsheet to start writing. Row index starts from 0. Note: Field supports environment variables or static values. |
| 2 | Start Writing At Column Index | Specify the column index in the MS Excel spreadsheet to start writing. Column index starts from 0. Note: Field supports environment variables or static values. |
| 3 | Write Header | If checked, the first line contains the field names as header. |
| 4 | Write Footer | If checked the last line contains the field names as footer. |
| Fields | The Fields display the details of fields fetched from the previous step. | |
| 1 | Name | Displays the name of the field fetched from the previous step. Select/Specify the field name from the list. |
| 2 | Type | Displays or select the datatype of the selected field. The following are the available data types: • Number • BigNumber • Integer • String • Date • Timestamp • Internet Address • Boolean |
| 3 | Field Title | Specify the title for the field. Note: Field Title is a custom header override. If you specify, the step uses it as the column name in the excel file's header and footers. Otherwise, the field name is used. |
| 4 | Format | Select the Format for selected Type of the field. |
| 5 | Cell Comment | The XLSX format allows us to put comments on cells. Specify the cell comment to be added to the field. |
| 6 | Get Fields | Click Get Fields to fetch the fields and other field details from the previous step and the fields will populate to the Fields table. |
| 7 | Minimal Width | Click to resize the columns in the Fields table to their minimum width to fit the content. This helps make all the field mappings visible without needing to scroll horizontally. |