1. XML Reference: Enterprise Application Integration Guide
  2. XML Hierarchy to XML Document Method Arguments

XML Hierarchy to XML Document Method Arguments

This topic describes the input and output arguments for the XML Hierarchy to XML Document method of the XML Hierarchy Converter.

Input Arguments

The following table describes the input arguments for the XML Hierarchy to XML Document method of the XML Hierarchy Converter.

Display Name Name Data Type Description

Escape Names

EscapeNames

String

Invalid characters in XML tags will be escaped, using Siebel CRM’s internal escape format.

  • If True, then Escape invalid characters (this is the default).

  • If False, then delete invalid characters. (Do not use in XML tags.)

XML Character Encoding

XMLCharEncoding

String

Outputs the XML character encoding to use. If encoding is blank or not supported, then an error is produced.

XML Header Text

XMLHeaderText

String

A string in a local code page character encoding to be inserted before the XML document’s root element, after the <?xml...?> declaration. This allows custom processing instructions or an XML header to be inserted before the XML document data starts.

For instance, if the header text is <myheader>data</myheader> and the XML document output without this parameter is <?xml version="1.0" encoding="UTF-8"?><account>..</account>, then the document with the XMLHeaderText included will be:

<?xml version="1.0" encoding="UTF-8"?><myheader>some data</myheader><account>.......</account>

XML Hierarchy

XMLHierarchy

Hierarchy

The XML hierarchy.

Ignore Character Set Conversion Errors

IgnoreCharSetConvErrors

String

Default is False. If the Siebel application cannot represent a given character set, such as the local code page character set, then conversion errors are logged, including a warning log entry. When set to True, only a warning message is logged.

Tags on Separate Lines

Tags on Separate Lines

String

Default is True, which means that a line feed is placed at the end of each tag. If False, then no line feed is added to the end of each tag; the XML message is generated in a single line.

Generate Processing Instructions

GenerateProcessingInstructions

String

Default is True. If set to False, then the Siebel processing instructions are not written.

Output Argument

The following table describes the output argument for the XML Hierarchy to XML Document method of the XML Hierarchy Converter.

Display Name Name Data Type Description

XML Document

<Value>

String

The output XML Document.