You can help by commenting or suggesting your edit directly into the transcript. We'll review any changes before posting them. All comments are completely anonymous. For any comments that need a reply, consider emailing docs@inductiveautomation.com.
Version:
Supplemental Videos
-
8:44Displaying Current Alarms
-
3:49Filtering Alarms
-
3:01Displaying Alarm History
-
2:55Alarm Row Styles
Description
Learn about the Perspective Alarm Status Table component, the easiest way to visualize alarm status in Perspective.
Video recorded using: Ignition 8.1
Transcript
(open in window)[00:00] In this lesson, we'll explore alarm visualization in the Perspective module. We're going to focus on the capabilities of the Alarm Status Table component, which allows us to view, filter, and interact with live alarms across our system. We'll start in the Ignition Designer with a new Perspective view open for editing. I'll find the Alarm Status Table component in my Component Palette and drag it into my view here. I have a few live events in my system already, and we can see them showing up in our table. To see the functionality of the Alarm Status Table to its best advantage in Perspective, let's put it in Preview mode. Here's how the basic interactivity works. I'll start by selecting one or two live alarm events in my table, and I can either shelve the alarms or acknowledge the events. If I hover over each alarm event, on the right hand side I can see a little ellipsis icon. If I click on it, a popup modal appears with alarm details for that event. There are two sections we'll check out here-- the Config Properties section and the On Active section.
[01:11] The Config Properties section contains pre-configured properties of the alarm, like display path, label, et cetera. The On Active section holds runtime properties of the event, like the time the alarm became active, special notes, and setpoint information. Once I'm finished gathering the info I need, I can click the X to see the whole table again. We'll continue in preview mode and take a quick look at the toolbar at the top of the table. The tools provide you granular control over what is displayed within the Alarm Status Table. In this top toolbar, I can choose between showing Active and Shelved alarms on the left hand side. If I click on Shelved here, we'll see that I have no shelved alarms for now, so I want to go back into my active alarms. When viewing Shelved alarms, clicking on the bell icon will switch the component back to the real time active view. On the right hand side of that top toolbar, we have a magnifying glass icon that will take you to the built-in search field for our table. Let's say I only wanted to see the critical alarms for a moment.
[02:13] One way I could do that would be to search for the term critical here. Right next door, this little strawberry shaped bar icon allows us to control our table filters based on their state and their priority. We'll talk more about filtering alarms in a later video. Since I want to keep those settings as is for now, I'll just X out here to go back to my main table view. Our last item in this section is a little gear icon that takes us to the Configuration menu. This menu allows me an easy method to select what alarm info to show in my table so I can change what columns appear. Here, I can select the alarm properties to display in my table. I already have several of the most commonly used properties enabled, so we'll X out of that, and we can explore some of the filtering capabilities. Right below that top toolbar, I have a bar here that shows my current filters and allows me to remove them if I'd like.
[03:05] Let's say I don't want to see anything that's marked low priority in this table. I'd just click on this X to remove that priority filter. If I change my mind later, I have two ways to remedy that in my designer. I can either go back to my strawberry icon above and reselect low, or I can go into my Perspective Property Editor, find the filters object, expand active and priorities, and then check the box next to low to enable that again. Now let's return to our actual table, which looks and functions quite a bit like the Perspective table component. We'll use the built-in tools to tailor the Alarm Status Table to our needs first, and then we'll take a look at further customization capabilities within the Perspective Property Editor. If we start with the headers, I can use them to sort based on individual fields. For example, I can change the sorting for Priority if I want to see priority events in a different order. As of Ignition 8.1.14, columns can be reordered in Preview mode and in a Perspective session by clicking on the column header and dragging it to a new location.
[04:11] In order to do this, make sure the dragOrderable property is enabled in your Perspective Property Editor, and try it out for yourself. I've put a reference to the Perspective Alarm Status Table documentation from the Ignition User Manual below this video, if you'd like more information on this or other properties. I only have a few alarms displayed here in my alarm status table for demonstration purposes, but if there weren't enough room to display all of them, I could use the pager at the bottom to navigate to additional alarms. Long lists of alarm events are spread across multiple pages to improve performance, so if multiple pages are created, clicking on a number down here will switch which page is shown. I can also change the number of rows shown on each page with this dropdown menu at the bottom left. We do have a couple of other videos dealing with alarm visualization in Perspective in greater depth, but let's go ahead and take a brief look at a few of the other handy properties of our component.
[05:07] In the Perspective Property Editor, the refreshRate property is new as of Ignition 8.1.0. This is the rate at which the table will poll for updates in milliseconds. The default value is 5,000 milliseconds, so it will look for alarm updates every five seconds, but you can change this value to suit your needs. These next few properties toggle any of the main features in our table. For example, the enableHeader property controls the header's visibility, while enableDetails controls the ability to see the details dialog. The other properties in this section follow the same self-explanatory pattern. Just a bit further down, we have the toolbar section, which will allow us to toggle the large navigation toolbar at the top or any of the individual elements inside it. For example, I could remove the Shelved tab by turning off enableShelvedTab, or I could hide the gear icon by turning off enableConfiguration, so my users can't change what columns are displayed.
[06:04] Scrolling down a bit, we have this responsive object which allows us to configure a breakpoint for our table. If the enabled box is checked and the pixel width of the table falls below that defined breakpoint, we'll render our alarm events as cards rather than rows in a table. The new selection object added in Ignition version 8.1.4 is useful for controlling the ability to select alarms within the Alarm Status Table. If you expand active and look at the mode property dropdown, you'll see that there are several different options available: single, multiple, and none. The default is multiple, so right now I can select multiple alarms in my status table if I want to acknowledge many at one time or perform another bulk action. If I want to restrict it so that only one alarm can be selected at a time, I would choose single so that no matter how many alarms I try to select, it only allows me to take action with a single alarm. The none option sets the table so that you can't select any alarms. I'll point out one final set of properties here -- activeSortOrder and columns.
[07:08] If I want to sort on this Active Time value here in my Alarm Status Table, and I'd like to set up my table so that the active time values display in descending order by default, it's pretty easy to make that change. First, let's take our current alarms view out of Preview mode at this point. Then I would need to find the columns object in the Perspective Property Editor. You'll notice that it has two nested objects, either active or shelved. Expand the active object, and you'll see a bunch of property objects that correspond to table columns we can modify as needed. Right now, the only ones we have enabled are activeTime displayPath, priority, state, source, and name. To see the Active Time values in descending order in our table, first expand activeTime and set sort to descending in the dropdown. Now that we've set the sort mode under the parent column, let's go to activeSortOrder next. We'll need to add an array element that tells it what we want to sort on.
[08:05] Click on Add Array Element and select the Value option to create a new value item in the active sort order array, then replace the word value with activeTime, the object we enabled sort descending mode on below. With that, it'll change the default sort order of the table and show the items in descending order based on active time. The Perspective Alarm Status Table is a flexible and highly customizable way of monitoring and interacting with your alarming platform from a Perspective session. Please check out the documentation linked below for more information about how you can tailor the alarm display to meet your needs.