Lookup Specification

A Lookup Specification defines a query against an external data source, which is used to validate and/or populate field values.

Remarks

Lookup Specifications are created on container elements in a Data Model. Each Data Model, Data Section, and Data Table object may define a collection of Lookup Specifications which apply to its child fields.

List of Lookup Specification Types

Name Description
CMIS Lookup Performs a lookup against a CMIS repository.
Database Lookup Performs a lookup against a database.
Lexicon Lookup Performs a lookup against a Lexicon.

Properties

The following 6 properties are defined.

Property Name Description
Lookup Options
Trigger Mode Type: TriggerModes, Default: Auto

Controls when the lookup is executed. Can be one of the following values:

  • Auto - Trigger automatically when the value of a lookup field changes.
  • Conditional - Trigger automatically when the value of a lookup field changes, only if the target fields are currently empty.
  • Manual - Must be triggered manually by a user.
Miss Disposition Type: MissDispositions, Default: Normal

Specifies what happens if the lookup returns no results. Can be one of the following values:

  • Normal - Flag the lookup fields and clear the target fields.
  • Flag - Flag the lookup fields.
  • Clear - Clear the target field values.
  • Ignore - Do nothing. Behave as though no lookup is defined.
Conflict Disposition Type: ConflictDispositions, Default: Normal

Specifies what happens if the lookup returns multiple results. Can be one of the following values:

  • Normal - Flag the lookup fields and clear the target fields.
  • Flag - Flag the lookup fields.
  • Accept - Use the first row in the result set.
  • Ignore - Do nothing. Behave as though no lookup is defined.
Field Population Type: PopulationMethod, Default: Overwrite

Specifies how target fields are populated with the lookup results. Can be one of the following values:

  • Overwrite - Populate the target fields.
  • Supplement - Populate the target fields if they are empty.
  • None - Do not populate any fields.
Lookup Info
Lookup Fields Type: String

The list of fields used as lookup criteria.

Target Fields Type: String

The list of fields used to be populated by the lookup operation.