Design element names
Use the naming conventions in the table when you create your own objects. Do not using these naming conventions when you modify as-shipped IBM® Maximo® Real Estate and Facilities objects.
| Design element | Naming convention | Example name | Label convention | Label example |
|---|---|---|---|---|
| Module | cst + mixed case, no spaces | cstMyModule | none | n/a |
| Business object | cst + mixed case, no spaces(a) | cstMyBO | User readable name for the business object | Purchase Order |
| Form | [cst +] business object name + mixed case, no spaces(b) | cstMyForm | User readable name for the Graphical User Interface | Short Form Purchase Order |
| Form sections | cst + mixed case, no spaces | cstGeneral | User readable name for section | General |
| Smart/query section | [cst +] Business object name + mixed case, no spaces(d) | cstOrganizationBillTo | User readable name for section | Bill To |
| Field | cst + mixed case, no spaces + field type
suffix (See the table for field type suffixes) |
cstAssignedFullNameTX | User readable name for field | Assigned Full Name |
| Navigation collection | cst + mixed case, no spaces(c) | cstPurchasing | User readable name for the navigation collection, suitable for a menu item | Purchasing |
| Navigation item | cst + mixed case, no spaces | cstAsset | User readable name for the navigation item, suitable for a menu item | Asset |
| Portal | cst + Role – Type Sequence Types: Standard – Standard Company portal with specific report list for this role Graphic – Specific Portal for this role including graphs, queries, and report list for this role. Maximo Real Estate and Facilities Performance Management for WPM Portals |
Maximo Real Estate and
Facilities Contact Center Agent –
Standard Contact Center Agent – Graphic 2 |
||
| Portal section | cst + Type + "-" + Business Object name –
description Types: Graph – Query section pointed to a graph Query – Query section pointed to a query Reports – Query List URL – External Notes: CrystalGraph (portal section type = Query) CrystalReport (portal section type = Query) Manager – (portal section type = Manager) for WPM-Key Metrics MetricSection – (portal section type = Query) PortalQuerySwitch-(portal section type – Query) – query with dropdown of other query/reports. QuickAdd – (portal section type = Quick Add List) Shortcut – (portal section type= Shortcut List) |
cstGraph – triBuilding Portfolio by Tenure (Pie
Graph) cstReports – Project Team Member cstURL – My Calendar Examples: triManager – WPM Move Planner triMetricSection – WPM Move Planner triMetricSection – WPM Move Planner triPortalQuerySwitch – WPM Project Team Member triQuickAdd – Performance Management – Move Planner triShortcut – Performance Management – Move Planner |
Display on Portal |
Project Team Member Reports My Calendar |
| Query, Report, Graph | cst + "-" + Form Name (or Business Object Name or
Module Name if Report/Graph) - Keyword - Context(e) Or if the query references a new or customized object: Form Name (or Business Object Name or Module Name) - Keyword - Context (See the table for keywords) |
cst-triPurchaseOrder - Workflow - POs for Current Year
cstMyForm - BIRT - Employee Contact Details |
Form Label (or Business Object Label or Module
Label) - Context (What the report displays to user) |
Employees - All Associated Active Employees |
| Security group | Customer Name + Role | Maximo Real Estate and Facilities Contact Center Agent | none | n/a |
| State family | cst + Context (mixed case, no spaces) | cstActionItem, cstData, cstDocument | none | n/a |
| State family state | cst + (Action) mixed case, no spaces(f) | cstDeleted | User readable name for the Action(g) | Deleted |
| State family action | cst + (Action) mixed case, no spaces | cstFinalDelete | User readable name for the Action (Transition) | Final Delete |
(a) Business object names cannot be changed once the business object is published.
(b) This is the system name for the form. Each business object can have many forms.
(c) This is the system name for the navigation collection. Each business object can be in multiple navigation collections.
(d) A section name cannot exceed 30 characters, so there may not be enough space for the full business object name. Choose a name that reflects the intent of the section.
(e) No spaces between the “cst-” and the tri object name. Context should include filters to states, data filters, association filters, if editable etc. For queries tied to a $$RECORDID$$ or other platform key, make sure to include the type of context record in the context part of the name. The ID of the report should be CUSTOM, or use your company’s numbering standards for reports. SYSTEM is reserved for Maximo Real Estate and Facilities delivered reports. Keywords are described in the table for keywords.
(f) The 'null' state is the exception to this rule. A record is in a null state before it is created or permanently deleted. The system then permanently removes the records in the null state after a configured time period with the Platform Maintenance Scheduler (Cleanup Agent).
(g) State Transitions should not be labeled Cancel.