Excel Writer Step

The Excel Writer step is used to create an Excel document.

Praise Magidi avatar
Written by Praise Magidi
Updated over a week ago

Illustrated in the below image is a flow where the Record Generator is used to generate records. The Combine step is used to combine records into a single output. A Run File destination step to deliver an output file that can be downloaded.

The Record Generator source step is shown in the image below.

Adding an Excel Writer Step

To add an Excel Writer step in a flow, follow the below instructions:

1. Click on the highlighted icon as shown in the below image.

2. The below page will appear. Select or search for a Writer step to pull out the source data. Click on the Writer tab and select Excel as shown in the image below.

Configuring an Excel Writer Step

Illustrated in the below image is the configuration that is available in the Excel Writer step.

Worksheet Name – The name to call the worksheet output.

Worksheet Split Field – The field to spit the worksheet on.

AutoMap section:

To set fields to automatically map to the Excel sheet. Below are the available options:

  • Enable checkbox To enable automapping. The checkbox is checked by default when the Excel Writer step is added.

  • Nested Objects How fields in nested objects are handled. There are three options available:

  1. Ignore Does not map the field.

  2. Expand Create a column for each sub-field.

  3. JSON Creates a JSON string as the value for the field.

  • Nested Arrays How the nested arrays are handled. There are three options available:

  1. Ignore Does not map the field.

  2. Comma Create a column with the values as strings separated by a comma.

  3. JSON Creates a JSON string as the value for the field.

  • Use Name checkbox – To use the field name as a path. The checkbox is not checked by default when the Excel Writer step is added.

Strict checkbox – When selected, the source field must exist or else an error will be thrown out. The strict checkbox is only available if automapping is NOT enabled.

Header Style section:

The header style. The below are the available options:

  • Color field – The row font color as a helix string starting with the # character. The color #FF7F00 is typed in by default when the Excel Writer step is added.

  • Background Color field – The row background color as a helix string starting with the # character. The color #3A3838 is typed in by default when the Excel Writer step is added. No color will be set if the field is left blank.

  • Font Name field – The font name as defined in Excel. Arial font is typed in by default when the Excel Writer step is added.

  • Font Size field – The font size. Font size 10 is typed in by default when the Excel Writer step is added.

Row Style section:

The row style. The following are the available options:

  • Color field – The row font color as a helix string starting with the # character. The color #000000 is typed in by default when the Excel Writer step is added.

  • Background Color field – The row background color as a helix string starting with the # character. This field is blank by default when the Excel Writer step is added. No color will be set if the field is left blank.

  • Font Name field – The font name as defined in Excel. Arial font is typed in by default when the Excel Writer step is added.

  • Font Size field – The font size. Font size 10 is typed in by default when the Excel Writer step is added.

Formats section:

The different formats for the different field types.

  • Date field – Format for the date type fields. The dd-mm-yyyy format is typed in by default when the Excel Writer step is added.

  • Number field - Format for the number type fields. This field is blank by default when the Excel Writer step is added.

Field Mappings section:

Custom field mapping section that allows manually mapping fields to the Excel column. This section is only available if automapping is NOT enabled.

Click on the plus button as highlighted in the image below to map fields.

  • Name – Name of the field in Excel.

  • Path – Source path of the field.

  • Format – Excel format to use for the field.

  • Type – Type to convert and write to Excel. It is set to string by default. Click on the dropdown arrow to choose from the list.

  • Click on the tick or x buttons on the far right to save or remove the field mapping.

Using an Excel Writer Step

The Run File step is shown below. The File Type has been selected as Xlsx.

Viewing the created Excel file

1. Click the Execute Flow button shown in the image below:

2. Click the Create Run button.

3. Once the run has completed successfully, click on the processed run and then click the download button on the Run File step to download the output file as highlighted in the image below.

The image below shows the created Excel file.

Did this answer your question?