Composite Reference Properties

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.