Skip to main content

Microsoft Excel Output

Description

Microsoft Excel Output is a step in the Output Plugin for Process Studio Workflows. Microsoft Excel Output step can write data to sheets in one or more Excel files. This step can write to a Microsoft Excel 2003 spreadsheet file (xls). If you want to write to an xlsx file (Excel 2007 and above), you may use the Microsoft Excel Writer step. The Split option allows you to write to multiple files. The following sections describe the features available for configuring the Excel output step.

Configurations

No.Field NameDescription
1Step nameThe name of this step in the workflow workspace.
2FilenameThe name of the spreadsheet file you are reading from.
3Create Parent folderIf checked, the parent folder will be created.
4Do not create file at startIf checked, does not create the file until the end of the step. This avoids creating empty files when no rows are in the data stream.
5ExtensionThe three-letter file extension to append to the file name.
6Include stepnr in filenameIf you run the step in multiple copies (launching several copies of a step), the copy number is included in the file name, before the extension. (_0).
7Include date in file nameIncludes the system date in the filename (_20101231).
8Include time in file nameIncludes the system time (24-hour format) in the filename (_235959).
9Specify Date time formatIf checked, the filename will include a date and time stamp that follows the selection you choose from the drop-down box. Selecting this option disables the previous two options.
10Date time formatProvide a specific date time format for the filename.
11Show file name(s)Displays a list of the files that will be generated. This is a simulation and depends on the number of rows that will go into each file.
12Add filenames to resultAdds the filenames to the internal filename result set. This internal result set can be used later on, e.g. to process all created files.
Content Tab:
1AppendWhen checked, appends lines to the end of the specified file. If the file does not exist, a new one will be created.
2HeaderEnable this option if you want a header to appear before the spreadsheet grid data.
3FooterEnable this option if you want a footer to appear after the spreadsheet grid data.
4EncodingSpecifies the text file encoding to use. Leave blank to use the default encoding on your system. To use Unicode, specify UTF- 8 or UTF-16. On first use, Process Studio searches your system for available encodings and populates this list accordingly.
5Split every ... rowsAfter this many rows, start a new spreadsheet file to continue data output.
6Sheet nameSpecifies the name of the worksheet within the spreadsheet file.
7Protect sheet?If checked, enables password protection on the worksheet. You must also specify a password in the Password field.
8Auto size columnsIf checked, automatically sizes the worksheet columns to the largest value.
9Retain NULL valuesIf checked, NULL values are preserved in the output. If un- checked, NULLs are replaced with empty strings.
10Use temporary fileSets whether a temporary file is used during the generation of the workbook. If not set, the workbook will take place entirely in memory. Setting this flag involves an assessment of the trade- offs between memory usage and performance.
11Temporary files directoryDefine the temporary files directory.
12Use TemplateIf checked, PROCESS STUDIO will use the specified Excel template to create the output file. The template must be specified in the Excel template field.
13Excel TemplateDefine the Excel template to use.
14Append to Excel TemplateAppends output to the specified Excel template.
Custom Tab:
1Header FontDefines the Header Font details
2Row FontDefines the Row Font details
Fields Tab:
1NameThe name of the field.
2TypeThe field's data type; String, Date or Number.
3FormatThe format mask (number type).