XML Output Format Parameters
The XML output format supports the following parameters:
| structure | ||
| Values: | 1 | 2 | 3 | 4 | |
| Default: | 1 | |
| Description: | Structure of the output document. | |
| Details: | For a description of the different structures available, see Document Structures. | |
| Example: | -structure:4 | |
| rootName | ||
| Values: | string | |
| Default: | ROOT | |
| Description: | Name of the document root node. | |
| Details: | This parameter allows users to customize the name of the single root node that contains all the other nodes in the output document. | |
| Example: | -rootName:REPORT | |
| rowName | ||
| Values: | string | |
| Default: | ROW | |
| Description: | Name of the node containing the output record fields. | |
| Details: | This parameter allows users to customize the name of the node that is generated for each output record. | |
| Example: | -rowName:ENTRY | |
| fieldName | ||
| Values: | string | |
| Default: | FIELD | |
| Description: | Name of the node containing the output record field values. | |
| Details: | This parameter allows users to customize the name of the node that is generated for each output record field when the "structure" parameter is set to "3" or "4". | |
| Example: | -fieldName:DATA | |
| xslLink | ||
| Values: | path to XSL document | |
| Default: | not specified | |
| Description: | XSL document to be referenced by the output XML document. | |
| Details: | Specifying a value for this parameter causes the XML output
format to place a link to the specified XSL stylesheet in the header of the output XML
document.
XSL-enabled XML browsers will follow the specified link and format the output XML
document accordingly. The link placed in the document header is formatted as follows: <?xml-stylesheet type="text/xsl" href="C:\XSL\MyXSL.xsl"?> |
|
| Example: | -xslLink:C:\XSL\MyXSL.xsl | |
| schemaType | ||
| Values: | 0 | 1 | |
| Default: | 1 | |
| Description: | Type of inline schema. | |
| Details: | When this parameter is set to "1", the output XML
document contains an inline DTD schema. Setting this parameter to "0" prevents the XML output format from generating an inline schema. |
|
| Example: | -schemaType:0 | |
| compact | ||
| Values: | ON | OFF | |
| Default: | OFF | |
| Description: | Suppress indentations and extra lines in output. | |
| Details: | When this parameter is set to "OFF", the XML
output format generates XML documents that are optimized for human readability,
indenting nodes according to their depth, and writing nodes on multiple lines. Setting this parameter to "ON" causes the XML output format to write each "ROW" node on a single line without indentation. |
|
| Example: | -compact:ON | |
| noEmptyField | ||
| Values: | ON | OFF | |
| Default: | OFF | |
| Description: | Avoid writing empty nodes for NULL field values. | |
| Details: | When this parameter is set to "OFF", output
record fields having NULL values are rendered as empty nodes. Setting this parameter to "ON" prevents the XML output format from generating a node when the corresponding output record field has a NULL value. |
|
| Example: | -noEmptyField:ON | |
| standAlone | ||
| Values: | ON | OFF | |
| Default: | ON | |
| Description: | Create a well-formed, stand-alone XML document. | |
| Details: | When this parameter is set to "ON", the XML output
format generates well-formed XML documents having an XML header and a single document
root node. When this parameter is set to "OFF", the XML output format generates XML text that only contains the output record nodes, with no XML header and no document root node. |
|
| Example: | -standAlone:OFF | |
| oCodepage | ||
| Values: | codepage ID (number) | |
| Default: | 0 | |
| Description: | Codepage of the output text. | |
| Details: | 0 is the system codepage, -1 is UNICODE. | |
| Example: | -oCodepage:1245 | |
| fileMode | ||
| Values: | 0 | 1 | 2 | |
| Default: | 1 | |
| Description: | Action to perform when an output file already exists. | |
| Details: | This parameter controls the behavior of the XML
output format when the into-entity specifies directly
or indirectly through the "multiplex" feature the name of a file that already
exists. The possible values for this parameter are:
|
|
| Example: | -fileMode:0 | |