To manage Microsoft Excel® workbooks as part of a chain, add a step that includes a Microsoft Excel connection command.
Note: The Microsoft Excel connector supports macro-enabled Excel workbook (XLSM) files, but doesn't run any Virtual Basic for Applications (VBA) macros or event-based macros such as Workbook Open, BeforeSave, or SheetCalculate.
To enable these commands, an IT admin first creates a Microsoft Excel connector.
Create workbook from files
To create or update an Excel workbook with sheets based on data from delimiter-separated values files, use a Create Workbook from Files command.
Please note that you have two output options based on how your connector is configured:
- If using a GroundRunner, enter a Javascript Object Notation (JSON) object.
- If using a CloudRunner, specify their command outputs or resources within the chain.
Properties
| Property |
Detail |
| Files |
Specify the files to create as separate sheets in the workbook:
|
| Delimiter |
Select the delimiter used in the files. |
| Workbook name |
To create a new workbook based on the files, enter a unique name to help identify it.
Note: The command automatically creates appends an .xlsx extension if not provided.
|
| Existing workbook |
To add the files' data to an existing workbook rather than a new one, select the workbook file to update. Any sheet with a name entered in Files is overwritten.
Important: When using this command on a protected file, the resulting workbook will not be protected. This means you must manually re-add encryption when working with a protected file.
|
Outputs
| Output |
Output type |
| XLSX workbook |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Command succeeded |
| 1 |
Error |
General failure |
List sheets
To create a JSON list of all sheets in an Excel workbook, use a List Sheets command.
Properties
| Property |
Detail |
| Workbook file |
Enter the XLS or XLSX workbook to list the sheets of. |
| Password |
If Workbook file is a password-protected XLSX workbook, enter its password. |
Outputs
| Output |
Output type |
| Sheets JSON |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Command succeeded |
| 1 |
Error |
General failure |
Worksheet to CSV
To convert the data in the sheet of an Excel workbook to a tabular file, use a Worksheet to CSV command.
Note: The Worksheet to CSV command extracts the last calculated values in the worksheet; no formula calculations are run to update values. For worksheets with automatic calculations disabled, manually calculate and save the values before the chain runs to ensure accuracy.
Properties
| Property |
Detail |
| Workbook file |
Enter the XLS or XLSX workbook with the sheet to convert to a tabular file. |
| Password |
If Workbook file is a password-protected XLSX workbook, enter its password. |
| Delimiter |
Select the delimiter to use in the output file. |
| Sheet name |
Enter the name of the sheet in the workbook to convert. To instead identify the sheet by its index, leave blank. |
| Sheet index |
Enter the index position of the sheet in the workbook to convert, with 1 for the first sheet, and -1 for the last. To instead identify the sheet by its name, leave blank. |
| Start cell |
Enter the cell in both the first row and column of the sheet's data to convert. |
| End column |
In A1 notation, enter the letter of the column—such as A, B, or C, without the row number—where the data to convert ends.
Note: The command ignores any data in the sheet after this column.
|
| End row |
In A1 notation, enter the number of the row—such as 10, 200, 3000, without the column letter—where the data to convert ends. To ignore the row, enter 0.
Note: The command ignores any data in the column after this row.
|
| Use formatted cell values |
To convert the cells' display values instead of their raw values, such as for date/time handling, check this box. |
| Preview results |
To enable a preview of the output file, check this box. |
| Streaming Mode |
Only applicable for large XLSX files. Recommended for files over 20mb. Reads the file in smaller windows of data to reduce memory usage. Some formulas, especially those referencing cells further away in the file, may not work correctly when this setting is enabled in conjuction with formatted values option. |
Outputs
| Output |
Output type |
| Output CSV |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Command succeeded |
| 1 |
Error |
General failure |