Managing Alarm Metadata¶
Alarm metadata consists of metadata relations, alarm groups, alarm severities, alarm types, and alarm tags. It is used to categorize alarm rules and define their priorities.
Note
To quickly initialize the application, you can contact the O&M personnel to copy the alarm metadata of an existing OU to the current OU.
Prerequisites¶
Before starting, make sure the current account has been assigned the menu group containing Alarm Metadata. If not assigned, contact the OU administrator.
Managing Metadata Relations¶
Metadata relations define mappings between site types and alarm groups. They are of the following two types:
Public: Platform-provided mappings between generic industry site types and alarm groups, such as wind power, photovoltaic, and energy storage scenarios. Public metadata relations support viewing only.
Private: Mappings for user-defined scenarios, such as buildings and campuses. Private metadata relations support creating, editing, and deleting.
Creating Private Metadata Relations¶
Select Alarm Metadata from the left navigation pane, and select the Metadata Relation tab.
Select Private, and then select New Metadata Relation.
In New Metadata Relation, enter the following information:
Site Type Identifier: Enter the unique identifier for the site type.
Alarm Group Identifier: Enter the unique identifier for the alarm group.
(Optional) Application ID: The application’s
appAccessKey. Select Add Application ID to add one or more application IDs. You can find the application ID in Application Registration.
Select Save.
Editing Private Metadata Relations¶
Select Alarm Metadata from the left navigation pane, and select the Metadata Relation tab.
Select Private, and then select Edit in the target metadata relation row.
In Edit Metadata Relation, update the Site Type Identifier, Alarm Group Identifier, or Application ID, and then select Save.
Deleting Private Metadata Relations¶
Select Alarm Metadata from the left navigation pane, and select the Metadata Relation tab.
Select Private, and then select Delete in the target metadata relation row.
In Delete This Item, select Confirm. A deleted metadata relation cannot be restored.
Managing Alarm Groups¶
Alarm groups classify alarm severities and alarm types. On the Alarm Group tab, you can view alarm groups available to the current OU. You can view and use only the alarm groups for which you have been granted resource permissions. When you create an alarm trigger rule, alarm groups that you do not have permission for are not displayed as options, which means you cannot create alarm rules based on those groups. To obtain the resource permissions for an alarm group, contact the OU administrator.
Creating Alarm Groups¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Group tab.
Select New Group, and enter the identifier, name, and description for the alarm group in the pop-up window.
Select Save.
Editing Alarm Groups¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Group tab.
Select the Edit button of the target group in the alarm group list, and edit the name or description of the group in the pop-up window.
Select Save.
Deleting Alarm Groups¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Group tab.
Select the Delete button of the target group in the alarm group list.
Select OK in the pop-up window.
Managing Alarm Severities¶
Alarm severity can be used to define how prior and severe an alarm should be, and the color on the notification of the triggered alarm. For example, you can create alarm severities as fault, warning, and note, and set the color as red, yellow, and blue accordingly.
Creating Alarm Severities¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Severity tab.
(Optional) Select New Severity Group, select the corresponding alarm group and select Save to create a severity group. Severity group is the alarm group containing alarm severities, used for the classification of alarm severities.
Select the plus sign icon (+) of the target severity group, and select New Severity.
Enter the identifier, name, and description of the severity, and select the severity level (the color displayed on a corresponding alarm record) in the pop-up window.
Select Save.
Editing Alarm Severities¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Severity tab.
Select the plus sign icon (+) of the target severity group to view the severities in the group.
Select the Edit button of the target severity, and edit name, level, and description in the pop-up window.
Select Save.
Deleting Alarm Severities¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Severity tab.
Select the plus sign icon (+) of the target severity group to view the severities in the group.
Select the Delete button of the target severity, and select OK in the pop-up window.
(Optional) If you need to delete a severity group, select the Delete icon of a group, and select OK in the pop-up window.
Managing ALarm Types¶
Alarm type can be used to indicate why an alarm is triggered. For example, you can create types such as device, operation, and connection.
Creating Alarm Types¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Type tab.
(Optional) Select New Type Group, select the corresponding alarm group and select Save to create a type group. Type group is the alarm group containing alarm types, used for the classification of alarm types.
Select the plus sign icon (+) of the target type group, and select New Type.
Enter the identifier, name, and description in the pop-up window.
Select Save.
Editing Alarm Types¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Type tab.
Select the plus sign icon (+) of the target type group to view the types in the group.
Select the Edit button of the target type, and edit name and description in the pop-up window.
Select Save.
Deleting Alarm Types¶
Select Alarm Metadata from the left navigation pane, and select the Alarm Type tab.
Select the plus sign icon (+) of the target type group to view the types in the group.
Select the Delete button of the target type, and select OK in the pop-up window.
(Optional) If you need to delete a type group, select the Delete icon of a group, and select OK in the pop-up window.