Integration Server 10.3 | Built-In Services Reference Guide | Flat File Folder | Summary of Elements in the Flat File Folder | pub.flatFile.generate:saveXMLAsFFDictionary
 
pub.flatFile.generate:saveXMLAsFFDictionary
WmFlatFile. Creates a flat file dictionary in the Integration Server namespace by converting the specified flat file dictionary that is in XML format into a namespace flat file dictionary.
If a flat file dictionary with the same name already exists in the Integration Server namespace, use the pub.flatFile.generate:deleteFFDictionary service to delete the flat file dictionary before invoking this service. This service throws an exception is if a flat file dictionary with the same name already exists when it is invoked.
Input Variables
FFDictionaryName
String The fully–qualified name of the flat file dictionary that you want to create in the Integration Server namespace.
PackageName
String The name of the Integration Server package in which to save the flat file dictionary.
FFXML
String The flat file dictionary (as an XML string) that you want to create in the Integration Server namespace. The XML string must conform to the pub.flatFile.generate:FFDictionary IS document type.
Merk:
To see examples of how to supply the XML string in FFXML by mapping data from another file, see the samples provided in the WmFlatFileSamples package. For sample code that shows how to retrieve the data for FFXML from an XML file in the local file system, see Flat File Schema Developer’s Guide.
maxNumOfErrors
String Optional. The maximum number of errors that you want returned. The default is 100.
The service ensures the flat file dictionary is valid before saving it in the Integration Server namespace. The validation occurs in two stages.
1. Structural validation of the XML.
2. Logical validation of the XML contents.
If structural validation errors occur, the service reports the structural validation errors, but does not proceed with logical validation. When the XML string contains no structural validation errors, the service proceeds with logical validation and reports any logical validation errors.
Output Variables
saved
String Whether the flat file dictionary was saved successfully. It will have one of the following values.
Value
Description
true
The flat file dictionary was successfully saved.
false
The flat file dictionary was not successfully saved.
Errors
String List Optional. Errors that occurred while attempting to save the flat file dictionary to the Integration Server namespace.
Warnings
String List Optional. Warnings about the flat file dictionary that was created.
Usage Note
Use this service to add a new flat file dictionary. Use the pub.flatFile.generate:updateFFDictionaryEntryFromXML if you want to update one or more entries in a flat file dictionary rather than creating a new flat file dictionary.