Bookshelf v7.7: EAI XML Read from File Business Service

XML Reference: Siebel eBusiness Application Integration Volume V > Siebel XML Converters >

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.

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

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

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

Table 42. 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, 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—conversion errors are logged, including a warning log entry. When set to True, only a warning message is logged.
n/a	ProcessElementsOnly	String	Default is False. If set to True, processing of attributes is skipped.

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

Table 43. 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, an error is produced.

Read Property Set Method Arguments

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

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

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

Table 45. Read Property Set Method Output Argument
Display Name	Name	Data Type	Description
n/a	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

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

Table 46. 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. n If True, process Escape characters (this is the default). n If False, 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—conversion errors are logged, including a warning log entry. When set to True, only a warning message is logged.

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

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