Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Data model - description fields

We often have two fields where the first field contains a code and the second field (used as a label, description or tool-tip, for example) contains the name / description for the code contained in the first field.

...

To avoid variation (Name vs Description vs Desc vs Descr vs Text vs Xxxx) we recommend always using 'Name'. Therefore:

  1. In most instances, we recommend that the two fields should be named the same, but the description field has the word 'Name' appended to the end. For example:
    1. CostCenter and CostCenterName

    2. ControllingArea and ControllingAreaName

  2. In instances where a field is named XxxCode or YyyKey (or similar) we recommend dropping the 'Code' or 'Key' and replacing it with 'Name' for the description field, for example:

    1. CompanyCode and CompanyName

    2. CurrencyKey and CurrencyName

      Exception: where the word 'Key' describes the field contents is part of the name, as opposed to simply indication that the field contains a code/key, it may remain part of the description field name:

    3. PostingKey and PostingKeyName

...