XML Reference: Siebel eBusiness Application Integration Volume V > Siebel XML Converters > XML Hierarchy Converter Business Service >

XML Hierarchy to XML Document Method Arguments


Table 25 describes the input arguments for the XML Hierarchy to XML Document method of the XML Hierarchy Converter.

Table 25.  XML Hierarchy to XML Document Method Input Arguments
Display Name
Name
Data Type
Description

Escape Names

EscapeNames

String

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

n If True, Escape invalid characters (this is the default).
n If False, 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, 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—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

When True, a line feed is placed at the end of each tag. The default is False.

n/a

GenerateProcessingInstructions

String

Default is True. If set to False the Siebel processing instructions are not written. You must manually create and name this input argument if it is required by your business needs.

Table 26 describes the output argument for the XML Hierarchy to XML Document method of the XML Hierarchy Converter.

Table 26.  XML Hierarchy to XML Document Method Output Argument
Display Name
Name
Data Type
Description

XML Document

<Value>

String

The output XML Document.

XML Reference: Siebel eBusiness Application Integration Volume V