Best practice naming rules
See also : How to Naming.
This document defines the naming convention to use while performing standard or specific developments to avoid naming conflicts.
The purpose of this document is to provide best practice guidelines when developing in Version 7.
The following naming rules are considered ‘best practice’:
You should create meaningful names (codes). Avoid using abbreviations and generic words. All codes must be created in English. For example: 'MYPROCESSCODE' instead of 'MYPROCCD'.
Be consistent. Use the same code throughout the development process. A data class and a representation class should have the same code as the main data table. For example: if the data table code is 'MYCODE', use 'MYCODE' for the data class code and the representation class code.
Even if it is not technically mandatory, assign a single code to a property in the data table, the data class, and the representation class. It is easier to understand and to maintain.
Do not forget the naming rules for a new property.
When adding a process to a data class or a representation class, Sage X3 displays the default value for the code. This code starts with the class/representation code. It is recommended that you use the default value for codes. It is also recommended that you follow the same convention for any other process files. This will make it easier to find all processes for a particular data class or representation class.
You must follow the naming convention rules when creating a method or an operation. See How to Naming.