Composite Definition 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:

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.