Table of Contents

Ometa Naming Conventions

Profile

  • English language
  • Start everything with a capital letter
  • Allowed characters [a-Z][-]
  • Spaces between words
  • Use a hyphen (-) for scoping the interface name

Examples

  • ODBC - Adventure Works
  • REST - My Api
  • SAP
  • SAP - Finance

Objects

  • English language
  • PascalCase
  • Singular object names
  • Allowed characters [a-Z][-]
  • Spaces between words
  • Use a hyphen (-) for scoping the object with the solution name or functional part of the application

Examples

  • Sales Order
  • Production Order
  • PDCA - Task
  • Plant Management Dashboard - KPI
  • OEE Dashboard - Graph
  • Contract Management - Contract

Field Names

The following rule set applies for the field names, not for the labels.

  • English language
  • Singular field names when applicable
  • Allowed characters [a-Z]
  • PascalCase
    • Exceptions for abbreviations such as ID
    • Lowercase only minor words that are three letters or fewer in the name
      • short conjunctions (e.g., “and,” “as,” “but,” “for,” “if,” “nor,” “or,” “so,” “yet”)
      • articles (“a,” “an,” “the”)
      • short prepositions (e.g., “as,” “at,” “by,” “for,” “in,” “of,” “off,” “on,” “per,” “to,” “up,” “via”)
  • Spaces between words
  • Use the External Name when the column name doesn't contain spaces in a SQL database for example

Examples

  • Product ID: not Product Id!
  • Sales Order ID
  • Order Number
  • Address
  • Street
  • Production Line
  • Book of Truth
  • Pepper and Salt

Methods

  • English language
  • Allowed characters [a-Z]
  • PascalCase
    • Exceptions for abbreviations such as ID
  • Spaces between words
  • In the Description a brief comment about the purpose of the method and or special conditions (used in where clauses)

Examples

Title Description
Get All Sales Orders Get all the sales orders
Get Sales Order Get a single sales order
Get Sales Order By <> Get the sales orders given a filter, input or specific context

CRUD Examples

CRUD Method Name
Create Create Sales Order
Multi Record Get All Sales Orders
Single Record Get Sales Order
Update Update Sales Order
Delete Delete Sales Order

Functions to indicate the specific action they are proposed to complete

  • Archive Sales Order
  • Approve Task
  • Decline Task

Views

  • English language
  • Allowed characters [a-Z]
  • PascalCase
    • Exceptions for abbreviations such as ID
  • Spaces between words
  • Give information about what is shown and not the link to the method (only applicable for read methods)
    • Should be clear, because the name of the view is standard what is shown on ADM in the portals
  • If the view is used as a datasource and for example read only 'Picker' can be mentioned in the name at the end.
Method View Name
Get Sales Orders Sales Orders
Sales Order Overview
Get Sales Order Order Details
Update Sales Order Update Order
Update Order Details
Create Sales Order Create Sales Order
Get Sales Orders Sales Order Picker

Context Managers

  • English language
  • Allowed characters [a-Z]
  • PascalCase
    • Exceptions for abbreviations such as ID
  • Spaces between words
  • Give information about which field can be used to filter.
Filter Type Context Manager Name
Generic Filter Filter
Filter with a status field Status Filter
Filter used for the completed sales orders Completed Sales Orders Filter

Case Management

Lifecyles

  • English language
  • Pascal Case
  • Spaces between words
  • Singular
  • Allowed characters [a-Z][-]

Examples

  • Supplier: a case for each supplier
  • Supplier Dashboard: the location / site to manage the supplier cases

Grouped Actions

  • English language
  • Pascal Case
  • Spaces between words
  • Singular
  • Allowed characters [a-Z][-]
  • Naming: [Lifecycle] [-] [Page / List / Navigation] <>

Lifecycles specific examples

  • Supplier - Page Home
  • Supplier - List Invoices
  • Supplier Dashboard - Navigation
  • Supplier Dashboard - Permissions

Global examples

Shared grouped actions or containing Global settings MUST be named like:

  • Generic - Page Reassign Task

ADM

Following the naming conventions for ADM ensures that code is uniform and backwards compatible.

Translations

When creating custom translation keys, make sure the key won't conflict in the future. To achieve this always create a wrapper key for your project.

Example:

// extend/en.json
...
"myProject": {
  "orderTitle": "Order Product",
  "unableToSaveProduct": "There was an error while saving the product."
}
...