General Reference | On-Premises APM

About Site Filtering in AHM

In Asset Health Manager, users will see only the health information related to assets assigned to their site(s) or that are global records.

Tip: For more information, refer to the Site Filtering section of the documentation.

In most cases, the asset, health indicator source, and health indicator will all be associated with the same site, though it is possible for a health indicator source record to contain global data. For information on configuring this scenario, refer to the AHM Administration section of the help.

Consider an organization that has three sites, Site X, Site Y, and Site Z. Measurement Location A is a global record and is linked to the following two equipment records:

Equipment 1: Assigned to Site X
Equipment 2: Assigned to Site Y

Two Health Indicator records exist for the Measurement Location, one for each piece of equipment.

Scenario 1: User assigned to only Site X

When this user views the Health Summary page, he or she can view Equipment 1, Measurement Location A, and the health indicator associated with Equipment 1. Equipment 2 and the associated health indicator are not visible.

Scenario 2: User assigned to both Site X and Site Y

When this user views the Health Summary page, he or she can view Equipment 1 and 2, Measurement Location A, and the health indicators associated with both Equipment 1 and 2.

Scenario 3: Super User

When this user views the Health Summary page, he or she can view Equipment 1 and 2, Measurement Location A, and the health indicators associated with both Equipment 1 and 2. If any records are assigned to Site Z, he or she would be able to see the related data for those records as well.

About Health Indicator Sources

Health Indicator records are associated with health indicator source and reading source records that contain the limit values and reading values, respectively, that are compared to determine the status of the health indicator. One health indicator may exist for each health indicator source record associated with a piece of equipment. Reading source records are then used to provide the most recent reading value to the health indicator.

The following table summarizes the records that are configured as sources in the baseline APM database.


Health indicator source record	Corresponding reading source
GE Tag	GE Tag Event records
Measurement Location	Reading records
Content Map	The most recent reading available from the OT Source.
KPI	KPI Measurement records
None (e.g., health indicators created via Policy Designer)	Health Indicator Value records

The following table summarizes the fields that define health indicator limit values for each of the baseline health indicator source records.


Health indicator source record	Fields Containing Limit Values
GE Tag	Upper and lower level limit fields in the GE Tag record.
Measurement Location	Upper and lower level limit fields in the Measurement Location record.
Content Map	Upper and lower level limit fields in the Content Map record.
KPI	Target and Critical fields in the KPI Measurement record associated with the KPI record. In KPI records where a low value is good, the Target value represents the upper level 1 limit and the Critical value represents the upper level 2 limit. In KPI record where a high value is good, the Target value represents the lower level 1 limit and the Critical value represents the lower level 2 limit.
None	Upper and lower level limit fields in the Health Indicator record.

The following table summarizes the fields in each reading source record that contain the latest reading value, which the Asset Health Indicator service copies into either the Last Numeric Reading Value or Last Char Reading Value field in corresponding Health Indicator records.


Reading source	Field Containing Reading Value
GE Tag Event record	Type
Reading record	Reading Value Character Reading Value Numeric
Reading from the OT Source	N/A
KPI Measurement record	Actual
Health Indicator Value record	Value (Numeric)

AHM Data Model

The following diagram shows how the families used in Asset Health Manager are related to one another.

Note: In the diagram, boxes represent entity families and arrows represent relationship families that are configured in the baseline database. You can determine the direction of each relationship definition from the direction of the arrow head: the box from which the arrow originates is the predecessor, and the box to which the arrow head points is the successor.

Note that the Health Indicator Source box in this image does not represent a family with the caption Health Indicator Source. Instead, it represents a family containing a record that will be linked to a Health Indicator record. In the APM baseline database, Health Indicator records can be linked to the following types of records through the Health Indicator Has Source relationship:

Measurement Location
Content Map
KPI
Health Indicator

If desired, you can configure this relationship definition to include other families as successors to the Health Indicator family.

Each Health Indicator record is also associated with readings linked to these health indicator source records. Refer to the topic About Health Indicator Sources for details.

AHM Security Groups

The following table lists the baseline Security Groups available for users within this module, the baseline Roles to which those Security Groups are assigned, and the OT Connect groups that are assigned to the Health Roles to support the Health and OT Connect integration.

Note: For more information on the privileges related to OT Connect families and the workflows that Health users must have access to, refer to the OT Connect documentation.

Important: Assigning a Security User to a Role grants that user the privileges associated with all of the Security Groups that are assigned to that Role. To avoid granting a Security User unintended privileges, before assigning a Security User to a Role, be sure to review all of the privileges associated with the Security Groups assigned to that Role. Also, be aware that additional Roles, as well as Security Groups assigned to existing Roles, can be added via Security Manager.


Security Group	Roles
MI AHI Administrator	MI Health Admin MI Strategy Admin MI Strategy Power
MI AHI User	MI Health Power MI Health User MI Strategy Admin MI Strategy Power MI Strategy User
MI AHI Viewer	None
MI OT Connect Administrator MI OT Connect User	MI Health Admin
MI OT Connect Viewer MI Content Template Viewer	MI Health Power MI Health User

The baseline family-level privileges that exist for these AHM Security Groups are summarized in the following table.


Family	MI AHI Administrator	MI AHI User	MI AHI Viewer
Entity Families
Checkpoint Task	View, Update, Insert	View, Update, Insert	View
Event Mapping	View, Update, Insert, Delete	View	View
Health Indicator	View, Update, Insert, Delete	View, Update	View
Health Indicator Mapping	View, Update, Insert, Delete	View	View
Health Indicator Value	View, Update, Insert, Delete	View	View
KPI	View	View	View
KPI Measurement	View	View	View
Measurement Location	View	View	View
Measurement Location Template	View	View	View
OPC Reading Note: This family is obsolete from V4.4.0.0.0.	View	View	View
OPC System Note: This family is obsolete from V4.4.0.0.0.	View	View	View
OPC Tag Note: This family is obsolete from V4.4.0.0.0.	View	View	View
Operator Rounds Allowable Values	View	View	View
Policy	View	View	View
Policy Event	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Policy Instance	View	View	View
Reading	View	View	View
Recommendation	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Timestamped Value	View, Update, Insert, Delete	View	View
Relationship Families
Has Checkpoint	View	View	View
Has Child Hierarchy Item (Deprecated)	View, Update, Insert, Delete	View	View
Has Consolidated Events	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Health Indicators	View, Update, Insert, Delete	View	View
Has OPC Reading Note: This family is obsolete from V4.4.0.0.0.	View	View	View
Has OPC Tag Note: This family is obsolete from V4.4.0.0.0.	View	View	View
Has Readings	View	View	View
Has Recommendations	View, Update, Insert, Delete	View, Update, Insert, Delete	View
Has Timestamped Value	View, Update, Insert, Delete	View	View
Health Indicator Has Mapping	View, Update, Insert, Delete	View	View
Health Indicator Has Source	View, Update, Insert, Delete	View	View

AHM URLs

There is one URL route associated with Asset Health Manager: health. The following table describes the various paths that build on the route, and the elements that you can specify for each.

Tip: For more information, refer to the URLs section of the documentation.


Element	Description	Accepted Value(s)	Notes
health: Opens the Health Summary page displaying health indicators at the Home level of the hierarchy.
health/overview: Opens the Asset Health Manager Overview page.
health/asset/<EntityKey>/<SectionName>: Opens the Health Summary page.
<EntityKey>	Specifies the level of the asset hierarchy for which you want to view health information.	Any Entity Key that corresponds to an asset in the asset hierarchy.	N/A
<EntityKey>		0	Displays the Home level of the asset hierarchy.
<SectionName>	Specifies the type of health information you want to view.	indicator	Displays the Indicators section.
		event	Displays the Events section.
		policy	Displays the Policies section.
		risk	Displays the Risks section.
health/indicator/<IndicatorEntityKey>/<WorkspaceName>: Opens the Health Indicator page.
<IndicatorEntityKey>	Specifies the health indicator whose details you want to view.	Any Entity Key that corresponds to a health indicator in the asset hierarchy.	N/A
<WorkspaceName>	Specifies the type of health indicator information you want to view.	trend	Displays the Trend Chart workspace.
		readings	Displays the Reading History workspace.
		configuration	Displays the Configuration workspace.

Example URLs


Example URL	Destination
#health -or- #health/asset/0/indicator	The Indicators section of the Health Summary page for the Home level of the Asset Hierarchy.
#health/asset/6425187457/policy	The Policies section of the Health Summary page for the specified asset.
#health/indicator/64253092336/trend	The Health Indicator page, displaying a graph of readings associated with the specified health indicator.
#health/indicator/64253092336/configuration	The Health Indicator page, displaying source information for the specified health indicator.

AHM System Code Tables

The following table lists the System Code Tables that are used by Asset Health Manager.


Table ID	Table Description	Function
MI AHM STATUS	Health Indicator Status	Populates the Alert Level field in Health Indicator records.
MI AHM TIME	AHM Search Time Range	Populates the Time Range list in the filter for the Asset Health Manager Overview page.
MI HIER ITM GROUP	Hierarchy Item Groups	This table is no longer used.

Access Health Indicator Details

Procedure

On the Health Summary page, in the This Asset subsection, select the check box next to a health indicator, and then select .

-or-

On the Health Overview page, select a health indicator name in one of the overview lists (i.e., No Status, Normal, Warning, or Alert).

The <Health Indicator Name>:<Description> page appears. The date and time that the health indicator was last updated appears under the page heading.

If the health indicator has numeric readings, the Trend Chart workspace appears, which contains a trend chart showing how the health indicator readings have fluctuated over time. If the health indicator has character readings, the Reading History workspace appears instead. See Step 2.
Select the Reading History tab.
The Reading History workspace appears, which displays the status, timestamp, and value of each reading for the selected health indicator.
Note:
- If the health indicator source is a Content Map record, the reading values displayed are directly from the process historian.
- By default, rows are sorted by the Date/Time column, with the most recent reading at the top.
Select the Configuration tab.

The Configuration workspace appears, which displays the name, description, and limit values for the health indicator. You can optionally modify some of these values.

What To Do Next

Access or Modify Health Indicator Source Information

Acknowledge Alerts and Warnings

Procedure

Access the Health Summary page.
In the This Asset subsection, select the check box next to each health indicator whose status you want to acknowledge.

Note: If you select health indicators with no readings, with a normal status, or whose status has already been acknowledged, only the health indicators with warning or alert statuses will be acknowledged.
Above the grid, select .
The Acknowledge window appears.
Optionally, in the Acknowledgment Note box, enter comments.
If you want the acknowledgment to remain valid only until a new reading is added, select the One Time check box.

-or-

If you want to set an expiration date for the acknowledgment, select the Valid Until check box, and then select an expiration date from the calendar.
Select Create.

Results

The icon is added to the Acknowledgment column to indicate that the status of the health indicator will count as normal until a new reading is added or until the acknowledgment expires, depending on your selection.

Note: The status icon and the gauge displayed for the individual health indicator will sill show the actual warning or alert status.

What To Do Next

Access, Modify, or Revoke an Acknowledgment