Software AG Products 10.7 | Integrating On-Premises and Cloud Applications | Service Development | Properties | Flat File Element Properties | Record Definition 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.