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 how to filter alarm events in Perspective's Alarm Status Table component.
Video recorded using: Ignition 8.0
Transcript
(open in window)[00:00] In this lesson, we will be taking a look at how we can use the filtering options built into our Alarm Status and Journal components to customize which alarms appear in our table. So let's get started with our Alarm Status table here. Now, as we've discussed in earlier videos, if I go into preview mode, I can configure some very basic filters from the component UI itself by clicking on the filter icon in the top right hand corner there. There I can filter on alarm state and acknowledge state as well as alarm priority. We also have a display running across the top of our component that shows our currently active filters and gives us a chance to remove them by click on the X. Now, this is a great start, but there's actually quite a bit more filtering that's possible on the component. For that, I just need to go into my Property Editor on the right hand side, and in there, I'm going to scroll down until I find the filters property. There are two sub-properties in here that I can work with which allow me to configure filters on the active and shelved tabs of the component, respectively.
[01:06] So if I expand active here, we have a few different options. If I enter text here, for example, that is basically the same as typing into the search field at the top of the components. The alarming table components are actually built on top of the standard prospective table components, and the text filtering here is functionally identical. So below that, we have states and priorities, which, much like the text option, are linked to the filtering UI built on the components. So I can adjust these filters by messing with the properties here or changing them on the component directly, and it's basically the same thing. One note on that. If I clear all the check boxes for my states or priorities, it'll clear the filters entirely, meaning I'll see all alarm events rather than none. Below that, we have conditions which allow us to do filtering on source paths, display paths, and tag providers. Now, I can actually use asterisks as wildcard characters in here, so I don't need to match the paths or provider names directly.
[02:02] If I type something like, "star, Sine7, star" and hit Enter, I'll see only Sine7's alarm events in my table. So that's the conditions properties. They allow us to do our own more granular search on alarm events. Finally, at the bottom here, we have results. What this does is it actually exposes the alarm events in the filtered table as objects inside of the data array here, so long as I've checked that enabled check box. So basically, I can work with my alarm events as actual properties underneath. Now, it's worth noting that these can cause a bit of a performance hit since we'll be constantly writing alarm events to this property as the user makes filtering selections. So it's a good idea to turn this on only if you really need it. So moving on here, if I collapse active, we can see shelved underneath. We have two properties in here, just text and results, which are basically the same as the corresponding properties underneath active.
[03:02] They just apply when the shelved tab is up instead. So that's the basic filtering available to us on the Alarm Status table. I'll take just a moment to touch on the filtering props for the Alarm Journal table which I have in this tab at the bottom here. Now, they're pretty much the same. The filtering functionality on the component is basically identical. The only difference is that, in addition to having all the same properties in my filter prop here, I also have events. Since an Alarm Journal table shows different rows for active, clear, and acknowledge events, this event's sub-property just allows me to filter on each of those states. So that about wraps up our coverage of alarm filtering and perspective. The alarming components offer easy, built-in ways to pair down alarm events coming in.