IBM application development naming conventions

Design elements

Naming conventions for design elements.

Table 1. Design element naming conventions
Design element	Naming convention	Example	Label convention	Label example
Module	tri + mixed case, no spaces	triContract	none	n/a
Business Object	tri + mixed case, no spaces	triPurchaseOrder	User readable name for the business object	Purchase order
Publish Names	Composed of one or more fields with combined values that define a unique record.			Note: Control number in the publish name cannot update the record through integration.
Form	[tri +] descriptor + mixed case, no spaces	triPurchaseOrder Or triPurchaseOrderShortForm	User readable name for the user interface	Purchase Order
Association	Create meaningful association strings. Make sure that the association string does not exist already.	Has location `Location For`		Always create forward and reverse associations.

Field names

All field names are in camel case and contain a prefix and suffix. The prefix is ‘tri’ for every field name. The suffix is two capital letters based on field type as described in table 2.

Table 2. Field Type Suffix Examples
Field Type	Suffix	Example
Action button	AB	triLookupGeographyAB
Binary	BI	triOrganizationBI
Boolean	BL	triProcessFlagBL
Business object	BO	triOrganizationBO
Classification	CL	triRollupLocHeadCL
Classification rollup	CR	triBuildingCommonCR
Color	CO	triFabricColorCO
Control number	CN	triControlNumberCN
Date	DA	triEstimatedStartDateDA
Date and time	DT	triActualStartDT
Duration	DU	triMeetingDurationDU
Financial rollup	FR	triCommitedCostsFR
Image	IM	triPortraitIM
Label only(b)	LA	triEnterNameHereLA
List	LI	triYesNoLI
Note	NO	triCommentsNO
Number	NU	triRateNU
Password	PA	triPasswordPA
System read only(c)	SY	triBusinessObjectIdSY
Text	TX	triNameTX
Time	TI	triStartTimeTI
UOM	UO	triAreaUO
URL	UR	triExternalInfoUR

Query report

Query reports have the following pattern:

[BO/Form/Module name] - [Keyword] - [Context]

Table 3. Query report naming
Keyword	Description
BIRT	Query with linked BIRT document
Debug	Query to help isolate data issues
Display	Query to display data in query section
Filter	Filter data for other queries by using association filters
Find	Find the action of a locator or section
Formula	Provide input values for extended formulas
Graph	Reports intended for users
Graphics	Graphics Editor report
GUIMetric	Metric in a form
HGrid	Hierarchical query for nesting queries
Navigation	For use as a navigation item target (replaces manager queries)
Patch	For patch helpers
Portal	For portal section
Report	Report intended for users
Reserve	Calendar/Reserve-based query of data associated with record
Summary	Summary report intended for users
Subquery	For the lowest level of an HGrid query structure
Workflow	For workflow query task

Examples: triReservationInstance - Navigation - My Reservations History Vehicles; triFloor - Find - Active Floors For Design Change Requests; triPeople - Formula - Associated to Current Record as Primary Location

Workflows

Workflows have the following pattern:

[BO/Form/Module name] – [Synchronous / Action] [- PreLoad | PreCreate | OnChange] - [Context]

Synchronous/Action: Synchronous: Indicates a synchronous workflow; Action: Indicates the action that triggers the asynchronous workflow
PreLoad/PreCreate/OnChange: PreLoad: Indicates a PreLoad workflow; PreCreate: Indicates a Pre-Create workflow; OnChange: Indicates an OnChange workflow
Examples: Classification - Synchronous - Permanent Save Validation; Organization - triActivate - Read-Only Dependant Record Update; triCapitalProject - Synchronous - OnChange - RPIM or FRPP Flag

Navigation items

Navigation items have the following pattern:

 [Target Function Type] - [Name] (- [Role] [Level 1 Menu])

Target function type: Description
Builder: Opens any builder tool
External URL: Opens an external URL
Chart: Opens a graphical representation of a query or report
Hierarchical Query: Opens HGRID queries
Hierarchy: Opens any hierarchical objects
Master Detail: Opens a master detail query
Menu Group: No target
Portal: Opens a portal
Landing Page: Opens a landing page
Process Form: Opens a form
Record Add: Opens a form to create a record
Record Count: Navigation items, which belong to the Reminder section
Record Open: Opens a record such as Application Settings
Indicator: Opens metric queries in Performance Indicator section

Name: Short name qualifier
Examples: Record Add – Building Equipment Asset – Maintenance; Menu Group - Setup - Inventory; Landing Page - Manage Requests

Navigation collections

Navigation collections have the following pattern:

[ Role ] - [ Navigation Collection Type ] - [ Name ]

Navigation collection type: Menu: Intended for use as a primary menu; Quick Links: Intended for use in a portal section. Maximum two levels of navigation; Related Links: Intended for use in a portal section. Maximum one level of navigation
Name: Short name qualifier
Examples: triContracts - Quick Links - Requests Reminders; triAssetManager - Quick Links - Home Related Links

Portal sections

Portal sections have the following pattern:

[ Portal Section Type ] - [ Form/BO Name (where applicable) ] - [ Description ] ( - [ Role ] )

Portal section type: Reminders; Indicators; Related Links; External URL; Chart; GIS Map; Hierarchical Query; Process Form; Query; Record Add; Report
Examples: Query - triBuilding - Active Buildings List; Reminders - Space - Space Manager

Portal landing pages

Portal – Used in TRIRIGA Home link: Home - [ Role ] Portal
Examples: Home - Lease Accounting Manager Portal; Home - Inventory Manager Portal
Landing Page – Used in menu item level: [ Level 1 Menu ] - [ Name ] - Default | [ Role ]
Examples: Space - Space Landing Page - Default; Contracts - Contracts Landing Page - Contract Manager

Security groups

Security groups have the following pattern:

TRIRIGA | CUSTOM [ Role ]

TRIRIGA | CUSTOM: Choose TRIRIGA for IBM® Maximo® Real Estate and Facilities roles and CUSTOM for customer-specific roles
Examples: Home - Lease Accounting Manager Portal; Home - Inventory Manager Portal