Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ InTouch HMI

Create an alarm record mapping file

  • Last UpdatedApr 08, 2025
  • 4 minute read

You must map the alarm records of a hot backup pair whenever the primary and backup alarm providers are running different applications. Alarm record mapping establishes a correspondence between dissimilar alarm records of the primary and backup providers. For example, you can map alarm records based upon their assigned InTouch tag names. Although their names may be different, the alarm records are logically consistent between the two provider alarm repositories.

Note: Creating an alarm record mapping file is unnecessary if both the primary and backup providers are running the same application. If no mapping file is provided, the Distributed Alarm system assumes the primary and the backup providers are running the same applications with the same alarm records.

Mapping enables alarm acknowledgements to be synchronized between providers running different applications. When the Distributed Alarm system acknowledges an alarm on a provider, it also knows which alarm to acknowledge on the other provider.

The following figure shows alarm record mapping between the two providers of a hot backup pair. In this example, the A and B alarm records of the primary provider are mapped to the corresponding alarm records of the backup provider, MA and MB.

Graphics describing alarm record mapping between the two providers of a hot backup pai

The Hot Backup Manager imports the alarm record map from a comma separated values (CSV) file that you create with Microsoft Excel or a text editor like Notepad. The mapping file includes an ordered list of alarm record fields that associate the corresponding alarm records of the primary and backup providers.

You must specify tag alarm record fields as the headers of the mapping file. The order of the headers within the file must match the alarm record fields shown from the Select Key Fields dialog box. The figure below shows the column headers of an Excel file that match the order of alarm record fields of the Select Key Fields dialog box.

Column headers of an Excel file that match the order of alarm record fields

You can create a mapping file that only includes the selected headers of alarm field records used to generate mapping keys. The figure below shows an Excel file that includes only the Name, Class, and Type headers. When you add headers, their order must always match the order of alarm record fields of the Select Key Fields dialog box.

Excel mapping file

Specify the alarm field records of the primary provider in the left set of columns. Likewise, specify the same records of the backup provider in the right set of columns.

Mapping File Column Header

Values Assigned to Alarm Field Records

Group

Name of the alarm group in which the tag has been assigned. An alarm group name cannot contain a blank space.

Name

Name of the tag whose alarm records are mapped. A tag name cannot contain a blank space.

Class

Class of alarm assigned to the tag.
Possible Class values are:

  • VALUE for a value alarm.

  • DEV for a deviation alarm.

  • ROC for a rate of change alarm.

  • DSC for a discrete alarm.

Type

Type of alarm condition associated with an alarm class.

  • LOLO, LO, HI, and HIHI for a value alarm

  • MinDev and MajDev for a deviation alarm

  • ROC for a rate of change alarm

  • DSC for a discrete alarm

Priority

Priority assigned to an alarm condition. Priority must be a number from 1 to 999.

Value

See the following notes.

Limit

See the following notes.

Comment

See the following notes.

Value, Limit, and Comment columns:

  • The "Value" and "Limit" column values can be anything other than Null, when the "Class" or "Type" values for that particular record in that particular node are not known.

  • The "Value" and "Limit" column values can accept only 1234567890.-+eE characters when the Class value for that particular record in that particular node is known as Value, Dev or ROC.

  • The "Value" and "Limit" column values can accept only 1234567890.-+eE characters when the Type value for that particular record in that particular node is known as LOLO, LO, HI, HIHI, MinDev, MajDev or ROC.

  • The "Value" and "Limit" column values can be anything other than Null, when any one of the "Class" or "Type" values for that particular record in that particular node is known as DSC.

  • The Comment column values have no limitations.

  • All records of the mapping file should be unique. The Hot Backup Manager skips any duplicate records during the import process. You can see details after the import process is completed.

You can combine the field values of alarm records - such as Group, name, and Priority - to generate a "composite mapping key" that uniquely identifies alarm records.

An InTouch Alarm Provider equates the "Name" field to the name of the tag that generated the alarm. Therefore, when given hot backup pair, a mapping key can be generated using the combination of the alarm group name and the tag name.

For example:

Provider Node

Backup Node

$System!TagA

$System!TagB

If a provider has a name field and comment field together as a unique field then the mapping key can be a combination of name and comment.

Provider Node

Backup Node

tagA!CommentA

tagB!CommentB

This could be true for any other field combination for a third provider.

TitleResults for “How to create a CRG?”Also Available in