Visualization Element 'Alarm Table'

Symbol:

Tag: Alarm Manager

The element displays alarms in a list. 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

Type of element

Alarm Table

Data source

Selection of the device and the application where the data to be visualized and the alarms are generated

  • Remote data source which accesses a remote device, accesses a remote application, and then transfers the data to the alarm configuration

    Example: DataSource_A

    Below the (now visible) Application property, the remote application is displayed as configured in the data source.

    Example: App_A

    Note: If the data source is accessed symbolically by means of a symbol file (CODESYS symbolic), then the required symbol file and the corresponding project have to be saved in the same folder.

  • Local application below which the alarm configuration is located

    Example: <local application>

Element property 'Alarm configuration'

Alarm groups

Opens the Select Alarm Group dialog where you define the alarm groups that you want to display.

Priority from

Lowest priority for alarm display. (0 to 255).

Priority to

Highest priority for alarm display. (0 to 255).

Alarm classes

Opens the Select Class Group dialog 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 (lowest value) is displayed.

  • Newest: The most recent alarm is displayed.

Filter by latch 1

The generated alarms (previous and current) can be filtered by the contents of Latch variable 1, which is specified in the configuration of the alarm group. In Filter type, you define whether or not the filtering is performed by a string value or a numerical value.

  • Filter variable: Indicates what the alarms are filtered by. Possible entries: Application variable of data type STRING or WSTRING, or a literal value directly. Examples:PLC_PRG.strFilterVariable, 'STRING'.

  • Filter type: Integer value that determines by which criteria the latch variable value is used for filtering. Possible entries: Numerical variable from the application (example: PLC_PRG.diFilterType, or a value directly (example: 2).

    Possible values:

    • 0: No filtering

    • 1: Filter by alarms whose latch variable 1 contains the string specified in Filter variable. Example: The filter variable contains 'Error 1' which is the latch variable 1 of different alarms of type STRING and has the value 'Error 1' ->. Only these alarms are displayed.

    • 2: Filter by alarms whose latch variable 1 contains the typed literal specified in Filter variable according to IEC 61131-3. Examples: T#1h2s, DINT#15, REAL#1.5, FALSE

    • 3: Filter by alarms whose latch variable 1 contains the LINT literal value specified in Filter variable. Therefore, the value of the latch variables has to be in the range of 9,223,372,036,854,775,808 to 9,223,372,036,854,775,807.

    • All other values: The behavior is not defined and can change in the future.

Filter by time range

The generated alarms (remote, historical, local) can be displayed for a specified time range. You use the Filter type to define whether filtering by time range is enabled or disabled.

  • Filter variable, from: Variable of data type DT or DATE_AND_TIME (example: PLC_PRG.filterTimeFrom) for the start time that the alarms are displayed.

  • Filter variable, to: Variable of data type DT or DATE_AND_TIME (example: PLC_PRG.filterTimeTo) for the end time that the alarms are displayed.

  • Filter type: Variable of integer data type that determines whether Filter by time range is enabled or disabled.

    Possible values:

    • 1: Filtering is enabled

    • 0: Filtering is disabled

See also

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

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

Element property 'Center'

The properties contain fixed values for the coordinates of the point of rotation. This point of rotation is shown as the symbol. The point is used as the center for rotating and scaling.

X

X-coordinate of the point of rotation

Y

Y-coordinate of the point of rotation

Note

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

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

Element property 'Absolute movement'

The properties contain IEC variables for controlling the position of the element dynamically. The reference point is the upper left corner of the element. In runtime mode, the entire element is moved.

Movement

X

Variable (numeric data type). Defines the X position (in pixels).

Example: PLC_PRG.iPos_X.

Increasing this value in runtime mode moves the element to the right.

Y

Variable (numeric data type). Defines the Y position (in pixels).

Example: PLC_PRG.iPos_Y.

Increasing this value in runtime mode moves the element downwards.

Rotation

Variable (numeric data type). Defines the angle of rotation (in degrees).

Example: PLC_PRG.iAngle1.

The midpoint of the element rotates at the Center point. This rotation point is shown as the symbol.

In runtime mode, the alignment of the element remains the same with respect to the coordinate system of the visualization. Increasing the value rotates the element to the right.

Interior rotation

Variable (numeric data type). Defines the angle of rotation (in degrees).

Example: PLC_PRG.iAngle2.

In runtime mode, the element rotates about the point of rotation specified in Center according to the value of the variable. In addition, the alignment of the element rotates according to the coordinate system of the visualization. Increasing the value in the code rotates clockwise.

The rotation point is shown as the symbol.

Note: If a static angle of rotation is specified in the Position ‣ Angle property, then the static angle of rotation is added to the variable angle of rotation (offset) when the visualization is executed.

Note

You can link the variables to a unit conversion.

Note

The X, Y, Rotation, and Interior rotation properties are supported by the "Client Animation" functionality.

See also

Element property 'State variables'

The variables control the element behavior dynamically.

Invisible

Variable (BOOL). Toggles the visibility of the element.

TRUE: The element is not visible at runtime.

Note

The Invisible property is supported by the "Client Animation" functionality.

See also

These properties are available only when you have selected the Preview: Support client animations and overlay of native elements option in the Visualization Manager.

Animation duration

Defines the duration (in milliseconds) in which the element runs an animation

  • Variable (integer value)

    Example: Menu.tContent with VAR tContent : INT := 500; END_VAR

  • Integer literal

    Example: 500

Animatable properties

  • Absolute movement, Movement, X, Y

  • Absolute movement, Rotation

  • Absolute movement, Interior rotation

  • Absolute movement, Exterior rotation

The animated movement is executed when at least one value of an animatable property has changed. The movement then executed is not jerky, but is smooth within the specified animation duration. The visualization element travels to the specified position while rotating dynamically. The transitions are smooth.

Move to foreground

Moves the visualization element to the foreground

Variable (BOOL)

Example: bIsInForeground with VAR bIsInForeground : BOOL := FALSE; END_VAR

TRUE: At runtime, the visualization element is displayed in the foreground.

FALSE: At runtime, the visualization element is displayed in the layer where it was inserted in the visualization editor.

See also

Element property 'Access rights'

Requirement: User management is set up for the visualization.

Access rights

Opens the Access rights dialog. There you can edit the access privileges for the element.

Status messages:

  • Not set. Full rights.: Access rights for all user groups : operable

  • Rights are set: Limited rights: Access is restricted for at least one group.

See also

See also

3.5.16.0

© Copyright 2021, CODESYS GmbH