[Workspace]AlarmSortOrder
- Last UpdatedJul 19, 2023
- 1 minute read
Defines a customized sort order for the following alarm lists in a Situational Awareness project:
-
Active Alarms page
-
Alarms panel in the Information Zone
-
Top 5 alarms pop-up for the HD1080 workspace
-
Alarm Summary panel for the UHD4K workspace
-
Shelved Alarms page.
To specify a sort order, use the following syntax:
{KeyName,SortDirection} {KeyName,SortDirection}
KeyName specifies the name of the pre-defined order-by key to be used. The valid options are a subset of the alarm display fields:
-
Tag
-
Name
-
Category
-
Priority
-
Area
-
Equipment
-
Priv
-
Time
-
State.
SortDirection (optional) indicates whether the sort will be ascending or descending. Valid options are:
-
0 = Descending (default)
-
1 = Ascending
Allowable Values:
Any valid sort order string.
Default Value:
Empty string.
If the above parameter is not defined, the alarm list will be sorted according to the current setting for the alarm server's Highest Priority Order field ("Priority, Alarm State" or "Alarm State, Priority").
Examples
Sort by Tag ascending, and Time descending:
[Workspace]AlarmSortOrder={Tag,1}{Time}
Sort by Time ascending and Tag descending:
[Workspace]AlarmSortOrder={Time,1}{Tag,0}
Sort by Equipment ascending and Tag descending:
[Workspace]AlarmSortOrder={Equipment,1}{Tag,0}