Bookshelf v8.1/8.2: FINS IAA-XML Converter

Siebel Financial Services Connector for IAA-XML Guide > Siebel Connector for IAA-XML >

FINS IAA-XML Converter

The FINS IAA-XML Converter provides a way to convert data from the IAA property set to IAA-XML messages for outbound communication, and converts IAA-XML messages received to IAA property set for inbound communication. It iterates through the requests and responses in the message to construct the IBM EID Hub aggregated in the header section. It also constructs the envelope section of the message and data type formatting for fields. Table 12 lists all the user property for this converter.

Table 12. FINS IAA-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. For Internal Use.
XMLEnvIntObjectName	<integration object name>	Name of an integration object that defines the content and hierarchy for the envelope and header section of IAA-XML. The default envelope integration object is "IAA Envelope."

This service provides several ready-to-use-methods as described in Table 13.

Table 13. FINS IAA-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.
ErrorHandler	ErrorHandler	Constructs the XML hierarchy to respond to the external systems when undesired operation or configuration errors occurred.

For each method defined the FINS IAA-XML Converter business service takes input arguments and produces output arguments. These arguments are described in Table 14.

Table 14. FINS IAA-XML Converter Method Arguments
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 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 pre-append 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 files, 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.
GereralErrorMessageText	N/A	The general text to be pre-append to the <errorMessageText> element in IAA fault section.
ErrorMessageText	N/A	The actual error text to be set to the <errorMessageText> element in IAA fault section.
ErrorCode	N/A	The actual error code to be set to the <errorCode> element in IAA fault section.
ErrXMLHierarchy	N/A	Input hierarchy will contain the request XML hierarchy to be associated with when generating the respond XML hierarchy. This argument can be ignored. Output hierarchy will contain the XML hierarchy with <ErrorInfo> aggregate generated.

Each FINS IAA-XML Converter method uses group of these method arguments to convert the data for the next service in the integration process. Table 15 through Table 19 display the method arguments for each method.

Table 15. Method Arguments for PropSetToXML Method
Name	Default 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 Arguments for PropSetToXMLPropSet Method
Name	Default Display Name	Data Type	Type	Optional
XMLHierarchy	<IgnoreEmptyTag>	Hierarchy	Input/Output	No

Table 17. Method Arguments for XMLToPropSet Method
Name	Default 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/Output	No

Table 19. Method Arguments for ErrorHandler Method
Name	Default Display Name	Data Type	Type	Optional
GeneralErrorMessageText	General Error Message Text	String	Input	Yes
ErrorMessageText	Error Message Text	String	Input	No
ErrorCode	Error Code	String	Input	No
XMLHierarchy	Err XML Hierarchy	Hierarchy	Input/Output	No

Siebel Financial Services Connector for IAA-XML Guide		Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.