Concepts

Tasks

Reference

Object Model Diagram Overview

The APM object model defines:

•	The types of business objects in the system (such as assets and work orders)

•	What properties the objects have

•	How the objects are related to each other

 

Object model diagrams allow you to explore the APM systems and classes and provide a graphical representation of their relationships to each other. If you will be customizing the system or creating reports, table configurations, or performance indicators, you can use model diagrams to learn about the classes and relationships that you are working with. The diagrams can also be copied into other applications or printed for a hard copy reference.

Object model diagrams can be as simple or complex as needed. Below is a simple diagram depicting the Asset class and its relationship to Asset Status and Site, as well as its base class:

This topic outlines the tool bar and legend of the object model diagrammer.

Tool Bar

The Object Model Diagram includes an easy reference tool bar with the following options:

 

Icon	Name	Click this button to...
	Print	Display the print dialog which allows you to select the printer, print range, and number of copies and send the current object model diagram to the specified printer.
	New Diagram	Open a new object model diagram.
	Show Class	Display the Show Class dialog in which you must select the System and then a Class from within that system, to display in the object model diagram.
	Add Note	Add a note to the object model diagram. Note: Notes are not attached to any object on the diagram and can be placed anywhere within a diagram, therefore it is recommended to place the note near the object that it references.
	Zoom In	Zoom in to view focus on an area of the object model diagram.
	Zoom Out	Zoom out to view more of the object model diagram.
	1:1 Zoom	View the object model diagram at normal size.
	Copy to Clipboard	Copy the selected object(s) to the clipboard, for pasting into other applications. If no object is selected, all objects in the diagram are copied.
	Undo	Erase the last change performed and revert the diagram to its previous state.
	Redo	Reverse the last Undo operation performed on the diagram.
	Show Types for Attributes and Relationships	Toggle to include or remove the type of each attribute and relationship along with its name. For example, turning this option on identifies the “Component is installed” attribute as a “BOOL” (boolean) type of attribute. The default for new object model diagrams is “Off”.

Legend

Each type of object and relationship is identified differently in an object model diagram. Objects in the object model diagram can be quickly identified knowing what different colors, icons, and graphics represent.

The following is a legend for object model diagram objects:

•

Classes

•	Inherited Members

•	Relationships

•

Notes

Classes

Object model diagrams differentiate APM base classes and user-defined custom classes by using a different header color. APM base classes have blue headers, while custom classes have an orange header. For example:

 

Class	Example
APM
Custom

A class can be expanded to display its base class, attributes, relationships, methods, and views components. For example:

Similarly, details of attributes, relationships, methods, and views of a class are displayed by expanding each component header. Below is an example of the asset activity report class with its Relationships component expanded:

Connections between a class and its base class are denoted via a green, dotted arrow. For example:

Inherited Members

Attributes, relationships, methods, and views inherited from the base class, are identified in green. For example:

Relationships

In object model diagrams, an APM relationship is represented by an oblong shaped box with red text, outlined in blue. Custom relationships are outlined in orange. For example:

 

Relationship Source	Example
APM class
Custom class

When “Show Relationship” is selected, a line joins the two related classes. The arrow denotes the direction of the relationship.

In addition to the line itself, the relationship also indicates if the relationship is one-one or many-many. Each type of relationship is identified by a specific icon. For more information about types of relationships, see Relationship Types. When a relationship is displayed in an object model diagram, either a “1” or a “∞” appears at each end of the relationship, to denote a single or multiple relationship respectively.

The following chart depicts how some of the more common types of relationship are displayed in an object model diagram:

 

Icon	Relationship	Example
	Contains one
	Contained by
	Hierarchy parent
	In Hierarchy of
	Owns many
	Referenced by
	References one
	References many
	Scopes many

Notes

Notes can be added to an object model diagram to add supporting comments or information, and appear as a yellow box that can be resized as needed. For example:

Note: Notes are not directly connected to objects on the diagram, therefore it is recommended that the note be positioned near the object that it references.