Integration Server 10.3 | Built-In Services Reference Guide | Flat File Folder | Summary of Elements in the Flat File Folder | pub.flatFile.generate:FFSchema
 
pub.flatFile.generate:FFSchema
WmFlatFile. This IS document type defines the format to use when supplying a flat file schema (in the FFXML variable) and the format that services return (in the FFXML variable) when you are retrieving a flat file schema.
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
FFSchema
Document The flat file schema that you want to add or update. FFSchema has the following structure:
Variable
Description
Delimiters
Document The delimiters used in the flat files that adhere to this flat file schema. The information that you specify for Delimiters corresponds to the data you specify on the Flat File Definition tab in the Flat File Schema Editor. For a description of the fields, see webMethods Service Development Help.

Document Structure
Document The structure of the flat files that adhere to this flat file schema. The information that you specify for DocumentStructure corresponds to the data you specify on the Flat File Structure tab in the Flat File Schema Editor. For a description of the fields, see webMethods Service Development Help.
Variable
Description
Ordered
String Whether the child records appear in the flat file in the order they are defined in the flat file schema.
RecordStructure
Document List Definitions of the records within the flat file.
Variable
Description
Ordered
String Whether the child records appear in the flat file in the order they are defined in the flat file schema.
RecordUsage
Document Information about how the record is used, including either the dictionary reference for this record or the definition of the record.
RecordStructure
Document List Child records of this record. This is a recursive reference to the RecordStructure defined in FFSchema/DocumentStructure.
RecordParser
Document The type of record parser. In this IS document, specify only the one variable that corresponds to the type of record parser to use. That is, specify one of FixedLengthParser, DelimitedParser, VariableLengthParser, or EDIParser. For DelimitedParser, VariableLengthParser, and EDIParser, you do not need to specify a value; just have the variable in the pipeline.

DefaultRecord Reference
Document Optional. The dictionary name and entry name that identifies the default record for the flat file schema. If you specify a default record, when using the flat file schema to parse a flat file schema, the default record is used for any record that cannot be recognized.

Record Identifier
Document Where to locate the identifier to use to correlate a record in the flat file to a record definition in the flat file schema. Specify either the NthFieldIdentifier variable or the FixedPositionIdentifier variable:
*Use NthFieldIdentifier to identify the field in the record (counting from zero) that contains the identifier.
*Use FixedPositionIdentifier to identify the character position in the record (counting from zero) where the record identifier is located.

UndefinedData Allowed
String Whether you want the pub.flatFile:convertToValues service to generate undefined data errors when you use this flat file schema to convert a flat file to an IData object.
*Specify true if you want to allow undefined data and do not want the pub.flatFile:convertToValues service to flag undefined data errors.
*Specify false if you do not want to allow undefined data and you do want the pub.flatFile:convertToValues service to flag undefined data errors.

Document Areas
String List Areas for this flat file schema. An area is a way to associate an arbitrary string with a given record.
FloatingRecord
String Optional. The name of the record that is defined in the schema as a floating record.
Note:
If the floating record has an alternate name, specify the alternate name.
Description
String Description of the flat file schema.