webMethods 10.2 | Service Development Help | Properties | Flat File Element Properties | Record Reference Properties
 
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.

Copyright © 2017-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release