Adding Alert Types

You perform the following procedure to add alert types directly on a template object page. The alert type definition allows you to define the alerts that are based on equipment error codes. The definition can also define associations with an indicator and possible failure modes. The association with failure mode data allows you to identify associations like instructions.

Prerequisites

To update a template, your user ID must have the scopes TEMPLATE_DELETE or TEMPLATE_EDIT assigned.
To view a template, your user ID has the scope TEMPLATE_READ assigned.
You have identified the template that you want to update.

Context

In the Template Explorer window, to add new alert type, select the New button and perform the following tasks:

Procedure

In the Template Explorer window, enter the values for the fields as described in the following table:

Field	Description
Alert Type ID	Define a unique alphanumeric ID for the alert type. Note No spaces allowed in the ID. Only the following characters are supported: Uppercase and lowercase alphabets a through z and A through Z. Numeric digits 0 through 9 Punctuation marks underscore (_), hyphen (-), colon (:), and full-stop (.) Maximum number of characters allowed is 29 You cannot change the ID of the alert type once created.
Category	Select an alert category from the dropdown list: Environment Health Equipment Operation Process Safety Other
Description	Enter an appropriate description that describes the alert type. Note Maximum number of characters allowed is 255.
Severity	Select the severity of the alert type: Information (1) Warning (2) Error (3)
Indicator	Assign indicator to the alert type by selecting from the list.
Origin	This allows you to differentiate between the alert type that is defined for the alert arising from an equipment. Select from the dropdown: Equipment: On selecting, you can enter an error code (this is optional) Rule: Value should be used for the alert type defined for rules.
Error Code	Enter an error code. This field is available only if you select Equipment as origin. Note Maximum number of characters allowed is 32.
Failure Modes	Assign failure modes to the alert type by selecting from the list. Note Multiple failure codes can be assigned to an alert type.

Choose Save.

Note You cannot create same alert type with the same ID.

If corresponding external ID is not populated, IoT Application Enablement replication of alert type has failed. In such a scenario, edit and save the alert type that will trigger the IoT replication.

Results

In the Alert Type window, the newly created alert type displays. You can search and sort, group by alert types, filter, and export details in an excel.

Editing Alert Type

Using the Edit option, you can edit an existing alert type or newly creating alert type. For this, click the alert type you want to edit. You can also reassign failure modes to the alert types. To view the instructions assigned with the failure mode, click the number visible within the <Instructions> column.