dl-breadcrumbs__homedl-breadcrumb-item__separatorConfiguration and programmingdl-breadcrumb-item__separatorProgramming with CODESYSdl-breadcrumb-item__separator...dl-breadcrumb-item__separatorCODESYS Visualizationdl-breadcrumb-item__separatorReference, Programmingdl-breadcrumb-item__separatorVisualization Elementsdl-breadcrumb-item__separatorVisualization Element 'Alarm Banner'
dl-pagination__prev-inactivedl-pagination__prev-activedl-pagination__next-inactivedl-pagination__next-active
Visualization Element 'Alarm Banner'dl-permalink__symbolPermalink

Symbol:

visu_img_alarm_banner

Category: “Alarm Manager”

The element is a simplified version of the alarm table. It visualizes a single alarm only. 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.

The alarm banner displays active alarms only. If the alarm is acknowledged, then it disappears from the alarm banner.

Element properties

“Element name”

Example: ‎GenElemInst_1‎

“Type of element”

“Alarm Banner”

“Data source”

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 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 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

Element property 'Columns: Column [<n>]'

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

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

“Width”

Width of the column (in pixels)

“Type of data”

About time stamps: When used in a TargetVisu or WebVisu, you can control the date and time format by means 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'‎).

Here you define the information to be displayed in the column.

  • “Bitmap”

  • “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 acknowledgement

  • “Value”: Actual value of the expression

  • “Message”: 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 contents in the column

  • “Left”

  • “Centered”

  • “Right”

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‎

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

Element property 'Center'

The properties contain fixed values for the coordinates of the point of rotation. This point of rotation is shown as the _visu_icon_center_point.png 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

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

Element property 'Text properties'

The properties contain fixed values for the text properties.

“Font”

Example: “Default”

_cds_icon_three_dots: The “Font” dialog box opens.

_cds_icon_arrow_down: Drop-down list with style fonts.

“Font color”

Example: “Black”

_cds_icon_three_dots: The “Color” dialog box opens.

_cds_icon_arrow_down: 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.

“Acknowledge variable”

A rising edge of this variable acknowledges the alarm.

Handling of multiple active alarms

“Automatic switch”

_cds_icon_option_activated: The display in the alarm banner is switched automatically according to the time to the next alarm as configured in “Every N second”.

“Every N second”

Time period until the next switching. Available only if “Automatic switch” is selected.

“Next alarm”

Variable for switching to the next alarm. Available only if “Automatic switch” is not selected.

“Previous alarm”

Variable for switching to the previous alarm. Available only if “Automatic switch” is not selected.

“Multiple alarms active”

Variable that has the value ‎TRUE‎ if multiple alarms are active.

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 _visu_icon_center_point.png 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.

 _visu_img_prp_rotation

“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 _visu_icon_center_point.png 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.

 _visu_img_prp_inner_rotation

You can link the variables to a unit conversion.

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.

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

These properties are available only when you have selected the “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.

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.