Siebel XML Converters

This chapter provides detailed information about the various Siebel XML converters. It includes the following topics:

About Siebel XML Converters

Siebel EAI includes four XML converter business services:

Note: XML converters might add unexpected carriage returns throughout the output document, for readability reasons. These characters are not significant and can be removed if the receiving application does not expect them and produces a parsing error. You can use eScript or Siebel VB to remove them.

Siebel XML Converter Business Service Comparison outlines the differences among these converters. Using these converters, Siebel EAI supports three types of standard XML integrations:

XML integration using Siebel XML. This integration uses XML that conforms to the XML Schema Definition (XSD), Document Type Definition (DTD), or schema generated from any Siebel integration object. Siebel XML is generated by the external application or by a third-party product. This type of integration uses the EAI XML Converter business service.
XML integration without using integration objects. For this integration, any necessary data mapping and data transformation must be handled using custom eScripts. This type of integration uses the XML Hierarchy Converter business service.
XML integration using XML integration objects. With this integration, XML integration objects are mapped to Siebel integration objects using Siebel Data Mapper and are based on external XSDs or DTDs. XML integration objects are used to map data between the external application and Siebel Business Applications. This type of integration uses the EAI XML Converter business service.

Note: These converters do not support Shift-JIS page code on UNIX platforms.

You can specify most parameters for the XML Converters as either business service method arguments or as user properties on the business service. If a business service method argument and a user property have the same name, the business service method argument always takes precedence over the user property.

Note: There are also two associated business services for XML that combine XML Converters with file reading and writing, which are useful for testing and debugging during the development phase. These are the EAI XML Read from File business service and the EAI XML Write to File business service.

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. The following 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.

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 the following table. For more information about setting these and other server component parameters, see Siebel System Administration Guide.

Table 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 50kb, 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 the following table. The arguments for each method appear in Integration Object Hierarchy to XML Document Method Arguments, Integration Object Hierarchy to XML Document Method Arguments, XML Document to Integration Object Hierarchy Method Arguments, and XML Document to Integration Object Hierarchy Method Arguments.

Table 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

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

Table 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.

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

Table 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

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

Table 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.

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

Table 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 Hierarchy Converter

The XML Hierarchy Converter does not use integration object metadata, but instead relies on simple rules for converting between an XML hierarchy and an XML document. The important distinction between this service and the XML Converter is a Property Set of type XMLHierarchy, which is always presented as a child of Service Method Arguments and as a parent of the XML document root element.

As shown in the following, every XML element becomes a property set where the XML tag name becomes the Type. For example, the XML element Contact becomes a property set of the type Contact in Siebel application. In addition, every XML attribute becomes a property within the element’s property set. For example, if the attribute of the XML element Contact is City = Toronto, then "City=Toronto" will be a property for Contact.

XMLHierarchyRepresentationofXMLDocumentStructure

The convenience of having this representation is that the XML Hierarchy Converter can convert to and from this representation in the same way, independent of whether or not the XML document includes a Siebel Message or an external XML document. This representation is also handled in Siebel Workflow because it allows all the XML documents in memory to be treated as the Hierarchical Service Parameter of type XMLHierarchy.

XML Hierarchy Representation in Siebel Business Applications

As illustrated in the image in XML Hierarchy Converter, there is a Property Set of type XMLHierarchy that always appears as a child of the Service Method Argument and the parent of the root XML element.
Elements are represented by Property Sets. The XML tag is the type in the property set and the value assigned to that XML tag is the Value in the property set. For example, if an XML element has a value such as <Contact City="Toronto">Davis, Pace</Contact> as shown in XML Hierarchy Converter, then the Value in the property set would be set to Davis, Pace and the Type in the property set would be set to contact.
Attributes are represented as properties on the Property Set that represent the attribute’s element.
Child elements are represented as child property sets and Parent elements as Parent property sets.
Processing instructions are represented as a child Property Set of type ProcessingInstructions, which is at the same level as the root element (the child of XML Hierarchy). In XML Hierarchy Converter, the root element is Account.

External entity resolution (XXE)has been disabled by default for security reasons and XML conversion will fail if the xml input has unknown External entities. To allow the external entities (XXE), user need to add the user property "DisableDefaultEntityResolution" with value "false" to the above business services.

When DisableDefaultEntityResolution = false external entities (XXE) will be ALLOWED.
When DisableDefaultEntityResolution = true external entities (XXE) will be NOT BE ALLOWED
When DisableDefaultEntityResolution user property is ABSENT external entities (XXE) will be NOT BE ALLOWED

The following topics are also described:

XML Hierarchy Converter Business Service Methods

There are two methods for the XML Hierarchy Converter, as shown in the following. The arguments for each method appear in XML Document to XML Hierarchy Method Arguments, XML Document to XML Hierarchy Method Arguments, XML Hierarchy to XML Document Method Arguments, and XML Hierarchy to XML Document Method Arguments.

Table XML Hierarchy Converter Methods

Display Name	Name	Description
XML Document to XML Hierarchy	XMLDocToXMLHier	Converts an XML document into an XML Hierarchy.
XML Hierarchy to XML Document	XMLHierToXMLDoc	Converts an XML Hierarchy into an XML document.

XML Document to XML Hierarchy Method Arguments

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

Table XML Document to XML Hierarchy Method Input Arguments

Display Name	Name	Data Type	Description
XML Document	<Value>	String	The input XML Document. If XML converter business services that expect XML Document (EAI XML Converter, XML Converter, XML Hierarchy Converter) are being used, then <Value> should contain a binary buffer rather than a text string. With workflows, use the Binary data type for the process property for XML Document.
Escape Names	EscapeNames	String	Invalid characters in XML tags will be escaped, using Siebel’s internal escape format. If True, then process Escape characters (this is the default). If False, then do not process Escape characters.
Validate External Entity	ValidateExternalEntity	String	If True, then the parser will be set to validate against external metadata, such as DTD schemas.
External Entity Directory	ExternalEntityDirectory	String	Location of external entity files, such as DTD files.
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.

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

Table XML Document to XML Hierarchy Method Output Arguments

Display Name	Name	Data Type	Description
XML Character Encoding	XMLCharEncoding	String	Character encoding of the XML document, detected by the converter, independent of the parser.
XML Hierarchy	XMLHierarchy	Hierarchy	The Output XML hierarchy.

XML Hierarchy to XML Document Method Arguments

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

Table 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. 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.

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

Table XML Hierarchy to XML Document Method Output Argument

Display Name	Name	Data Type	Description
XML Document	<Value>	String	The output XML Document.

EAI Integration Object to XML Hierarchy Converter

The EAI Integration Object to XML Hierarchy Converter can be used if additional types of XML processing are needed, such as adding new elements, attributes, or envelopes to in-memory integration object property sets. XML Hierarchy property sets can be manipulated using eScript and Siebel VB.

The following topics are also described here:

EAI Integration Object to XML Hierarchy Converter Business Service Methods

There are two methods for the EAI Integration Object to XML Hierarchy Converter, as shown in the following. The arguments for each method appear in Integration Object Hierarchy to XML Hierarchy Method Arguments, Integration Object Hierarchy to XML Hierarchy Method Arguments, XML Hierarchy to Integration Object Hierarchy Method Arguments, and XML Hierarchy to Integration Object Hierarchy Method Arguments.

Note: You can use the XML Hierarchy property sets to manipulate in memory XML hierarchies, such as to add new elements, attributes, or envelopes. An XML Hierarchy property set can be converted to and from an Integration Object property set using EAI Integration Object to XML Hierarchy Converter. An XML Hierarchy property set can be converted to and from an XML document using the XML Hierarchy Converter.

Table EAI Integration Object to XML Hierarchy Converter Methods

Display Name	Name	Description
Integration Object Hierarchy to XML Hierarchy	IntObjHierToXMLHier	Converts an integration object hierarchy to an XML hierarchy.
XML Hierarchy to Integration Object Hierarchy	XMLHierToIntObjHier	Converts an XML hierarchy to an integration object.

Integration Object Hierarchy to XML Hierarchy Method Arguments

The following table describes the input arguments for the Integration Object Hierarchy to XML Hierarchy method of the EAI Integration Object to XML Hierarchy Converter.

Table Integration Object Hierarchy to XML Hierarchy Input Arguments

Display Name	Name	Data Type	Description
Namespace	Namespace	String	If a namespace is defined here, then it will override any namespace defined in the user properties of an integration object.
Integration Object Hierarchy	SiebelMessage	Hierarchy	The integration object hierarchy to be converted.
Use Siebel Message Envelope	UseSiebelMessageEnvelope	String	Default is True. If set to True, then the Siebel Message Envelope is used in the XML Hierarchy, otherwise the Siebel Message Envelope is not included.
Generate Namespace Declarations	GenerateNamespaceDecl	String	Default is False. If set to True, then the namespace declaration will be generated.
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.

The following describes the output argument for the Integration Object Hierarchy to XML Hierarchy method of the EAI Integration Object to XML Hierarchy Converter.

Table Integration Object Hierarchy to XML Hierarchy Output Argument

Display Name	Name	Data Type	Description
XML Hierarchy	XMLHierarchy	Hierarchy	The converted integration object.

XML Hierarchy to Integration Object Hierarchy Method Arguments

The following describes the input arguments for the XML Hierarchy to Integration Object Hierarchy method of the EAI Integration Object to XML Hierarchy Converter.

Table XML Hierarchy to Integration Object Hierarchy Input Argument

Display Name	Name	Data Type	Description
Contains Inline Attachments	ContainsInlineAttachments	String	Default is True. DTYPE_ATTACHMENT fields are assumed to include actual attachment content. If False, then the field is treated as a reference to an external attachment.
Integration Object Name	IntObjectName	String	Integration Object Name can be specified if the Siebel Message envelope is not present in the XML hierarchy. The service generates the envelope automatically if this parameter is present.
Strip Name Space	StripNamespace	String	Removes the namespace from XML tags.
Truncate Field Values	TruncateFieldValues	String	Default is True. If True, then truncate any fields longer than their maximum size. If False, then report fields that are too long as errors.
XML Hierarchy	XMLHierarchy	Hierarchy	The hierarchy to be converted.
Process Elements Only	ProcessElementsOnly	String	Default is False. If set to True, then processing of attributes is skipped.

The following describes the output argument for the XML Hierarchy to Integration Object Hierarchy method of the EAI Integration Object to XML Hierarchy Converter.

Table XML Hierarchy to Integration Object Hierarchy Output Argument

Display Name	Name	Data Type	Description
Integration Object Hierarchy	SiebelMessage	Hierarchy	The converted integration object.

XML Converter

The XML converter uses no integration object metadata. The rules for converting between XML documents and property sets are essentially the same as the XML Hierarchy Converter. This service, however, does not create an XML hierarchy property set, but instead the XML document’s root element becomes a Type top-level property set (for example, Service Method Arguments). The service is intended for importing and exporting hierarchical data (arguments, definitions, and so on) and for passing property set arguments to and from business services.

Note: When using this business service, you do not specify an output argument name. The Siebel application automatically maps the newly generated property set to the specified output process property.

The following shows the translation of an XML document into a property set representation within Siebel XML, and back again.

External entity resolution (XXE)has been disabled by default for security reasons and XML conversion will fail if the xml input has unknown External entities. To allow the external entities (XXE), user need to add the user property "DisableDefaultEntityResolution" with value "false" to the above business services.

When DisableDefaultEntityResolution = false external entities (XXE) will be ALLOWED.
When DisableDefaultEntityResolution = true external entities (XXE) will be NOT BE ALLOWED
When DisableDefaultEntityResolution user property is ABSENT external entities (XXE) will be NOT BE ALLOWED

The following topics are also described here:

XML Converter Business Service Methods

Use the XML Converter when you want to convert any property set to XML, or convert an XML document that is not a Siebel EAI Integration Object Message to a property set.

There are two methods for the XML Hierarchy Converter, as shown in the following table. The arguments for each method appear in Property Set To XML Method Arguments, Property Set To XML Method Arguments, XML To Property Set Method Arguments, and XML To Property Set Method Arguments.

Table XML Converter Methods

Display Name	Name	Description
Property Set to XML	PropSetToXML	Converts a property set hierarchy to XML. Returns the result in the Value field of the Output property set.
XML to Property Set	XMLToPropSet	Converts an XML document stored in the Value field of the property set to a property set hierarchy. Returns the result in the Output property set.

Property Set To XML Method Arguments

The following table describes the input argument for the Property Set To XML method of the XML Converter.

Table Property Set To XML Method Input Argument

Name	Data Type	Description
Child type of the hierarchical process property containing the entire property set, service method arguments, and child property set.	Hierarchical	The entire input property set. You must manually create and name this input argument if it is required by your business needs.

Name

Data Type

Description

Child type of the hierarchical process property containing the entire property set, service method arguments, and child property set.

Hierarchical

The entire input property set.

You must manually create and name this input argument if it is required by your business needs.

The following describes the output argument for the Property Set To XML method of the XML Converter.

Table Property Set To XML Method Output Argument

Display Name	Name	Data Type	Description
XML Document	<Value>	String	The output XML document.

XML To Property Set Method Arguments

The following describes the input argument for the XML To Property Set method of the XML Converter.

Table XML To Property Set Method Input Argument

Display Name	Name	Data Type	Description
XML Document	<Value>	String	The input XML document

The following describes the output argument for the XML To Property Set method of the XML Converter.

Table XML To Property Set Method Output Argument

Name	Data Type	Description
Child type of the hierarchical process property containing the entire property set, service method arguments, and child property set.	Hierarchical	The entire output property set. You must manually create and name this output argument if it is required by your business needs.

Siebel XML Converter Business Service Comparison

The following table shows the basic differences between the four XML Converter business services. The table also gives guidelines on the appropriate usage. The following terminology is used in :

Yes. Supported by the converter.
Yes-second. Supported when used with a second converter.

Note: The EAI Integration Object to XML Hierarchy Converter always requires the XML Hierarchy Converter in the following instances.
No. Not supported by the converter.

Table Siebel XML Converter Comparison

Support or Requirement	EAI XML Converter	XML Hierarchy Converter	EAI Integration Object to XML Hierarchy Converter	XML Converter
Siebel Workflow	Yes	Yes	Yes-second	No
Siebel Data Mapper	Yes	Yes-second (with the EAI Integration Object Hierarchy Converter)	Yes-second	No
Siebel eScript for data transformation	Yes	Yes	Yes-second	No
Custom XML envelopes	No	Yes	Yes-second	No
Dispatch Service	Yes	Yes	Yes-second	No
XML representing business service method arguments	No	No	Yes-second	Yes
Serializing property sets as XML	No	No	Yes-second	Yes
Internal representation	Siebel Message (integration object instance)	XML Hierarchy	Siebel Message (integration object instance)	Property Set
Requirement for creating an integration object definition	Yes	No	Yes	No

EAI XML Write to File Business Service

Use the EAI XML Write to File business service when you want to create an XML document from a property set hierarchy and write the resulting document to a file. This business service supports all XML converters. The following describes the EAI XML Write to File business service methods.

Table EAI XML Write to File Methods

Display Name	Name	Description
Write Siebel Message	WriteEAIMsg	Uses the EAI XML Converter
Write XML Hierarchy	WriteXMLHier	Uses the XML Hierarchy Converter
Write Property Set	WritePropSet	Uses the XML Converter

Write Siebel Message Method Arguments

The following describes the input arguments for the Write Siebel Message method of the EAI XML Write to File business service.

Table Write Siebel Message Method Input Arguments

Display Name	Name	Data Type	Description
File Name	FileName	String	The name of the file where output is to be written. This is a required field.
Siebel Message	Siebel Message	Hierarchy	The Integration Object Hierarchy to be converted to XML.
XML Character Encoding	XMLCharEncoding	String	Character encoding in the XML document. If encoding is blank or not supported, then an error is produced.
Use Siebel Message Envelope	UseSiebelMessageEnvelope	String	Default is True. Insert the Siebel Message Envelope into the XML document.
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 Namespace Declarations	GenerateNamespaceDecl	String	Default is False. If set to 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, it will override any namespace defined in the user properties of an integration object.

Write Property Set Method Arguments

The following describes the input arguments for the Write Property Set method of the EAI XML Write to File business service.

Table Write Property Set Input Arguments

Display Name	Name	Data Type	Description
File Name	FileName	String	The name of the file where output is to be written. This is a required field.
Not applicable	Child type of the hierarchical process property containing the entire property set, service method arguments, and child property set.	Hierarchical	The entire input property set. You must manually create and name this input argument if it is required by your business needs.

Write XML Hierarchy Method Arguments

The following describes the input arguments for the Write XML Hierarchy method of the EAI XML Write to File business service.

Table Write XML Hierarchy Method Input Arguments

Display Name	Name	Data Type	Description
File Name	FileName	String	The name of the file where output is to be written. This is a required field.
XML Hierarchy	XMLHierarchy	Hierarchy	The XML Hierarchy Property Set.
Escape Names	EscapeNames	String	Invalid characters in XML tags will be escaped, using Siebel’s internal escape format. If True, then Escape invalid characters (this is the default). If False, then delete Escape characters.
XML Character Encoding	XMLCharEncoding	String	Outputs XML character encoding to use. If encoding is blank or not supported, then an error is produced.
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.

EAI XML Read from File Business Service

Use the EAI XML Read from File business service when you want to create a property set hierarchy in the Siebel environment from an XML document stored as a file. This business service supports both standard and EAI XML conversion.

The following describes the three EAI XML Read from File business service’s methods. The arguments for each method appear in the tables that follow.

Table EAI XML Read from File Business Service Methods

Display Name	Name	Description
Read Siebel Message	ReadEAIMsg	Uses the EAI XML Converter
Read Property Set	ReadPropSet	Uses the XML Converter
Read XML Hierarchy	ReadXMLHier	Uses the XML Hierarchy Converter

Read Siebel Message Method Arguments

The following describes the input arguments for the Read Siebel Message method of the EAI XML Read from File business service.

Table Read Siebel Message Method Input Arguments

Display Name	Name	Data Type	Description
File Name	FileName	String	The name of the file to be read. This is a required field.
Integration Object Name	IntObjectName	String	Name of the Integration Object to use in cases where the Siebel Message header is not present.
Integration Object Lookup Rule Set	IntObjectLookupRuleSet	String	Rule Set for the EAI Dispatcher Service for finding the Integration Object Name in cases where the Siebel Message header is not present.
External Entity Directory	ExternalEntityDirectory	String	Directory to use for finding external entities referenced in the XML document, such as DTDs.
Truncate Field Values	TruncateFieldValues	String	Default is True. If True, then truncate any fields longer than their maximum size. If False, report fields that are too long as errors.
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.
Process Elements Only	ProcessElementsOnly	String	Default is False. If set to True, then processing of attributes is skipped.

The following describes the output arguments for the Read Siebel Message method of the EAI XML Read from File business service.

Table Read Siebel Message Method Output Arguments

Display Name	Name	Data Type	Description
Siebel Message	SiebelMessage	Hierarchy	The Integration Object Hierarchy converted from XML.
XML Character Encoding	XMLCharEncoding	String	Outputs XML character encoding to use. If encoding is blank or not supported, then an error is produced.

Read Property Set Method Arguments

The following describes the input argument for the Read Property Set method of the EAI XML Read from File business service.

Table Read Property Set Method Input Argument

Display Name	Name	Data Type	Description
File Name	FileName	String	The name of the file to be read. This is a required field.

The following describes the output argument for the Read Property Set method of the EAI XML Read from File business service.

Table Read Property Set Method Output Argument

Name	Data Type	Description
Child type of the hierarchical process property containing the entire property set, service method arguments, and child property set.	Hierarchical	The entire output property set. You must manually create and name this output argument if it is required by your business needs.

Read XML Hierarchy Method Arguments

The following describes the input arguments for the Read XML Hierarchy method of the EAI XML Read from File business service.

Table Read XML Hierarchy Method Input Arguments

Display Name	Name	Data Type	Description
File Name	FileName	String	The name of the XML file to read. This is a Required field.
Escape Names	EscapeNames	String	Invalid characters in XML tags will be escaped, using Siebel’s internal escape format. If True, then process Escape characters (this is the default). If False, then do not process Escape characters.
External Entity Directory	ExternalEntityDirectory	String	Directory for external entities such as DTD files.
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.

The following describes the output arguments for the Read XML Hierarchy method of the EAI XML Read from File business service.

Table Read XML Hierarchy Method Output Arguments

Display Name	Name	Data Type	Description
XML Character Encoding	XMLCharEncoding	String	Character encoding of the XML document, detected by the converter independent of the parser.
XML Hierarchy	XMLHierarchy	Hierarchy	The XML Hierarchy property set.