Wednesday 16 October 2013

Recommended Naming Convention for custom tables and fields

If you add custom tables or fields directly to the Syspro database, it is highly recommended that you use a naming scheme like these examples:
  • CUSTOM_YourTableName
  • USR_YourTableName
  • CUSTOM_YourFieldName

The guidelines for the naming convention are:
  1. The first word is in ALL-CAPS and should be the same word used for all customisations; CUSTOM or USR are the recommended words to use. CUSTOM is recommended over CUS because CUS is abbreviated and ambiguous with "Customer".
  2. The actual meaningful table or fieldname should be in CamelCase without underscores.
  3. The two words, CUSTOM and YourTableName, should be separated by an underscore.

The reason why the first word, CUSTOM, should be in ALL-CAPS is so that:
  1. It makes all custom-added tables (and/or fields) stand out visibly from the standard Syspro ones.
  2. It groups all the custom-added tables and fields together.




No comments:

Post a Comment