### Customizing alarms Each alarm source has an alarm message, category, and template defined in the EIKON® application. You can change messages and categories in the WebCTRL® application.
Click for details below Alarm messages Alarm categories If you upgraded alarms from v2.0 or earlier
#### Alarm messages An alarm message is the information that appears on the Alarms page View tab for an alarm. An alarm message can consist of 3 parts. You can edit Text only at the alarm source in the EIKON® application. Prefix and Details are hierarchical. They apply at the location where they are added and to all its children. For example, you could enter Details at the system level to show the acknowledge time for alarms in the HVAC Critical category. The acknowledge time would then be in any HVAC critical alarm message in the system. NOTE An alarm action can have a different message from the alarm message seen on the View tab. To edit the message for a particular alarm action, see Setting up alarm actions. To edit the message for an alarm source On the Geographic tree, select the alarm source (microblock). Click Alarms, then select the Messages tab. NOTE Sample Alarm Message and Sample Return Message show the messages as they are currently defined. Do the following as needed: Edit the Text for Alarm or Return. You can add live data to the text by selecting field codes from the Append Field Code list. Click the Edit button to edit Message Prefix or Message Details. In the drop-down list to the right of Message formation, select Add new prefix to beginning of message or Add new details to end of message, then click Add. Click Accept. To add a Prefix or Details for multiple alarm sources On the Geographic or Network tree, select the area, equipment, or controller containing the alarm sources. Click Alarms, then select the Messages tab. In step 1, select the categories that contain the alarm sources whose messages you want to edit. NOTE In step 1 and step 2, Ctrl+click, Shift+click, or both to select multiple items, or check Select All. In step 2, select the alarm sources. In step 3, select Add new prefix to beginning of message or Add new details to end of message. Click Add. Type text and add field codes as needed. Click Accept.
#### Alarm categories Alarm categories sort related alarm sources and their alarms into groups such as HVAC Critical and Access Control General. Alarm categories let you: View, acknowledge, or delete selected categories of alarms received by the WebCTRL® application Assign alarm actions to selected categories of alarm sources Set up alarm sources in selected categories Each alarm source is assigned to an alarm category in either the EIKON® application or in the WebCTRL® interface. See "To use custom alarm and schedule categories" in EIKON® Help. In addition to the default alarm categories in your system, you can create custom categories if needed. If you create a custom category in the EIKON® application, you must create the same category in the WebCTRL® interface. The Reference Name must be identical in both applications. To assign alarm sources to a category in the WebCTRL® interface On the Geographic or Network tree, select the area, equipment, or controller containing the alarm sources. Click Alarms, then select the Category tab. In step 1, select the category that currently contains the alarm sources. NOTE In step 1 and step 2, Ctrl+click, Shift+click, or both to select multiple items, or check Select All. In step 2, select the alarm sources whose category you want to change. In step 3, select a category from the drop-down list, then click Change. Click Accept. To add a custom alarm category On the System Configuration tree, click to the left of Categories. Click Alarm. Click Add. See table below. Click Accept.
Field | Notes
--- | ---
Reference Name | Must be unique in the database, be lowercase, and not contain any spaces. This name must be identical to the name of the custom alarm category that you added in the EIKON® application.
Icon | Type`/_common/lvl5/graphics/event_categories/<file_name>.gif`, replacing <file_name> with the name of the icon file you want to use. The event_categories folder contains the following alarm icons:
| Icons used in the WebCTRL interface: | Icons available for custom categories:
| *Represents critical, maintenance, general, or closed NOTE You can create your own 24 x 24 pixel icon (.gif or .png) and store it in the event_categories folder. However, your custom file will not be transferred during a WebCTRL® upgrade, so you will need to copy the file to the new install directory after the upgrade.
#### If you upgraded alarms from v2.0 or earlier All v2.5 and later alarms use one template called Universal. This template lets you define your alarm message text, the critical setting, and the required acknowledgments at the alarm source in the EIKON® or WebCTRL® application. Templates in upgraded systems If you upgraded your system from v2.0 or earlier, the alarm sources retained their existing templates and existing alarm settings. If the existing alarm sources contain little or no customization to the alarm settings, Automated Logic® recommends that you change all of the alarms to use the Universal template. If the alarm sources had customized alarm settings, continue using the existing templates. To assign a different template to alarm sources PREREQUISITE The Alarms Template tab must be visible. If it is not, on the System Configuration tree, select Privilege Sets, then check Maintain Alarm Templates. On the Geographic tree, select the piece of equipment containing the alarm sources to be changed. Click Alarms, then select the Template tab. Follow the 3 steps on the screen. NOTE Use Ctrl+click, Shift+click, or both to select multiple items. Click Change. Click Accept. TIP To change all alarms in the system simultaneously, go to the system level and then select all categories and all alarm sources on the Templates tab. To add an alarm template On the System Configuration tree, select Alarm Templates. Click Add. Select Source-based (a v2.5 template) or Stand-alone (a pre-v2.5 template), then click OK. Edit the template fields as needed. See table below. Click Accept.
Field | Template Type | Notes
--- | --- | ---
Reference Name | All | Must be unique in the database, be lowercase, and not contain any spaces. This name must be identical to the name of the template in the EIKON® application.
Display Name | All | The name that will appear in the WebCTRL® interface for this template.
Alarm Message | Source-based | The message text displayed on the View tab or in the alarm action when an Alarm requires acknowledgment.
Return Message | Source-based | The message text displayed on the View tab or in the alarm action when a return-to-normal requires acknowledgment.
Fault Message | Source-based | The message text displayed on the View tab or in the alarm action when a Fault requires acknowledgment.
Critical | Stand-alone | Select if this is a template you will use with a critical alarm.
Acknowledgement Required | Stand-alone | Select which alarm states require an acknowledgment.
Out of Range | Stand-alone | Analog inputs and outputs that have low and high limit alarm properties. Click to the left of Out of Range to make changes to the alarm messages displayed on the Alarms page > View tab. Short text is the message displayed when the alarm is not expanded. Long text is the message displayed when the alarm is double-clicked and expanded.
Change of State | Stand-alone | Binary inputs and alarm microblocks. See Out of Range above to change the alarm messages.
Copy Field Code to Clipboard | Stand-alone | To add a field code to any of the message text fields: Select a field code to copy it. Click in the appropriate text field where you want the field code. Press Ctrl+V to paste the field code.