XML Reference: Siebel eBusiness Application Integration Volume V > 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
Display Name
Name
Description
Write Siebel Message
WriteEAIMsg
Uses the EAI XML Converter
Write XML Hierarchy
WriteXMLHier
Uses the XML Converter
Write Property Set
WritePropSet
Uses the XML Hierarchy 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
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, 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—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 False. When True, a line feed is placed at the end of each tag.
n/a
GenerateNamespaceDecl
String
Default is False. If set to True then the namespace declaration will be generated. You must manually create and name this input argument if it is required by your business needs.
n/a
GenerateProcessingInstructions
String
Default is True. If set to False then the Siebel processing instructions are not written.You must manually create and name this input argument if it is required by your business needs.
n/a
GenerateSchemaTypes
String
Default is False. If set to True then XSD schema types will be generated if set on the integration objects user properties. You must manually create and name this input argument if it is required by your business needs.
n/a
Namespace
String
If a namespace is defined here, it will override any namespace defined in the user properties of an integration object. You must manually create and name this input argument if it is required by your business needs.

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
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.
n/a
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
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, Escape invalid characters (this is the default).
  • If False, delete Escape characters.
XML Character Encoding
XMLCharEncoding
String
Outputs XML character encoding to use. If encoding is blank or not supported, 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—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 False. When True, a line feed is placed at the end of each tag.
n/a
GenerateProcessingInstructions
String
Default is True. If set to False the Siebel processing instructions are not written.


 XML Reference: Siebel eBusiness Application Integration Volume V 
 Published: 23 June 2003