Foreign Keys

Foreign Key infos

A foreign key should always have a Foreign Key Info set on it. Indeed, the technical foreign key value may not bring business information to help the user choose a record in the foreign key pickers (except for entities having meaning primary keys).

Foreign Key filters

When it is required to use Foreign Key filters, the filtering element should always be above the filtered element, in the model. This will increase the chances of having a filter set, as user usually populate fields from the top to the bottom.

Breaking into separate tabs

By default, foreign entities should not be broken into separate tabs, but only when there is an explicit business need. In most of the cases, only 1-to-many relations will need to be split into separate tabs.

Naming conventions

Foreign key should be named using the following convention: Fk + foreign entity name (e.g. FkStore).

This will ease the element name retrieval in the Integration perspective, enabling the developer to know that MDM.createFK() will be required, without having to check the data model.