Here are some conventions, or say patterns, which are common for defining an Entity and its Fields. - Entity name must be in UpperCamelCase.
- Entity name should not be more then 30 letters.
- Field name should not be more then 128 letters.
- fk-name should not be more then 18 letters.
- If entity name is abbreviation like Unit Od Of Measure (UOM) then treat it as one word and name is like Uom.
- The Field name must be in lowerCamelCase and 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 "Form" or "To".
- In the same if both fields in the <key-map> tag are same then no need to specify rel-field-name.
- In case of view entities the name will consist of names of all its member entities.
- The <view-link> should be define for proper view in the webtools.
|