Siebel Financial Services eBusiness Application Integration Guide > Siebel Financial Services eAI Architecture > Industry XML Connector >
Industry XML Converter
The Industry XML Converter supports the generic syntax and rules requirements of the general industry XML standard. It converts the data from Siebel external integration object hierarchy to XML hierarchy that conforms to DTD specifications. For example, it generates certain authentication parameters for the XML message, and also generates and detects the fault sections in an XML message for extended converters to manipulate. Table 12 lists all the user properties for this converter.
Table 12. Industry XML Converter User Properties
Name
|
Value
|
Description
|
EscapeNames
|
true or false
|
If set to true, the converter replaces illegal XML name characters with escape characters. Otherwise, it will ignore illegal XML name characters. The default value is true.
|
HierarchyFormat
|
XML Hierarchy
|
Format of the property set input or output. Internal use only.
|
XMLEnvIntObjectName
|
<integration object name>
|
Name of an integration object that defines the content and hierarchy for the envelope and header section of any industry XML standards.
|
This service provides several ready-to-use-methods as described in Table 13.
Table 13. Industry XML Converter Methods
Methods
|
Display Name
|
Description
|
PropSetToXML
|
PropSetToXML
|
Converts an integration object hierarchy to XML string.
|
PropSetToXMLPropSet
|
PropSetToXMLPropSet
|
Converts an integration object hierarchy to XML hierarchy.
|
XMLToPropSet
|
XMLToPropSet
|
Converts an XML string to an integration object hierarchy.
|
XMLPropSetToPropSet
|
XMLPropSetToPropSet
|
Converts an XML hierarchy to an integration object hierarchy.
|
For each method defined the Industry XML Converter business service takes input arguments and produces output arguments. These arguments are described in Table 14.
Table 14. Industry XML Converter Method Arguments
Method Argument
|
Default
|
Description
|
XML Document
|
N/A
|
XML document streams.
|
Escape Names
|
true
|
Escape characters, invalid XML characters, to be removed or not.
|
Ignore Character Set Conversion Errors
|
false
|
If some characters cannot be represented in the destination character set, for example, local codepage, the errors can be ignored.
|
XML Character Encoding
|
N/A
|
XML character encoding to use in the output XML document. If encoding is blank or not supported, errors will be produced.
|
XML Header Text
|
N/A
|
Text to preappend to the XML document.
|
XML Hierarchy
|
N/A
|
Property Set in external integration object or XML hierarchy.
|
External Entity Directory
|
N/A
|
Location of an external entity file, such as a DTD file.
|
Validate External Entity
|
false
|
If true, the XML parser will validate the document according to the DTD specified in the <DocType> element.
|
Truncate Field Values
|
true
|
truncate field values.
|
Contains Inline Attachments
|
true
|
Indicates the message contains attachment documents.
|
Each Industry XML Converter method uses groups of these method arguments to convert the data for the next service in the integration process. Table 15 through Table 18 display the method arguments for each method.
Table 15. Method Arguments for PropSetToXML Method
Name
|
Display Name
|
Data Type
|
Type
|
Optional
|
<Value>
|
XML Document
|
String
|
Output
|
Yes
|
EscapeName
|
Escape Name
|
String
|
Input
|
Yes
|
IgnoreCharSetConvErrors
|
Ignore Character String Set Conversion Errors
|
String
|
Input
|
Yes
|
XMLCharEncoding
|
XML Character Encoding
|
String
|
Input
|
Yes
|
XMLHeaderText
|
XML Header Text
|
String
|
Input
|
Yes
|
XMLHierarchy
|
XML Hierarchy
|
Hierarchy
|
Input
|
No
|
Table 16. Method Argument for PropSetToXMLPropSet Method
Name
|
Display Name
|
Data Type
|
Type
|
Optional
|
XMLHierarchy
|
XML Hierarchy
|
Hierarchy
|
Input/Output
|
No
|
Table 17. Method Arguments for XMLToPropSet Method
Name
|
Display Name
|
Data Type
|
Type
|
Optional
|
<Value>
|
XML Document
|
String
|
Input
|
No
|
EscapeName
|
Escape Name
|
String
|
Input
|
Yes
|
ExternalEntityDirectory
|
External Entity Directory
|
String
|
Input
|
Yes
|
IgnoreCharSetConvErrors
|
Ignore Character String Set Conversion Errors
|
String
|
Input
|
Yes
|
ValidateExternalEntity
|
Validate External Entity
|
String
|
Input
|
Yes
|
XMLCharEncoding
|
XML Character Encoding
|
String
|
Output
|
Yes
|
XMLHierarchy
|
XML Hierarchy
|
Hierarchy
|
Output
|
Yes
|
Table 18. Method Arguments for XMLPropSetToPropSet Method
Name
|
Default Display Name
|
Data Type
|
Type
|
Optional
|
ContainsInlineAttachments
|
Contains Inline Attachments
|
String
|
Input
|
Yes
|
TruncateFieldValues
|
Truncate Field Values
|
String
|
Input
|
Yes
|
XMLHierarchy
|
XML Hierarchy
|
Hierarchy
|
Input/Ouput
|
No
|
