Accessing Alarm Help from the alarm banner
Clicking the
or
button in the alarm banner
enables and disables direct access to Alarm Help from the alarm buttons in the
alarm banner. When direct access is enabled, right-clicking an alarm button
opens Alarm Help for the alarm. When direct access is disabled, right-clicking
does nothing.
Accessing Alarm Help from alarm lists
Alarm lists appear on the
following DeltaV-installed displays: AlarmList, AlarmSum, AlarmFilter,
HWAlarmSum, SISAlarmList, and AlarmSupp. Many faceplates also include a
condensed version of an alarm list. Alarm Help can be accessed from alarm lists
through an alarm's Help column icon, context menu, or toolbar button. By
default, DeltaV-installed alarm list displays are configured to open Alarm Help
with these three methods, but these settings can be changed on those displays.
Additionally, alarm list
elements added to custom displays can be configured to access Alarm Help. Table
1 describes how to configure an alarm list element for each method of opening
Alarm Help.
Table: Table 1: Configuring alarm lists elements to open Alarm
Help
| Method
|
Configuration
|
| Include a
Help column on an alarm list element.
|
On the alarm list element's
Columns tab, select the
Help check box.
|
| Include an Open Alarm Help option on an
alarm's context menu.
|
On the alarm list element's
Actions tab, select the
Alarm Help check box.
For this option to be
visible on an alarm's context menu, Alarm Help must be enabled for the alarm or
the current user must have the privilege to edit Alarm Help for the alarm.
|
| Include an Open Alarm Help button on an
alarm's toolbar.
|
On the alarm list element's
Toolbar tab, select the
Open Alarm Help check box.
|
The Alarm Help icon appearing
in an alarm list Help column and toolbar button indicates the availability of
alarm help for the alarm. The following icons appear in the Help column an
toolbar:
Table: Table 2: Alarm Help icon descriptions for alarm lists
| Icon
|
Alarm Help availability
|
|
Alarm Help information is available for the alarm.
Alarm Help for the alarm can be viewed by the current user.
Alarm Help can be modified by users who have the necessary security keys.
|
|
Alarm Help information is not available for the alarm.
Alarm Help for the alarm can be added by the current user.
|
| No icon
|
Alarm Help information is not available for the alarm.
An Alarm Help license is not present on this workstation.
OR
The current user does not have the necessary security keys to view or add Alarm Help information.
|
Table 3 summarizes the
conditions and keys that determine which Alarm Help icon appears.
Table: Table 3: Alarm Help icon conditions
|
Condition
|
Condition State
|
|
Alarm Help License on
workstation?
|
No
|
Yes
|
Yes
|
Yes
|
Yes
|
Yes
|
Yes
|
Yes
|
|
Alarm Help configured?
|
*
|
Yes
|
No
|
No
|
No
|
No
|
No
|
No
|
|
Is this an SIS alarm?
|
*
|
*
|
No
|
No
|
No
|
Yes
|
Yes
|
Yes
|
|
Key for
ALARM_HELP_EDIT_COI?
|
*
|
*
|
Yes
|
*
|
No
|
*
|
*
|
*
|
|
Key for
ALARM_HELP_EDIT_TTR?
|
*
|
*
|
Yes
|
*
|
No
|
*
|
*
|
*
|
|
Key for
ALARM_HELP_EDIT_TEXT1?
|
*
|
*
|
Yes
|
*
|
No
|
*
|
*
|
*
|
|
Key for
ALARM_HELP_EDIT_TEXT2?
|
*
|
*
|
Yes
|
*
|
No
|
*
|
*
|
*
|
|
Key for
ALARM_HELP_EDIT_TEXT3?
|
*
|
*
|
Yes
|
*
|
No
|
*
|
*
|
*
|
|
Key for
CHANGE_CONFIG_DB?
|
*
|
*
|
*
|
Yes
|
No
|
*
|
*
|
*
|
|
Key for
SIS_ALARM_HELP_EDIT_COI?
|
*
|
*
|
*
|
*
|
*
|
Yes
|
*
|
No
|
|
Key for
SIS_ALARM_HELP_EDIT_TTR?
|
*
|
*
|
*
|
*
|
*
|
Yes
|
*
|
No
|
|
Key for
SIS_ALARM_HELP_EDIT_TEXT1?
|
*
|
*
|
*
|
*
|
*
|
Yes
|
*
|
No
|
|
Key for
SIS_ALARM_HELP_EDIT_TEXT2?
|
*
|
*
|
*
|
*
|
*
|
Yes
|
*
|
No
|
|
Key for
SIS_ALARM_HELP_EDIT_TEXT3?
|
*
|
*
|
*
|
*
|
*
|
Yes
|
*
|
No
|
|
Key for
SIS_CHANGE_CONFIG_DB?
|
*
|
*
|
*
|
*
|
*
|
*
|
Yes
|
No
|
|
Icon that appears
|
---
|
|
|
|
---
|
|
|
---
|
|
* This condition is
ignored
|
Accessing Alarm Help from a script
You can also apply scripts
that open Alarm Help to display elements. To apply a script that opens Alarm
Help from a display element, create an Open Application action on a display
element (such as a button). This action can be created in the element's
Interaction tab on the Graphics Configuration pane. Then, enter the following
command arguments in the Command Arguments field (or open the Script
Assistant):
|
Argument
|
Meaning
|
|
alarm path
|
The path to the
alarm in the form alarm_container/alarm_parameter_name.
|
|
/x:nn
|
The distance from
the left edge of the monitor to the left edge of the Alarm Help Application in
pixels.
|
|
/y:nn
|
The distance from
the top edge of the monitor to the top edge of the Alarm Help Application in
pixels.
|
|
/nohelp
|
Suppress display of
the help dialog for the Alarm Help View and Edit application.
|
|
/w:nn
|
The width of the
Alarm Help Application, in pixels.
|
|
/h:nn
|
The height of the
Alarm Help Application, in pixels.
|
For example, to open the help for the COMM alarm on logic solver
SLS2 from a button and have it appear 100 pixels from the left and top edge of
the monitor, create an Open Application action on the button and enter this
script in the
Command Arguments field:
"alarmhelp sls2/comm_alm /x:100 /y:100 /nohelp"
