Visualization Element ‘Alarm table’

Symbol:

Label: Alarm manager

This element lists alarms. In the element properties, you specify which information is shown. You define the appearance of the element and the variables that control the element behavior.

Note

In online mode, you can sort an alarm table by a specific column – even in the classic view. Click into the column header. A small triangle indicates the current sort order (ascending, descending). Clicking the symbol reverses the order.

Sorting inside the column depends on the type of the contained information. The “Priority” column is sorted numerically, and the “Message…” and “Class” columns alphabetically. The “Value” and “Latch…” columns may contain different value types. In this case, sorting is first by type (blank, Boolean, numeric value, character string) and then either numerically or alphabetically depending on the type.

Element properties

Element name	Example: GenElemInst_1
Element type	Alarm table
Application	If you intend to use a remote alarm configuration, then you have to specify the name of the remote application here. If you do not specify anything, the alarm configuration will be located locally.

Element property ‘Alarm configuration’

Alarm groups	Opens the Select alarm group dialog box where you define the alarm groups that you want to display.
Priority from	Least priority for alarm display. (0 to 255).
Priority to	Greatest priority for alarm display. (0 to 255).
Alarm classes	Opens the Select class group dialog box where you define the alarm classes that you want to display.
Filter criterion	For the alarm banner element only. Most important: The alarm with the highest priority (least value) is displayed. Newest: The newest alarm is displayed.

See also

• Dialog Box ‘Selected alarm group’
• Dialog Box ‘Selected alarm class’

Element property ‘General table configuration’

Show row header	: Display of the row number at the beginning of the row.
Show column header	: Display of the column heading as defined in Column heading.
Row height	Height of the table rows (in pixels).
Row header width	Width of the line header (in pixels).
Scrollbar size	Width of the scrollbar when it runs vertically. Width of the scrollbar when it runs horizontally. Specified in pixels.
Automatic line break for alarm message	: The message text is truncated at the end of the line. : The message text is truncated at the end of the column, if the text is too long.

Element property ‘Columns: Column [<n>]’

By default, columns [0] and [1] are configured: Time stamp and Message text. You can create more columns by clicking the Create new, and remove columns by clicking Delete.

Animations (dynamic text, font variables), text, and tooltip are not supported.

Column header	The standard header is set and changed here by specifying a new text.
Use text alignment in title	: The text in the column header is aligned according to the current definition in Text alignment. : The text in the column header is centered.
Width	Width of the column (in pixels).
Data type	Notice about time stamps: For use in a TargetVisu or WebVisu, you can control the date and time format with the help of the global string variables from the library Alarmmanager.library: AlarmGlobals.g_sDateFormat (example: AlarmGlobals.g_sDateFormat := 'MM.yyyy') and AlarmGlobals.g_sTimeFormat (example: AlarmGlobals.g_sTimeFormat := 'HH:mm'). Define the information to be displayed in the column. Symbol Time stamp: Date and time of the last status change of the alarm. Time stamp active: Date and time of the last activation of the alarm. Time stamp inactive: Date and time of the last deactivation of the alarm. Time stamp acknowledge: Date and time of the last acknowledgment. Value: Current value of the printout Message text: Output of the message text Priority: Alarm priority Class: Alarm class State: Alarm state Latch Variable <n>: Value of the selected latch variables
Text alignment	Alignment of the text in this column Left Centered Right
Color settings	Activate color settings: Boolean variable for activating and deactivating the color settings defined here. Example: PLC_PRG.bColorSettings Cell fill color: Color variable: Variable for the cell fill color, example: dwCellColor (hexadecimal color definition: 16#TTRRGGBB) Use color also for column header: : The color defined via Color variable is used in the column header as well. Text color: Color variable: Variable for the definition of the text color in the column, example: dwTextColor (hexadecimal color definition: 16#TTRRGGBB) Use color also for column header: : The color defined via Color variable is used in the column header as well.

See also

• Animating a Color Display

Element property ‘Position’

The position defines the location and size of the element in the visualization window. These are based on the Cartesian coordinate system. The origin is located at the upper left corner of the window. The positive horizontal x-axis runs to the right. The positive vertical y-axis runs downwards.

X	X coordinate of the upper left corner of the element Specified in pixels. Example: 10.
Y	Y coordinate of the upper left corner of the element Specified in pixels. Example: 10.
Width	Specified in pixels. Example: 150
Height	Specified in pixels. Example: 30

Note

You can also change the values by dragging the box symbols ( ) to other positions in the editor.

See also

• Positioning Elements, Adapting Size and Layer

Element property ‘Text properties’

The properties contain fixed values for the text properties.

Font	Example: Default : The Font dialog box opens. : Drop-down list with style fonts.
Font color	Example: Black : The Color dialog box opens. : Drop-down list with style colors.
Transparency	Whole number (value range from 0 to 255). This determines the transparency of the respective color. Example: 255: The color is opaque. 0: The color is completely transparent. Please note: If the color is a style color and already has a transparency value, then this property is write-protected.

Element property ‘Selection’

Background color on selection	Fill color of the selected row.
Selection font color	Font color of the selected row.
Frame around selected cells	: A frame is drawn around the selected cells at runtime.
Variable for selected alarm group	Name of the affected alarm group; type: STRING, WSTRING.
Variable for selected alarm ID	Alarm ID of the affected alarm group; type: STRING, WSTRING.
Variable for selected line	Index of the selected alarm line (0-based). The index can be read and written; integer data type
Variable for valid selection	TRUE: An alarm line is selected. FALSE: The selection is invalid. For example, for an empty alarm table or when an alarm is not selected yet.

Element property ‘Control variables’

Boolean variables are defined here for executing specific actions in the table can be executed at runtime.

Acknowledge selected	Variable (BOOL) Example: PLC_PRG.bAckSelectedAlarms If the assigned variable is TRUE, then the selected alarm is acknowledged.
Acknowledge all visible	Variable (BOOL) Example: PLC_PRG.bAckVisibleAlarms If the assigned variable is TRUE, then all alarms are acknowledged that are visible in the alarm table.
History	Variable (BOOL) Example: PLC_PRG.bShowHistory If the assigned variable is TRUE, then the history alarms are displayed in addition to the active alarms. In the classic view, the same sort options apply as in normal mode. Note: Acknowledgment is not possible in this view.
Freeze scroll position	Variable (BOOL) Example: PLC_PRG.bFreezeScrollPosition If the assigned variable is TRUE, then the scroll position set in the History view is retained, even if a new alarm is active. If not, then the scroll position jumps to the first table row (the newest alarm).
Count alarms	Variable (integer data type) Example: PLC_PRG.iNumberOfAlarms. Number of alarms that are currently displayed in the alarm table. Defined by the alarm table.
Count visible rows	Variable (integer data type) Example: PLC_PRG.iNumberVisibleLines Number of alarms that can be displayed on one page of the alarm table. Defined by the alarm table.
Current scroll index	Variable (integer data type) Example: PLC_PRG.iScrollIndex The index of the first visible row if the alarm table (0-based). The variable can be read and written.
Current column sorting	Variable (integer data type) Example: PLC_PRG.iColSort The variable contains a value of the enumeration “VisuElemsAlarm.VisuEnumAlarmDataType”. This value determines the column that sorts the alarm table.
Variable for sorting direction	Variable (BOOL) Example: PLC_PRG.xSortAscending The variable determines the sort order for the entries in the alarm table (TRUE: ascending; FALSE: descending).

Note

You can also use the Insert elements for acknowledging alarms command to define buttons with predefined control variables.

See also

• Command ‘Add elements for alarm acknowledgement’

See also

• Visualizing Alarm Management
• Designing Visualizations with Elements
• Animating a Color Display