Naming Conventions

MYOB Advanced makes it easy for multiple vendors to develop customisations without fear of entity name collisions by providing them with naming conventions to be used for all third party tables, screens, reports etc. The naming conventions make use of reserved namespace prefixes, allocated to each software development house, which prevent name collisions in the code written by two separate parties and differentiates custom object and field names from those in use by other organisations. This applies to the development work undertaken by both Developer Partners and Resellers.

Namespace prefix

Each Developer Partner/Reseller should have a namespace prefix registered with MYOB. This namespace is essentially a 2 letter combination that uniquely identifies solutions belonging to a development house and avoids name collisions with other Developer Partner solutions.

Naming convention for custom tables

Custom tables being added need to have three prefixes in the custom table name to ensure uniqueness.

“MA” + Developer Partner/reseller namespace prefix + Module code + Tablename

For example:

MAXXARCustomTable

Where:

  • MA is used to differentiate external customisations from MYOB initiated ones.
  • XX is a two-letter unique namespace prefix assigned to Developer Partner/Reseller
  • AR is the Module ID the new table belongs to (in this case Accounts Receivable)
  • CustomTable is the name of the table

Naming convention for custom fields

Custom fields being added to existing tables need to be prefixed with “MA” and the reseller/Developer Partner’s namespace.

Usr(added automatically by framework) + “MA” + Developer Partner/reseller namespace + Fieldname

For example :

UsrMAXXCustomField

Where:

  • Usr is prefixed by the framework automatically
  • MA differentiates external customisations from MYOB initiated ones
  • XX is the unique namespace prefix assigned to the Developer Partner/Reseller
  • CustomField is the name of the field

Note: For more information on guidelines for new database fields such as column and datatypes, Primary and foreign keys, audit fields and more please refer to the in-product help under the topic Help > MYOB Advanced Framework > Design Guidelines > Database Design Guidelines.

Naming convention for new screens

A screen name in MYOB Advanced is made up of four segments. The naming convention for new screens follows the same principle as for new tables and columns. All third party development would need to use “MA”, Developer Partner/Reseller unique namespace prefix and the module code the new webpage belongs to as the first three segments and in the order mentioned. The last segment represents the screen ID.

MA.xx.yy.99

Where:

  • MA differentiates external customisations from MYOB initiated ones
  • xx is a two-letter unique namespace prefix assigned to the Developer Partner/Reseller
  • yy is a two-letter Module ID the new webpage belongs to
  • 99 is a screen identifier

For example: MA.RB.AP.01

For development being done by clients directly, it is recommend they use XX for the Reseller Unique ID segment.

Naming convention for new reports

A report name in MYOB Advanced is made up of four segments, similar to a screen name, and the recommended naming convention is also similar to it. When naming reports in MYOB Advanced use the following convention:

MA.xx.6z.99

Where:

  • MA differentiates external customisations from MYOB initiated ones
  • xx is a two-letter unique namespace prefix assigned to the Developer Partner/Reseller
  • 6z is the number 6 followed by a one-letter ID that identifies the item as a report
  • 99 is a report identifier

For example: MA.RB.60.01