LESSON

Alarm Journal Query

Description

The Alarm Journal Query provides easy access to alarm journal data in your reports.

Video recorded using: Ignition 8.1

Transcript

(open in window)

[00:00] In this lesson, I'll show you how to populate a report with either alarm data from a database or live alarm events using the Alarm Journal Query data source. From the Data tab, create a new data source and select Alarm Journal Query. On the right side of the window, there are the data source properties, you can change the Data Key and Query Type or you can set up a Nested Query. There's also a drop-down for selecting the name of the journal you'd like the query from. On the left side, you can configure a start date and end date for your query. These checkboxes allow you to select which alarm events to return in your query. I don't want to see system events, so I'll uncheck that. There's also a checkbox that allows you to use current alarm statuses instead of history. If this were to be checked, the journal name property would be ignored. Below this, there's the different filters that you can search against. The Source filter allows you to filter against the source path which includes the tag provider, tag path, and alarm name. The Provider Filter allows you to filter against the tag provider. The Display path filter lets you filter against the display path, which can be customized on each alarm.

[01:10] Finally, the Search Filter will look for your given string in both the display path and source path. Any of these filters can be given multiple strings by separating each string with a comma. Below the filters are drop-downs that will also allow you to specify a minimum or maximum priority for your alarms. Each of these filters can be passed a report parameter that will be evaluated when the report executes. I have a parameter named search param and I'm going to use it with the search filter. I'll click the magnifying glass and select my parameter. I'll head over to the Design tab and we can take a look at the key browser. As you can see, there are a lot of keys that are available with the Alarm Journal Query. I've pulled the display path active duration and event state keys in my table, which will show me how long the alarm was active. If I go over to the Preview tab, we can see what this looks like.

[02:04] Now I'll take a look at a Report Viewer component I have set up in a vision window and we can see the parameter in action. The default value for this parameter was just a blank space. But if I try a couple other strings, we can see that the report will filter records based on the display or source paths that contain that string.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.