Integration Server 10.3 | Built-In Services Reference Guide | Flat File Folder | Summary of Elements in the Flat File Folder | pub.flatFile.generate:FFDictionary
 
pub.flatFile.generate:FFDictionary
WmFlatFile. This IS document type defines the format to use when supplying a flat file dictionary or dictionary entry (in the FFXML variable) and the format that services return (in the FFXML variable) when you are retrieving a flat file dictionary or dictionary entry.
The structure for this IS document type is defined in the following XML schema:
Integration Server_directory \instances\instance_name\packages\WmFlatFile\pub\FFGeneration.xsd
Variables
FFDictionary
Document The dictionary entries that you want to add or update. FFDictionary has the following structure:

RecordDictionary Entry
Document List Optional. The dictionary entries for records that you want to add or update in the flat file dictionary. Leave this null if you do not want to add or update record entries.
Variable
Description
EntryName
String The name of the record.
RecordDefinition
Document The definition of the record. The information you specify in a record definition is the same as the information that you specify when creating a flat file dictionary using the Flat File Schema Editor. For descriptions of the fields, see webMethods Service Development Help.

Composite DictionaryEntry
Document List Optional. The dictionary entries for composites that you want to add or update in the flat file dictionary. Leave this null if you do not want to add or update composite entries.
Variable
Description
EntryName
String The name of the composite.
CompositeDefinition
Document The definition of the composite. The information you specify in a composite definition is the same as the information that you specify when creating a flat file dictionary using the Flat File Schema Editor. For descriptions of the fields, see webMethods Service Development Help.

FieldDictionary Entry
Document List Optional. The dictionary entries for fields that you want to add or update in the flat file dictionary. Leave this null if you do not want to add or update field entries.
Variable
Description
EntryName
String The name of the field.
FieldDefinition
Document The definition of the field. The information you specify in a field definition is the same as the information that you specify when creating a flat file dictionary using the Flat File Schema Editor. For descriptions of the fields, see webMethods Service Development Help.
Usage Notes
If you are using this IS document type to supply a flat file dictionary as input to the pub.flatFile.generate:saveXMLAsFFDictionary, be sure to supply all dictionary entries. If you are using this IS document type to update an existing dictionary, provide only the entries that you want to add or update and invoke the pub.flatFile.generate:updateFFDictionaryEntryFromXML to update the flat file dictionary.