Here are some rules and recommendations for Server packages:
Documents and Attributes
All document names are written in InitCap style.
Example: PurchaseOrder.
If the document is a representation of a business entity, then the document name should simply be the name of the entity.
Examples: Customer, Product, WorkOrder.
Documents that are collections of input parameters for an operation (and does not represent any business entity) should be named after that operation.
Examples: ReportOrderRequest, CalculateAvailabilityDate.
Attributes inside documents should be named after their full established name. Abbreviations should not be used unless absolutely necessary. The maximum length of an attribute name is 100 characters so it should be enough for most cases.
Examples: RegistrationDate, WantedDeliveryDate.
Do not include document names in attribute names. For example, if you have a document Supplier, you should name your attributes Name, Description, Address etc. - not Supplier_Name, SupplierDescription, SupplierAddress etc.
Attributes that are one-to-many aggregates should be named as the plural form of the aggregate document. For example if an Order document has an aggregate one-to-many to an OrderLine document, then the aggregate relationship should be named OrderLines.
Attributes that are one-to-one aggregates should be named with a natural role name for the attribute.
Handlers and Operations
Handlers are generated from the services created in the logical model. The services should be given logical name describing their use. A BizApi is an operation in the handler (service). A service is an object that can be granted to a user or a role and therefore it is advisable to separate operations that updates the database from operations that queries the database in different services.
Services should be given logical names describing their use.
Examples: OrderProcessing, WorkOrderUtilities.
Operations that are implementations of BizAPIs should have the same name (with the InitCap casing) as the BizAPI name (see below).
This page is generated from IFS Developer Studio at 2021-08-13 08:40.
