Viewers

Functional reference for the Alarm Viewer, Event Viewer, Audit Trail Viewer, Trend Analyst Viewer and Users Viewer objects, which place an existing product page inside a runtime page.

Updated 5 min read
On this page (7 sections)
  1. Functional explanation
  2. Object name
  3. Settings
  4. Position / Size
  5. Border
  6. Access Control
  7. Visibility

Functional explanation

The viewer objects place one existing product page inside a runtime page. Five objects are available, each fixed to one page.

ObjectShowsRights that apply inside the object
Alarm ViewerThe Alarm Viewer page with the live alarm list, for the whole plant or filtered on one asset.Alarm acknowledge, acknowledge all, delete and remove active rights.
Event ViewerThe Event Viewer page with the event history.Event delete right.
Audit Trail ViewerThe Audit Trail page with the audit records.Audit view right. Users without it see no records.
Trend Analyst ViewerThe Trend Analyst page with its pens and chart.The rights of the Trend Analyst page.
Users ViewerThe Users page with the user list.User edit and user delete rights.

The object works out of the box. It carries no address and has nothing to configure for the connection: the runtime resolves the page itself, relative to the address the client used to reach the server. A client on another workstation, reached by host name or by IP address, therefore shows the same object correctly without any change to the page.

The framed page keeps its own access rules. A user who may not open the page from the menu sees the same refusal inside the object, and the buttons inside the object follow the same user group rights as the page itself.

The page inside the object refreshes its own content, so the object itself is not reloaded and the operator keeps the filters, the scroll position and the selection while working. An Alarm Viewer is loaded again only when the value of its Asset setting changes.

The object shows the page content only. The navigation of the page and the AI chat button are left out, so they are not repeated inside every object on the runtime page.

Object name

Set the object name shown in the decorator context of the selected viewer.

SettingDescriptionExampleUnits
Object NameName used to identify the viewer object.AlarmViewerMainText

Settings

The Event Viewer, Audit Trail Viewer and Users Viewer have no settings of their own. Place the object, size it, and it shows its page.

The Alarm Viewer has one setting. Asset opens the viewer filtered on one part of the plant: it shows the alarms whose Asset contains the entered text, so a node path of the Asset Manager, for example WTP/Distribution, includes every alarm under the node. The filter applies to the Active Alarms, Suppressed Alarms and Historic Alarms views, and the counters in the toolbar count the filtered alarms. It appears as a chip above the grid, which the operator can remove, and it is applied again when the page is opened again. Empty shows all alarms.

The field also accepts the name of a variable holding the asset, which is the usual choice for a client variable: a button sets the variable with a Set Value action and then opens the page with Navigate To, so one page serves every part of the plant. When the value of the variable changes, the viewer is loaded again with the new filter. A Navigator alarm badge that opens the page replaces the filter with the filter of the clicked row.

The Trend Analyst Viewer has one setting. Config opens the Trend Analyst Config (JSON) editor, the same editor used by the Navigate To Trend Analyst action, with a Beautify button to format the text. The field also accepts the name of a variable holding the configuration, which is the usual choice for a client variable: the operator then selects a configuration on the page and the trend is rebuilt in place.

SettingDescriptionExampleUnits
AssetAsset filter of the Alarm Viewer: an asset path, or the name of a variable holding it. Shows the alarms whose Asset contains the value. The variable button next to the field opens the variable list. Empty shows all alarms. Alarm Viewer only.WTP/DistributionText or variable
ConfigTrend Analyst configuration as JSON, or the name of a variable holding it. The variable button next to the field opens the variable list. Trend Analyst Viewer only.client.TrendConfigJSON or variable

A configuration is applied while the trend keeps running. It is not a reload, so switching configuration does not restart the page. Build the trend in Trend Analyst, export its configuration there, and paste it into this field.

Position / Size

Configure the position and size of the viewer object. Give the object enough room for the page it shows: a grid page reads well from about 1000 by 600, the Trend Analyst from about 1200 by 700.

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

Border

Configure the border drawn around the viewer object.

SettingDescriptionExampleUnits
Border ColorBorder color of the object.#355B8DColor
Border Color StatesColor states evaluated at runtime to color the border.PLC1.AlarmActive == 1 : #C62828Expression
Border WidthWidth of the border. Default 1.1px
Border RadiusCorner radius of the border. Default 5.5px
Border VisibilityExpression controlling whether the border is drawn.PLC1.AlarmActiveExpression
Border BlinkExpression or boolean controlling border blinking.PLC1.AlarmActiveBoolean or expression
Border Blink SpeedBlink speed used during runtime.500ms
Border Blink OffsetBlink offset used to stagger blinking between objects.falseBoolean

Access Control

Configure access control for the viewer object. This decides whether the object is shown on the page for a user group. The rights of the framed page apply on top of it and are enforced by the server.

SettingDescriptionExampleUnits
Access Control EnableEnables access control evaluation for the object.trueBoolean
Access ControlExpression controlling who can use or see the object.SYSTEM.UserGroups == "Operators"Expression
Access Control FilterCSS filter applied when access control is used to alter the object appearance.blur(0px) contrast(30%)CSS filter

Visibility

Configure the runtime visibility and blinking behavior for the viewer object.

SettingDescriptionExampleUnits
VisibilityExpression controlling whether the object is visible.client.ShowAlarmsExpression
BlinkExpression or boolean controlling frame 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