XML Reference: Siebel Enterprise Application Integration > Siebel XML Converters >
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. Table 37 describes the EAI XML Write to File business service methods.
Table 37. EAI XML Write to File Methods
|
|
|
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
Table 38 describes the input arguments for the Write Siebel Message method of the EAI XML Write to File business service.
Table 38. Write Siebel Message Method Input Arguments
|
|
|
|
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
Table 39 describes the input arguments for the Write Property Set method of the EAI XML Write to File business service.
Table 39. Write Property Set Input Arguments
|
|
|
|
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
Table 40 describes the input arguments for the Write XML Hierarchy method of the EAI XML Write to File business service.
Table 40. Write XML Hierarchy Method Input Arguments
|
|
|
|
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. |
|