Configure Alarm Procedure (alarmProcedure) records

Alarm Procedure (alarmProcedure) records are stored in the Operational Procedures (alarmProcedure) table and are created and edited using the fields in the alarmProcedure Row Edit dialog box within the Advanced Database Editor (ADE). For more information on the ADE and how to create records, refer to the Advanced Database Editor (ADE) Administrator documentation.

To configure the alarmProcedure record

1. In ADE, select View > Alarm.

2. Do one of the following:

   • Select the plus icon (+) to expand the alarmProcedure table.

   • Double-click the table row to open the alarmProcedure Table Edit dialog box to create a new record.

     The alarmProcedure Row Details dialog box appears.

     

3. In the Name field, enter the name of the record. The name can be up to 31 characters in length.

   Note: This name is used to identify a specific alarm/procedure mapping.

4. In the Description field, enter a description of the record. The description can be up to 47 characters in length.

   Note: This description is for the procedure that will be shown to the Controller in the easy eXtended Operator Station (ezXOS) procedure list. If multiple alarm/procedure mappings with the same URL are defined, the ezXOS will only show a single procedure to the Controller in the ezXOS. Allowing multiple alarm/procedure mappings for a given procedure ensures you can show the same procedure for events, such as multiple alarm severities.

5. In the URL field, enter the absolute or relative URL for the procedure to be opened. The URL can be up to 255 characters in the length. For information on setting a base URL, refer to Understanding the Alarm Procedure base URL.

   Note: ADE will not validate that the URL entered is valid or that the URL can be accessed from the ezXOS console.

6. Optional: Select Enable Severity Filter to indicate whether procedures matching the Severity Filter value should be included in the list of procedures shown in the ezXOS for a given alarm.

7. Optional: In the Severity Filter dropdown menu, select one of the following:

   • low

   • minor

   • medium

   • major

   • critical

   Note: The procedure will only be shown in ezXOS if the selected alarm has the corresponding severity.

8. Optional: In the Table Name Filter field, enter an optional full or table point name for which the procedure applies. This field can be up to 255 characters in length and may contain wildcard filter criteria (*).

   Note: The Table Name Filter field will default to * when creating a new record.

   For sample entries, refer to the table at the end of this section.

9. Optional: In the Point Name Filter field, enter an optional full or partial point name for which the procedure applies. This field can be up to 255 characters in length and may contain wildcard filter criteria (*).

   Note: The Point Name Filter field will default to * when creating a new record.

   For sample entries, refer to the table at the end of this section.

10. Optional: In the Category Filter field, enter an optional full or partial category for which the procedure applies. This field can be up to 255 characters in length and may contain wildcard filter criteria (*).

    Note: The Category Filter field will default to * when creating a new record.

    For sample entries, refer to the table at the end of this section.

11. Optional: In the Alarm Message Filter, enter an optional full or partial alarm message for which the procedure applies. This field can be up to 255 characters in length and may contain wildcard filter criteria (*).

    Note: The Alarm Message Filter field will default to * when creating a new record.

    For sample entries, refer to the table at the end of this section.

12. Optional: Select Enable Safety Condition Filter to indicate whether procedures matching the Safety Condition Filter value should be included in ezXOS for any given alarm.

13. Optional: In the Safety Condition Filter dropdown menu, select one of the following:

    • NONE

    • SAFETY

    Note: The procedure will only be shown in ezXOS if the selected alarm has been generated with the corresponding condition. The SAFETY condition is true if either the related point is configured as Safety Related, or if the alarm state is configured as a SAFETY state. Refer to Safety points for more information.

14. Select Apply.

The following table details example entries for the Table Name Filter field.

The following table details example entries for the Point Name Filter field.

The following table details example entries for the Category Filter field.

The following table details example entries for the Alarm Message Filter field.