Flat File Element Properties

Record Definition Properties

In the Properties view, you can specify properties for a selected record definition in a flat file schema or dictionary.

Property	Description
Ordered	Specifies whether child records must appear in the flat file in the same order in which they appear in the record definition.
	Note: This property applies only to records that are children of this record definition.
	Select...	To...
	True	Default. Specify that records in the flat file must appear in the order which they appear in the record definition. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the records do not appear in the defined order.
	False	Specify that records in the flat file can appear in any order.
	Note: This property does not apply to records in flat file dictionaries.
Mandatory	Specifies whether or not an instance of this record definition is required to exist in the flat file.
	Select...	To...
	True	Indicate the record is required. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the record does not exist in a flat file.
	False	Default. Indicate the record is optional.
	Note: This property does not apply to records in flat file dictionaries.
Max repeat	Maximum number of that instances of this record definition can repeat in the flat file. Set to Unlimited if instances of this record definition can repeat any number of times in the flat file. Set to 0 if the record can appear once but cannot repeat. The default is 1, meaning the record can appear once and repeat once. If you set the Max repeat value to an integer and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the record repeats more than the number of times allowed by the Max repeat value. Note: This property does not apply to records in flat file dictionaries.
Validator	Specifies the type of validator to use to perform validation for instances of this record definition. Click to open the Validators dialog box and select a validator.
	Select...	To...
	None	Default. Indicate that no validator is used.
	Conditional Validator	Specify a conditional validator.
Area	The area assigned to this record definition. The Areas property for the flat file definition determines the possible values that can be assigned to a record. Note: This property does not apply to records in flat file dictionaries.
Position	Integer indicating the position of the of the record in the flat file. Select Not Used if you do not want to specify a position for the record. Note: This property does not apply to records in flat file dictionaries.
Allow undefined data	Specifies whether an instance of the record definition can contain undefined data and not be considered invalid. A record definition can only allow undefined data if the flat file schema is configured to allow undefined data. (When the Flat File Definition tab is active, in the Properties view, the Allow undefined data property is set to True.)
	Select...	To...
	True	Default. Allow instances of this record definition to contain undefined data. When a record definition allows undefined data, Integration Server does not generate validation errors when instances of this record reference in a flat file contain undefined data.
	False	Prohibit instances of this record definition from containing undefined data. If the `validate` variable of the pub.flatFile.convertToValue service is set to true, the pub.flatFile.convertToValue service will generate errors when undefined data is encountered.
	Note: This property does not apply to records in flat file dictionaries.
Check fields	Specifies whether extra fields in the record instance are considered errors.
	Select...	To...
	True	Report errors if, at run-time, the record instances contains more fields than those specified in the record definition.
	False	Default. Allow extra fields at the end of the record instance.
Alternate name	Another name for the record definition. When an IS document type is generated from a flat file schema, the alternate name is used as the name of the document field that corresponds to this record definition.
Local description	This property does not apply to a record definition.
Description	Description of the record definition.

Record Reference Properties

In the Properties view, you an specify properties for a selected record reference in a flat file schema or dictionary.

Property	Description
Ordered	Specifies whether child records must appear in the flat file in the same order in which they appear in the record reference. Note: This property applies only to records that are children of this record reference.
	Select...	To...
	True	Default. Specify that child records in the flat file must appear in the order which they appear in the record reference. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the records do not appear in the defined order.
	False	Specify that child records in the flat file can appear in any order.
Mandatory	Specifies whether or not an instance of this record reference is required to exist in the flat file.
	Select...	To...
	True	Indicate the record is required. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the record does not exist in a flat file.
	False	Default. Indicate the record is optional.
Max repeat	Maximum number of that instances of this record reference can repeat in the flat file. Set to Unlimited if instances of this record reference can repeat any number of times in the flat file. Set to 0 if the record can appear once but cannot repeat. The default is 1, meaning the record can appear once and repeat once. If you set the Max repeat value to an integer and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the record repeats more than the number of times allowed by the Max repeat value.
Validator	Specifies the type of validator used to perform validation for instances of this record reference as determined by the referenced record definition.
	Value...	Description...
	None	Indicates that no validator is used.
	Conditional Validator	A conditional validator and the criteria specified by the condition.
Area	The area assigned to this record reference. The Areas property for the flat file definition determines the possible values that can be assigned to a record reference.
Position	Integer indicating the position of the of the record in the flat file. Select Not Used if you do not want to specify a position for the record.
Allow undefined data	Specifies whether an instance of the record reference can contain undefined data and not be considered invalid. A record reference can only allow undefined data if the flat file schema is configured to allow undefined data. (When the Flat File Definition tab is active, in the Properties view, the Allow undefined data property is set to True.)
	Select...	To...
	True	Default. Allow instances of this record reference to contain undefined data. When a record reference allows undefined data, Integration Server does not generate validation errors when instances of this record reference in a flat file contain undefined data.
	False	Prohibit instances of this record reference from containing undefined data. If the `validate` variable of the pub.flatFile.convertToValue service is set to true, the pub.flatFile.convertToValue service will generate errors when undefined data is encountered.
Check fields	Specifies whether extra fields in the record instance are considered errors. This value is determined by the referenced record definition.
	Value...	Description...
	True	Report errors if, at run-time, the record instance contains more fields than those specified in the record definition.
	False	Allow extra fields at the end of the composite instance.
Alternate name	Another name for the record definition. This value is determined by the referenced record definition. When an IS document type is generated from a flat file schema, the alternate name of the record definition is used as the name of the document field that corresponds to this record reference.
Local description	Description of the record reference. Use a local description to describe the purpose of the record reference in this particular flat file schema.
Description	Description of the referenced record definition.

Composite Definition Properties

In the Properties view, you can specify properties for a selected composite definition in a flat file schema or dictionary.

Property	Description
Mandatory	Specifies whether or not an instance of this composite is required to exist in the flat file.
	Select...	To...
	True	Indicate the composite is required. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the composite does not exist in a flat file.
	False	Default. Indicate the composite is optional.
	Note: For a composite definition in a record reference, the Mandatory value is determined by the composite definition in the referenced record definition. Note: This property does not apply to composite definitions in flat file dictionaries.
Extractor	Field number in the record that contains the composite you want to extract. This pulls the field or composite data from the record, or pulls the subfield data from the composite. If you leave this property empty, the composite will not be extracted. Click to open the Extractors dialog box and specify the extractor. For a composite definition in a record reference, the Extractor value is determined by the composite definition in the referenced record definition. Note: The extractor works for a composite only if field delimiters and subfield delimiters have been defined for this flat file schema. Note: This property does not apply to composite definitions in flat file dictionaries.
Validator	Specifies the type of validator to use to perform validation for instances of this composite definition. Click to open the Validators dialog box and specify the validator.
	Select...	To...
	None	Default. Indicate that no validator is used.
	Conditional Validator	Specify a conditional validator.
	Note: For a composite definition in a record reference, the Validator value is determined by the composite definition in the referenced record definition.
Check fields	Specifies whether extra fields in the composite instance are considered errors.
	Select...	To...
	True	Report errors if, at run-time, the composite instance contains more fields than those specified in the composite definition.
	False	Default. Allow extra fields at the end of the composite instance.
	Note: For a composite definition in a record reference, the Check fields value is determined by the composite definition in the referenced record definition.
Local description	For a composite definition in a record reference, specifies a description of the purpose for the composite definition at this particular location in the flat file schema. Note: This property does not apply to a composite definition in a record definition. Note: This property does not apply to composite definitions in flat file dictionaries.
Alternate name	Another name for the composite definition. When an IS document type is generated from a flat file schema, the alternate name is used as the name of the document field that corresponds to this composite definition. Note: For a composite definition in a record reference, the Alternate name value is determined by the composite definition in the referenced record definition.
Description	A description for the composite definition. Note: For a composite definition in a record reference, the Description value is determined by the composite definition in the referenced record definition.
ID Code	IDCode for the composite definition. This information is provided in a SEF file and is used by the WmEDI package. Note: For a composite definition in a record reference, the ID Code value is determined by the composite definition in the referenced record definition.

Composite Reference Properties

In the Properties view, you can specify properties for a selected composite reference in a flat file schema or dictionary.

Property	Description
Mandatory	Specifies whether or not an instance of this composite is required to exist in the flat file.
	Select...	To...
	True	Indicate the composite is required. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the composite does not exist in a flat file.
	False	Default. Indicate the composite is optional.
	Note: This property does not apply to a composite reference in a record reference. Note: For a composite reference in a record reference, the Mandatory value is determined by the composite reference in the referenced record definition.
Extractor	Field number in the record that contains the composite you want to extract. This pulls the field or composite data from the record, or pulls the subfield data from the composite. If you leave this property empty, the composite will not be extracted. Click to open the Extractors dialog box and select an extractor. Note: The extractor works for a composite only if field delimiters and subfield delimiters have been defined for this flat file schema. Note: For a composite reference in a record reference, the Extractor value is determined by the composite reference in the referenced record definition.
Validator	Specifies the type of validator to use to perform validation for instances of this composite reference as determined by the referenced composite definition.
	Value...	Description...
	None	Indicates that no validator is used.
	Conditional Validator	A conditional validator and the criteria specified by the condition.
	Note: For a composite reference in a record reference, the Validator value is determined by the composite reference in the referenced record definition.
Check fields	Specifies whether extra fields in the composite instance are considered errors. This value is determined by the referenced composite definition.
	Value...	Description...
	True	Report errors if, at run-time, the composite instance contains more fields than those specified in the composite definition.
	False	Allow extra fields at the end of the composite instance.
	Note: For a composite reference in a record reference, the Check fields value is determined by the composite reference in the referenced record definition.
Local description	Description of the composite reference. Use a local description to describe the purpose of the referenced composite definition in this particular flat file schema.
Alternate name	Another name for the composite definition. This value is determined by the referenced composite definition. When an IS document type is generated from a flat file schema, the alternate name is used as the name of the document field that corresponds to this composite definition Note: For a composite reference in a record reference, the Alternate name value is determined by the composite reference in the referenced record definition.
Description	Description for the referenced composite definition. Note: For a composite reference in a record reference, the Description value is determined by the composite reference in the referenced record definition.
ID Code	IDCode for the composite definition. The IDCode is provided in a SEF file and is used by the WmEDI package. Note: For a composite reference in a record reference, the ID Code value is determined by the composite reference in the referenced record definition.

Field Definition Properties

In the Properties view, specify properties for the selected field definition in a flat files schema or dictionary.

Property	Description
Mandatory	Specifies whether or not an instance of this field definition is required to exist in the flat file.
	Select...	To...
	True	Indicate the field is required. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the field does not exist in a flat file.
	False	Default. Indicate the field is optional.
	Note: This property does not apply to field definitions in flat file dictionaries.
Extractor	Location of the data to extract for this field. Click to open the Extractors dialog box and specify an extractor. The extractor works for a field only if field delimiters have been defined for this flat file schema.
	Select...	To...
	Nth Field	Specify the position of the field to extract. Note: Software AG recommends that you use this extractor instead of ID node.
	ID Node	Specify the position of the field to extract. The ID Node extractor is a variation of the Nth Field extractor and is available for backward compatibility for users of the webMethods Module for EDI.
	Fixed Position	Specify the start and end positions of the bytes to extract.
	Note: This property does not apply to field definitions in flat file dictionaries.
Validator	Specifies the type of validator to use to perform validation for the field. Click to open the Validators dialog box and select a validator.
	Select...	To...
	None	Default. Indicate that no validator is used.
	Length Validator	Specify the maximum and minimum number of characters this field can contain to be considered valid.
	Byte Length Validator	You specify the maximum and minimum number of bytes this field can contain to be considered valid. Note: Use the byte length validator for multi-byte encoded records.
	Code List Validator	Specify a comma–separated list of the allowed values for this field. If the value of the field is not contained in the code list, errors will be generated.
Format service	Enter the fully-qualified name of the service to use to format data from this field. You can click to navigate to and select a service.
Alternate name	Another name for the field definition. When an IS document type is generated from a flat file schema, the alternate name is used as the name of the String field that corresponds to this field definition.
Description	Description of the field definition. Note: This property does not apply to a field definition in a composite reference or a record reference.
ID Code	IDCode for the field definition. The IDCode is provided in a SEF file and is used by the WmEDI package.
Data type	Data type for the field as specified in the SEF file. This information is used by the WmEDI package.
Local description	For a field definition in a composite reference or a record reference, specifies a description for the field definition at this particular location in the flat file schema. Note: This property does not apply to field definitions in flat file dictionaries.

Field Reference Properties

In the Properties view, specify properties for the selected field definition in a flat files schema or dictionary.

Property	Description
Mandatory	Specifies whether or not an instance of this field reference is required to exist in the flat file.
	Select...	To...
	True	Indicate the field is required. If you select True and the `validate` parameter in the pub.flatFile:convertToValues service is set to true, Integration Server generates errors when the field does not exist in a flat file.
	False	Default. Indicate the field is optional.
	Note: For a field reference in a record reference or composite reference, the Mandatory value is determined by the field reference in the referenced record or referenced composite definition.
Extractor	Location of the data to extract for this field. Click to open the Extractors dialog box and specify an extractor. The extractor works for a field only if field delimiters have been defined for this flat file schema.
	Select...	To...
	Nth Field	Specify the position of the field to extract. Note: Software AG recommends that you use this extractor instead of ID node.
	ID Node	Specify the position of the field to extract. The ID Node extractor is a variation of the Nth Field extractor and is available for backward compatibility for users of the webMethods Module for EDI.
	Fixed Position	Specify the start and end positions of the bytes to extract.
	Note: For a field reference in a record reference or composite reference, the Extractor value is determined by the field reference in the referenced record or referenced composite definition.
Validator	Specifies the type of validator to use to perform validation for the field as determined by the referenced field definition.
	Value...	Description...
	None	Default. Indicate that no validator is used.
	Length Validator	The maximum and minimum number of characters this field can contain to be considered valid.
	Byte Length Validator	The maximum and minimum number of bytes this field can contain to be considered valid. Note: Use the byte length validator for multi-byte encoded records.
	Code List Validator	A comma–separated list of the allowed values for this field. If the value of the field is not contained in the code list, errors will be generated.
	Note: For a field reference in a record reference or composite reference, the Validator value is determined by the field reference in the referenced record or referenced composite definition.
Format service	Enter the fully-qualified name of the service to use to format data from this file as determined by the referenced field definition. Note: For a field reference in a record reference or composite reference, the Format service value is determined by the field reference in the referenced record or referenced composite definition.
Alternate name	Another name for the field definition as determined by the referenced field definition. When an IS document type is generated from a flat file schema, the alternate name is used as the name of the String field that corresponds to this field definition. Note: For a field reference in a record reference or composite reference, the Alternate name value is determined by the field reference in the referenced record or referenced composite definition.
Description	Description of the referenced field definition. Note: This property does not apply to a field definition in a composite reference or a record reference.
ID Code	IDCode for the field as determined by the referenced field definition. The IDCode is provided in a SEF file and is used by the WmEDI package. Note: For a field reference in a record reference or composite reference, the ID Code value is determined by the field reference in the referenced record or referenced composite definition.
Data type	Data type for the field as specified in the SEF file. This information is used by the WmEDI package. Note: For a field reference in a record reference or composite reference, the Data type value is determined by the field reference in the referenced record or referenced composite definition.
Local description	Description of the field reference. Use a local description to describe the purpose of the referenced field definition in this particular flat file schema.