Family Field Descriptions

Health Indicator Records

This topic provides an alphabetical list and description of the fields that exist for the Health Indicator family, whose records store information that is used to determine the health of assets. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.

This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Sites section of the documentation.


Field	Data Type	Description	Behavior and Usage
Acknowledged	Logical	Indicates whether or not the status of the Health Indicator has been acknowledged.	When this field is set to: True, the status of the Health Indicator record has been acknowledged. False, the status of the Health Indicator record has not been acknowledged.
Alert Level	Number	Indicates the status of the Health Indicator record.	If the Meridium.AHI.Service.exe.config file has been configured properly, this value is populated automatically by the Asset Health Indicator service with one of the following values: 0 (zero): Indicates that the Health Indicator record meets the Normal status criteria. 1: Indicates that the Health Indicator record meets the Warning status criteria. 2: Indicates that the Health Indicator record meets the Alert status criteria. 3: Indicates that no readings have yet been processed by the Asset Health Indicator service. This field is populated by the MI_AHM_STATUS system code table and is not displayed on the baseline Health Indicator datasheet.
Description	Character	A description of the Health Indicator record.	N/A
Last Numeric Reading Value	Numeric	The most recent reading value associated with the health indicator.	The Asset Health Indicator service populates this field with the reading value from the most recent reading source record. This field is used only for numeric health indicators.
Last Char Reading Value	Character	The most recent reading value associated with the health indicator.	The Asset Health Indicator service populates this field with the reading value from the most recent reading source record. This field is used only for character health indicators.
Lower Level 1 Alert Lower Level 2 Alert Lower Level 3 Alert	Character	For health indicators without a source, determines the status of readings that are associated with this Health Indicator record.	These fields are used only for health indicators without a source (e.g., health indicators created via Policy Designer). For health indicators with a source (e.g., a Measurement Location record), the limit values defined in the source record are used instead.
ML Type	Character	For Health Indicator records whose primary source records are Measurement Location records, indicates the type of data stored in the associated secondary source records (Reading records).	On the datasheet, this field appears as a list that contains the values Character and Numeric.
Name	Character	The health indicator name.	N/A
Upper Level 1 Alert Upper Level 2 Alert Upper Level 3 Alert	Character	For health indicators without a source, determines the status of readings that are associated with this Health Indicator record.	These fields are used only for health indicators without a source (e.g., health indicators created via Policy Designer). For health indicators with a source (e.g., a Measurement Location record), the limit values defined in the source record are used instead.

Health Indicator Mapping Records

This topic provides an alphabetical list and description of the fields that exist for the Health Indicator Mapping family, whose records are used to determine how values will be mapped from health indicator source records to the Health Indicator records that they are used to create. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.

This family is not enabled for site filtering, which means that records in this family can be accessed by any user with the appropriate license and family privileges. For more information, refer to the Sites section of the documentation.


Field	Data Type	Description	Behavior and Usage
Asset to Source Relationship Family ID	Character	The relationship family used to link the Equipment record to the health indicator source record.	The list in this field contains all Relationship families delivered in the baseline database. This field is required.
Description	Character	The purpose of the Health Indicator Mapping record.	This value is not used when mapping data from health indicator source records to Health Indicator records.
Family ID	Character	The family caption of the health indicator source family.	The list in this field contains all families that are successors to the Health Indicator family through the Health Indicator Has Source relationship.
Include as Health Indicator Source Field	Character	Identifies a Boolean field in the health indicator source family that is used to determine whether a specified health indicator source is used to create health indicators.	This field is optional. The list in this field contains fields that are stored in health indicator source records. If the source does not contain a field that specifies inclusion or exclusion as a health indicator source, inclusion or exclusion of that source is tracked by Asset Health Manager.
List of Values Field	Character	The field in the health indicator source family that specifies the values that are valid to be entered into reading source records. For example, Measurement Location records (health indicator source records) can accept either numeric or character values. If they are configured to accept character values, the Allowable Values field in the Measurement Location record stores values that are valid to be entered in the Reading records (reading source records) to which it is linked.	The list in this field contains fields that are stored in health indicator source records.
Mapping Type	Character	The type of data that will be evaluated in the health indicator source record to determine the status of the Health Indicator record.	The list in this field contains the values Character and Numeric.
Reading Date Field	Character	The field in the reading source family that contains the date associated with a reading.	The list in this field contains fields that are stored in reading source records.
Reading Family ID	Character	The reading source family that contains the value that the APM rule logic will use to determine the status of the Health Indicator record.	The list in this field contains all families that are successors to the health indicator source family through any relationship.
Reading UOM Field	Character	The unit of measure that is associated with the reading source record.	The list in this field contains fields that are stored in reading source records.
Reading Value Field	Character	The field in the reading source family that contains the reading value that the APM rule logic will use to determine the status of the Health Indicator record.	The list in this field contains fields that are stored in reading source records.
Source Name Field	Character	The field in the health indicator source family whose value will be mapped to the Name field in the Health Indicator record that is created.	The list in this field contains fields that are stored in health indicator source records.
Target Field	Character	This field is not currently used.	N/A
Type Field	Character	The field in the health indicator source family that indicates the type of reading that is associated with a health indicator source record.	When a new entity or relationship record is added to the database, the Asset Health Indicator service compares the contents of the specified Type Field to the value in the Type Value field. If the values match, a Health Indicator record is created automatically using this Health Indicator Mapping record. If the Type Field and Type Value fields are not specified, a Health Indicator record will be created for each Health Indicator Mapping record that is configured for the health indicator source family.
Type Value	Character	The value that the specified Type Field must contain in order for this Health Indicator Mapping record to be used.	See Type Field.