XML Reference: Siebel Enterprise Application Integration > Siebel XML Converters >

EAI XML Converter


The EAI XML Converter uses integration object definitions to determine the XML representation for data. It converts the data between an integration object hierarchy and an XML document. Figure 5 shows the translation of an XML document into an integration object property set in Siebel application and back again. The integration object property set of type Siebel Message will appear as a child of the Service Method Arguments property set.

Figure 5. XML Document to Integration Object

The following topics are also described here:

EAI XML Converter Parameters

You can control the location of where you want the temporary EAI XML Converter file generation to occur as well as the threshold by setting two server component parameters as described in Table 15. For more information about setting these and other server component parameters, see Siebel System Administration Guide.

Table 15. EAI XML Converter Parameters
Server Component Parameter Name
Server Component Type
Description

XMLTempFilePath

EAIXMLConvSubsys

Use this parameter to specify the location where you want the temporary XML conversion files generated when EAI XML Converter response size is greater then the size specified in the XMLTempFileSize parameter. By default, if the response size is greater than 50 kb, then generation occurs in the SIEBSRVR_ROOT\temp directory.

XMLTempFileSize

EAISubSys

Use this parameter to specify the threshold size for EAI XML Converter method responses. For more information about these methods, see Siebel XML Converter Business Service Comparison.

EAI XML Converter Business Service Methods

There are two methods for the EAI XML Converter: Integration Object Hierarchy to XML Document and XML Document to Integration Object Hierarchy, as described in Table 16. The arguments for each method appear in Table 17, Table 18, Table 19, and Table 20.

Table 16. EAI XML Converter Methods
Display Name
Name
Description

Integration Object Hierarchy to XML Document

IntObjHierToXMLDoc

Converts an integration object hierarchy into an XML document.

XML Document to Integration Object Hierarchy

XMLDocToIntObjHier

Converts an XML document into an integration object hierarchy.

Integration Object Hierarchy to XML Document Method Arguments

Table 17 describes the input arguments for the Integration Object Hierarchy to XML Document method of the EAI XML Converter.

Table 17. Integration Object Hierarchy to XML Document Method Input Arguments
Display Name
Name
Data Type
Description

Siebel Message

SiebelMessage

Hierarchy

The Integration Object Hierarchy to be converted to XML.

XML Character Encoding

XMLCharEncoding

String

The character encoding to use in the XML document. The default is UTF-16 for the Unicode version of Siebel Business Applications.

Use Siebel Message Envelope

UseSiebelMessageEnvelope

String

Inserts the Siebel Message Envelope into the XML document. The default is True.

Ignore Character Set Conversion Errors

IgnoreCharSetConv Errors

String

If some characters cannot be represented in the destination character set (like the local code page), then the errors can be ignored. The errors are not ignored by default. For both situations, a warning error entry is created.

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.

XML Header Text

XMLHeaderText

String

Text to prepend to the beginning of the XML document data.

Generate Namespace Declarations

GenerateNamespaceDecl

String

Default is False. If True, then the namespace declarations will be generated.

Generate Processing Instructions

GenerateProcessingInstructions

String

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

Generate Schema Types

GenerateSchemaTypes

String

Default is False. If set to True, then XSD schema types will be generated if set on the integration objects user properties.

Namespace

Namespace

String

If a namespace is defined here, then it will override any namespace defined in the user properties of an integration object.

Table 18 describes the output argument for the Integration Object Hierarchy to XML Document method of the EAI XML Converter.

Table 18. Integration Object Hierarchy to XML Document Method Output Argument
Display Name
Name
Data Type
Description

XML Document

<Value>

String

The resulting XML document.

XML Document to Integration Object Hierarchy Method Arguments

Table 19 describes the input arguments for the XML Document to Integration Object Hierarchy method of the EAI XML Converter.

Table 19. XML Document to Integration Object Hierarchy Method Input Arguments
Display Name
Name
Data Type
Description

XML Document

<Value>

String

The input XML document.

Integration Object Name

IntObjectName

String

Name of the Integration Object to use in cases where the Siebel Message envelope might not be present.

Integration Object Lookup Rule Set

IntObjectNameLookupRuleSet

String

Rule Set for the EAI Dispatcher Service for finding out Integration Object Name in cases where the Siebel Message envelope might not be present.

Validate External Entity

ValidateExternalEntity

String

If set to True, then the parser will be set to validate against external metadata, such as DTDs.

If set to True, then the DOCTYPE definition must be included in the incoming XML header, for example:

  <!DOCTYPE SiebelMessage SYSTEM
  "c:\temp\ListOfMyInbound.dtd">

External Entity Directory

ExternalEntityDirectory

String

The directory to use for finding external entities referenced in the XML document, such as DTDs.

Truncate Field Values

TruncateFieldValues

String

Default is False. If True, then truncate any fields longer than their maximum size, as specified in the Integration Component field definition.

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.

Contains Inline Attachments

ContainsInlineAttachments

String

This is True if the file attachment content was included in the original XML document. Otherwise it is False. From MIME (Multipurpose Internet Mail Extensions) Converter only.

Process Elements Only

ProcessElementsOnly

String

Default is False. If set to True, then processing of attributes is skipped.

Table 20 describes the output arguments for the XML Document to Integration Object Hierarchy method of the EAI XML Converter.

Table 20. XML Document to Integration Object Hierarchy Method Output Arguments
Display Name
Name
Data Type
Description

Siebel Message

SiebelMessage

Hierarchy

The Integration Object Hierarchy to be converted to XML.

XML Character Encoding

XMLCharEncoding

String

Character encoding of the XML document, detected by the converter independent of the parser.

XML Reference: Siebel Enterprise Application Integration Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.