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

Read Excel Task

Read Excel Task

The Read Excel task allows you to specify file and variable parameters for translating an Excel file into a RowSet variable.
Field
Definition
Basic Tab
Label
Specify a label for this task.
Input File
Specify the path and file name of a single file to read the data from.
Input Files Variable
Specify the name of a variable of type File List which contains the files to read the data from. For example, ${variableName}.
Output RowSet Variable
Specify the name of a variable which will contain the data read from the specified input file(s). The variable will be of type RowSet and may be used in subsequent tasks that accept a RowSet input variable. The variable will be created if it does not exist.
Advanced Tab
Skip Invalid Records
Specify whether or not to ignore invalid records and continue on. The default is false, which will signal a error when invalid data is encountered.
Default Value: false
Skip Empty Rows
Specify whether or not to skip empty rows. If this value is set to true and a row is encountered that contains no data, that row will be silently skipped.
Data Start Row Number
Specify the row number where the data starts in the input file(s).
Default Value: 1
Headings Row Number
Specify the row number where the column headings are in the input file(s). This is needed only if column headings are present in the input file(s). The first row is 1, not 0.
Sheet Name(s)
Specify the names of the sheets to read from the specified input files. The sheet names must be separated by commas. If no sheet names are specified, the default action is to read all sheets from the input files.
Number of Columns to Read
Specify the number of columns to read from the excel spreadsheet. By default, the number of columns will be auto determined from the number of columns containing data in the data start row. This setting is helpful if the data start row has a different number of columns than needs to be read from the spreadsheet.
Output Variables Tab
Processed Input Files Variable
If desired, specify the name of a variable which will contain the processed input files. The variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. 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

Back to Top

0 COMMENTS

We’d like to hear from you!