Alarm Banner

Functional reference for AlarmBannerObject, including its runtime role and the supported settings available in the design environment.

Updated 7 min read
On this page (8 sections)
  1. Functional explanation
  2. Row Buttons
  3. Style
  4. Header Strip
  5. Object name
  6. Settings
  7. Position / Size
  8. Visibility

Functional explanation

AlarmBannerObject shows the live alarm list on a page. It is used where active alarms must remain visible to the operator without opening a separate viewer page.

The object is useful on overview pages, control room displays, and faceplates where active alarm awareness is required during operation. It presents alarm data in a tabular banner layout with configurable columns and acknowledgement support.

Use it when active alarms should remain visible inside the current page instead of only in the dedicated viewer page.

Row Buttons

Each alarm row ends with up to three buttons. A button is shown only to users whose user group holds the matching right; for other users its column is hidden, header included.

ButtonActionUser group right
AcknowledgeAsks for an acknowledge comment and acknowledges the alarm. The button is hidden on a row that is already acknowledged.Alarm Acknowledge Right
ShelveOpens the Shelve Alarm dialog of the Alarm Viewer with the duration, the shelve type and the Reason. The shelved alarm leaves the banner and is unshelved or extended in the Suppressed Alarms view of the Alarm Viewer. For a severity that is excluded by the Shelvable Severities setting on the Parameters page the button is dimmed and its tooltip states the reason.Alarm Shelve Right
RemoveRemoves the alarm from the active list without acknowledging it.Alarm Remove Active Right

When Part 11 compliance mode requires an electronic signature for the action key Alarm.Ack or Alarm.Shelve, the Electronic Signature dialog opens before the acknowledgement or the shelve is applied, as in the Alarm Viewer. Shelved alarms and alarms suppressed by design are not listed in the banner; the Suppressed Alarms view of the Alarm Viewer lists them.

Style

The Style setting in the Alarm Filtering group selects how the banner shows its alarms. A new Alarm Banner is created as Flat. A banner created before the setting existed shows Classic until Style is changed.

StyleRowsAlarm stateHeader
ClassicThe grid with the stored column widths. A text longer than its column wraps.Every text cell takes the alarm state color. The text of an active unacknowledged alarm blinks.The column header row. The header strip is shown above it when Show Header Strip is checked.
FlatOne line per alarm. The columns share the banner width and the Message has the largest share; a text longer than its column ends with an ellipsis. The column widths set in Classic do not apply.The alarm state color is on the message only. An unacknowledged alarm is bold, and while it is active only its severity symbol blinks.The header strip above the column headers, as long as Show Header Strip is checked.

In both styles the Severity column shows the severity name, a column name that was not changed is shown in the operator's language, a text cell shows its full text as tooltip, and an empty banner shows No alarms. The rows are updated in place when alarms change, so a button keeps its position while the operator points at it.

To change a column width, select the Alarm Banner in the design environment and drag the right border of the column, in the column header or next to the rows. The border follows the pointer, and the widths are saved with the page. In Flat, the column borders are marked in the column header while the banner is selected.
Classic: while the table is narrower than the banner, the column gets wider or narrower and the table with it. When the table fills the banner, the width moves between the column and the next column, and the other columns keep their widths. The narrowest width of a column is the width of its longest word. When the banner is resized, the table adapts to the new width. When the table is wider than the banner, the columns are at their narrowest width and the columns on the right are cut off; hide columns or make the banner wider to show them.
Flat: the width moves between the column and the next column, so the table keeps the width of the banner.
Each style keeps its own column widths, so switching the Style and back restores them.

Header Strip

The header strip above the column headers shows the Table Name when one is set, the filter, the number of active and unacknowledged alarms, and Acknowledge All. For users with the Alarm All Acknowledge Right, Acknowledge All acknowledges every unacknowledged alarm listed in the banner through the same acknowledge dialog as the row button.
Show Header Strip in the Alarm Filtering group shows or hides the strip in both styles. Until it is changed, it follows the Style: checked in Flat and cleared in Classic, so a Classic banner created before the setting existed keeps its look. When it is cleared, the column headers are at the top of the banner.
The texts of the strip follow the operator's language. The Table Name is translated through the project language texts in the same way as the column names, and the Project Language Texts Export on the Parameters page includes it.

Object name

Set the object name shown in the alarm banner decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Alarm Banner object.MainAlarmBannerText

Settings

Configure the alarm filters and column visibility for the banner.

37 rows
SettingDescriptionExampleUnits
Background ColorBackground color used for the alarm banner. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#FFFFFFColor
Header Background ColorBackground color used for the banner header. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#0d6efdColor
Text ColorText color used in the alarm banner.#212529Color
Header Text ColorText color used in the banner header.#FFFFFFColor
Grid Line ColorGrid line color used in the banner.#dee2e6Color
Icon ColorIcon color used in the banner.#dc3545Color
Table NameName of the banner. The page script functions PageAlarmBannerAcknowledgeAll and PageAlarmBannerRemoveAll address the banner by this name, and the header strip shows it as its title, translated through the project language texts.Main Alarm BannerText
StyleClassic or Flat; see the Style section. A new banner is Flat, a banner created before this setting existed is Classic.FlatClassic or Flat
Show Header StripShows the header strip with the Table Name, the filter, the alarm counts and Acknowledge All above the column headers, in both styles; see the Header Strip section. Until it is changed, it follows the Style: checked in Flat, cleared in Classic. When cleared, the column headers are at the top of the banner.trueBoolean
AssetsAsset filter list for banner content.BoilerRoom,TurbineHallText list
Show ReturnedShows returned alarms when enabled.trueBoolean
Show Active AcknowledgedShows active acknowledged alarms when enabled.trueBoolean
Show Returned AcknowledgedShows returned acknowledged alarms when enabled.falseBoolean
Hide IconHides the icon column when enabled.falseBoolean
Hide SeverityHides the severity column when enabled.falseBoolean
Hide AssetHides the asset column when enabled.falseBoolean
Hide On TimeHides the on-time column when enabled.falseBoolean
Hide Off TimeHides the off-time column when enabled.falseBoolean
Hide Ack TimeHides the acknowledgement time column when enabled.falseBoolean
Hide Ack UserHides the acknowledgement user column when enabled.falseBoolean
Hide Ack CommentHides the acknowledgement comment column when enabled.falseBoolean
Severity Column NameHeader text for the severity column.SeverityText
Asset Column NameHeader text for the asset column.AssetText
Message Column NameHeader text for the message column.MessageText
On Time Column NameHeader text for the on-time column.On TimeText
Off Time Column NameHeader text for the off-time column.Off TimeText
Ack Time Column NameHeader text for the acknowledgement time column.Ack TimeText
Ack User Column NameHeader text for the acknowledgement user column.Ack UserText
Ack Comment Column NameHeader text for the acknowledgement comment column.Ack CommentText
Header Font FamilyFont family used for the banner header.ArialFont family name
Header Font SizeFont size used for the banner header.14px
Header Font WeightFont weight used for the banner header.700CSS font weight
Header HeightHeader height used for the banner.28px
Row Font FamilyFont family used for banner rows.ArialFont family name
Row Font SizeFont size used for banner rows.13px
Row Font WeightFont weight used for banner rows.400CSS font weight
Row HeightRow height used for the banner.24px

Position / Size

Configure the position and size of the Alarm Banner object.

SettingDescriptionExampleUnits
TopTop position of the object.100px
LeftLeft position of the object.220px
WidthWidth of the object.500px
HeightHeight of the object.180px
Z-indexLayer order of the object. Higher values appear in front of lower values.10Number

Visibility

Configure the runtime visibility and blinking behavior for the Alarm Banner object.

SettingDescriptionExampleUnits
VisibilityExpression controlling whether the object is visible.PLC1.AlarmBannerVisibleExpression
BlinkExpression or boolean controlling banner blinking.PLC1.AlarmActiveBoolean or expression
Blink SpeedBlink speed used during runtime.500ms
Blink OffsetBlink offset used to stagger blinking between objects.falseBoolean
Something missing or wrong in this article? Contact us