StateDMI / Command / NewExcelWorkbook

Overview
Command Editor
Command Syntax
Examples
Troubleshooting
See Also

Overview

The NewExcelWorkbook command creates a Microsoft Excel workbook file and optionally also creates worksheets in the new workbook. See also other Excel processing commands that can be used to further manipulate the Excel file.

StateDMI uses the Apache POI software to write the Excel file and consequently functionality is constrained by the features of that software package.

Command Editor

The following dialog is used to edit the command and illustrates the syntax of the command. See also the full-size image.

NewExcelWorkbook Command Editor

Command Syntax

The command syntax is as follows:

NewExcelWorkbook(Parameter="Value",...)

Command Parameters

Parameter	Description	Default
`OutputFile` required	The name of the Excel workbook file (`.xls` or `.xlsx`) to create, as an absolute path or relative to the command file location. Can specify using processor `${Property}`.	None – must be specified.
`Worksheets`	The name(s) of the worksheets to create in the workbook. Can specify using processor `${Property}`.	Don’t create any named sheets.
`KeepOpen`	Indicate whether to keep the Excel file open (True) or close after creating (`False`). Keeping the file open will increase performance because later commands will not need to reread the workbook. Make sure to close the file in the last Excel command.	`False`

Examples

See the automated tests.

Troubleshooting

See the main troubleshooting documentation