Here are some conventions, or say patterns, which are common for defining an Entity and its Fields. - Entity names must be in UpperCamelCase.
- Entity names must be short enough so that the automatic table name (with an underscore added before each capital letter) is 30 characters or less.
- Field names must be short enough so that the automatic column name (with an underscore added before each capital letter) is 30 characters or less.
- fk-name should not must be more then 18 letterscharacters or less.
- If entity name is abbreviation like Unit Of Measure (UOM) then treat it as one word, like: Uom.
- The Field field name must be in lowerCamelCase and the name should be self descriptive enough to show the purpose of the field.
- If relation tag specify the relationship between two entities then the fk-name should contains the words from both entities separated by ("_") underscore.
- If a entity relation with another entity defines more than one time then it should be differentiated by title attribute while defining a relation like "FormFrom" or "To".
- In the same if both fields in the <key-map> tag are the same, then there is no need to specify the rel-field-name.
- In case of view entities the name will must consist of names of all its member entities.
- The <view-link> should be define defined for proper view in the webtools.
|