Table of Contents

Search

  1. Preface
  2. Introduction
  3. Dashboard
  4. Resources
  5. Workflows
  6. Task Reference
  7. Services Overview
  8. Users
  9. Logs and Reports
  10. Encryption
  11. System
  12. Appendix
  13. Glossary Terms

Write Excel Task

Write Excel Task

The Write Excel task allows you to specify file and data parameters for translating a RowSet variable into an Excel file
Field
Definition
Basic Tab
Label
Specify a label for this task.
Input RowSet Variable
Specify the name of a variable of type RowSet which contains data to write to a file. For example, ${variableName}
Output File
Specify the path and file name of a single file to write.
When Output File Exists
Specify the action to take when the output file already exists. The default value is 'rename file' which changes the file name to a new name so the existing file remains untouched. Default Value: rename file
Excel Format
Specify which Excel format to use. If left blank, the document will be written in Excel 2003 (XLS) format.
Default Value: excel2003
Template File
Specify the path and file name of the template to use. The template file must be an Excel file. The new sheet will be created based of the first sheet from the template file.
Advanced Tab
Maximum Rows
Specify the maximum number of rows to be written to the output file. When this limit is reached, the remaining rows in the input RowSet will be silently skipped.
Sheet Name
Specify the name of the sheet to which the data should be written. If the specified sheet name does not exist, it will be created.
Default Value: Sheet 1
When Sheet Is Full
Specify the action to take when the spreadsheet becomes full.
Default Value: error
Include Column Headings
Specify whether or not to include column headings in the generated Excel file.
Default Value: false
Output Variables Tab
Output File Variable
If desired, specify the name of a variable which will contain the output file. The variable will be of type File and may be used in subsequent tasks that accept File or File List input variables. The variable will be created if it does not exist.
Control Tab
Version
The version of this task.
Log Level
Specify the level of logging to use while executing this task. Valid options are - silent, normal, verbose and debug.
Default Value: Inherited from parent Module
Execute Only If
Specify a condition that must be satisfied before this task can be executed. This task will be skipped if the specified condition is not met.
Disabled
Whether or not this task is disabled.
Default Value: false
On Error Tab
On Error
Specify the action to take when this task errors out. Valid options are - abort, continue, call:[module] and setVariable:[name]=[value]. For call:[module] replace [module] with the name of the module in the project (e.g. call:ErrorModule). For setVariable:[name]=[value] replace [name] with a variable name and [value] with the variable value (e.g. setVariable:error=true).
Default Value: Inherited from parent Module

0 COMMENTS

We’d like to hear from you!