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 XML Task

Write XML Task

The Write XML task allows you to specify file and data parameters for translating a RowSet variable into a XML file
Field
Definition
Basic Tab
Label
Specify a label for this task.
Output File
Required field. Specify the path and file name of the XML file to write.
When File Exists
Specify the action to take when the XML file already exists. The default value is 'rename' which changes the destination file name to a new name so the existing file remains untouched.
Default Value: rename
Advanced Tab
XML Header
Specify the XML Header information that will be written to the XML document before the root element. Header information contains lines such as the XML processing information, DTD, Schema definitions, stylesheet definitions, etc. The default header is <?xml version="1.0" encoding="UTF-8" ?>, but may be overwritten. In order to completely remove the header, specify the ${system.emptyString} variable as the header value.
Default Value: <?xml version="1.0" encoding="UTF-8" ?>
Tidy Output
Specify whether or not to use indentation so that the output is more legible.
Default Value: true
Trim
Specify how the leading and trailing white spaces in the fields should be trimmed. This setting may also be overridden by the individual element and attribute settings.
Default Value: none
Null Substitute
Specify the value that should be written to the output file when any field in any row of the input RowSet has a null value. The default value in an empty string. This value can be overridden by the individual columns.
Encoding
Specify the encoding to use when writing the output file. It is strongly recommended that this value be the same as the encoding specified in the XML header.
Default Value: UTF-8
Data Format Tab
Number Format
Specify the pattern to use for formatting the number fields (tinyint, smallint, int, bigint, real, float, double, decimal and numeric) in the output file. For e.g. ###,### (2,345) or $###,###.00 ($2,345.46). This value can be overridden by the individual elements and attributes.
Date Format
Specify the pattern for formatting the date fields in the output file. For e.g. MM/dd/yyyy (08/02/2007). This value can be overridden by the individual elements and attributes.
Default Value: yyyy-MM-dd
Time Format
Specify the pattern to use for formatting the time fields in the input files. For e.g. hh:mm:ss a (08:12:56 PM). This value can be overridden by the individual elements and attributes.
Default Value: HH:mm:ss
Timestamp Format
Specify the pattern to use for formatting the timestamp fields in the input files. For e.g. MMM dd, yyyy hh:mm:ss a (Aug 02, 2007 08:12:56 PM). This value can be overridden by the individual elements and attributes.
Default Value: yyyy-MM-dd HH:mm:ss.SSS
Locale
Specify the locale to which the locale sensitive data such as numeric and date/time data should be formatted. The locale must be of the form [language]_[country], where language is the two character ISO language code and country is the two character ISO country code. The country part may be omitted if the data was formatted to just the specified language. Example locales are - en_US (English/United States), de (German). If needed, the locale may be overridden on the individual elements and attributes.
Default Value: en_US
XML Validation Tab
Validation
Specify the type of validation to be performed. By default, validation is 'none' which means no validation is performed. Valid options are - none, schema, dtd
Default Value: none
Schema URL
Specify the URL path to the schema source. Use this attribute only if the schema source to validate against is not already defined in the XML document, or to override the schema. Leaving this value blank will validate the document against the schema defined in the XML document. This attribute is ignored if validation is not set to schema.
When Validation Fails
Specify the action to take when a validation error occurs. By default, all validation errors will be logged to the job log and the project will continue. Note that any fatal errors encountered by the parser means that the XML document is unreliable and the project will fail regardless of this setting. Valid options are - ignore, log, error
Default Value: error
Output Variables Tab
Output File Variable
If desired, specify the name of a variable which will contain the output XML 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!