Dictionary Reference -- Entity Section
Entity Keys Panel
Entity Keys {type: collection}
Usage: The Entity Keys panel contains elements that specify keys (a.k.a. constraints) used to enforce integrity of the entity's data.
Primary Key {type: codelist (Attributes defined in the current Entity); extensible: YES; multi-value: YES; default: empty}
Usage: The primary key is a field (or collection of fields), that allows each instance of the Entity to be uniquely identified.Although the Primary Key element is not required, it is highly recommended and is required for all SQL table definitions.
Foreign Key {type: array (obj: Foreign Key)}
Usage: In data management a foreign key is a field (or collection of fields) in one Entity that refers to the primary key in another Entity.
See object detailsThe foreign key constraint is used to prevent invalid data from being inserted into the foreign key column. This is enforced by requiring the foreign key column(s) to use one of the values contained in the referenced table column(s). In the above image foreign key column "state_id" for entity "CITY must match a "state code" in the "STATE" entity.
Foreign Key Object
Local Attributes {type: codelist (Attributes defined in the current Entity); extensible: YES; multi-value: YES; default: empty}
Usage: Choose the attribute (or collection of attributes) from the current entity that will be matched to the primary key of the referenced entity.Referenced Entity {type: codelist (Entities defined in the current Dictionary); extensible: YES; multi-value: NO; default: empty}
Usage: Choose the Entity which will act as the reference table for permissible values for the local attribute (or collection of attributes).Referenced Attributes {type: codelist (Attributes defined in the referenced Entity); extensible: YES; multi-value: YES; default: empty}
Usage: Choose the attribute (or collection of attributes) from the reference entity that represent its primary key.When a foreign key is defined with multiple attributes be sure to select Referenced Attributes in the same order as Local Attributes so there is a one-to-one correspondence based on entry order.
