Field Reference Properties

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.