Create an Alarm Journal to Log Events to an External Database
- Go to the Config section of the Gateway webpage.
- Choose Alarming > Journal from the menu on the left.
Look for the blue arrow and click on Create new Alarm Journal Profile.... The Alarm Journal Profiles screen will be displayed.
You have the option of logging alarm journal events to an external database or sending them to a remote gateway's Alarm Journal. In this example, select Database, and click Next. (Configuring alarm journal events to be sent to a remote gateway is addressed in Create an Alarm Journal to Log Events to a Remote Gateway section on this page.
*** Update Step 4 in the External DB section above to include, "logging locally"
Replace the image above with this image. No banner required.
Enter the Name of your alarm journal profile. The default name is 'Journal.' Most of the fields have default settings. Refer to the journal properties table below for setting descriptions, and update as necessary. Click the Create New Alarm Journal Profile button at the bottom of the page. Once completed, the tables will be created for you once an alarm event occurs.
Noteinfo title Using Multiple Alarm alrm Journals
If you only have one alarm journal specified on your Gateway, then you do not need to specify the journal name on the Journal Name property. Ignition will set this for you. If you have more than one alarm journal created, then you need to provide the name of the journal you'd like to query in the Journal Name component property of the Property Editor.
It’s a good idea to trigger a test alarm and verify that Ignition automatically created the tables in the database after your Alarm Journal Profile is created.
Expand title Verify the Alarm Journal tables were created.
You can easily verify the Alarm Journal tables from the Ignition Designer. Open the journal table and go to the menu bar and select Tools > Database Query Browser.
The two tables that Ignition automatically creates are the alarm_events and alarm_event_data. Alarm events consist of two main types of data: the primary information about the alarm, such as transition state, time, etc., and the event data. If you don’t see these two tables in your database, make an alarm occur after the Alarm Journal Profile is created. Make the alarm Active, take it back to Clear, Acknowledge it, and you will start seeing information come into these tables.
Double click to expand the alarm_events to see all the events that occurred when the alarms are Active, Cleared, and Acknowledged.
The alarm_event_data is all the associated data that is associated with each alarm.
You will want to look into the Database Query Browser to simply verify that the information is there. Once the information is there, close the Database Query Browser.
Note: If the tables were not created, check the Gateway Console page for any errors.
Create an Alarm Journal to Log Events to a Remote Gateway
Just like configuring alarm journal events to be logged into a database, it is done from the Gateway Webpage, Config > Alarming > Journal.
To have your alarm journal events automatically sent to a remote gateway's alarm journal, select Remote, and click Next.
Replace the image above with this image. No banner required.
A list of known Gateways will be displayed. If you don't see a gateway that you expected to see, check your Gateway Network settings to verify that the connections are valid. You also have the option to specify a gateway manually. This example selects a valid gateway. Click Next.
If an Alarm Journal exists on the remote gateway, the fields will autopopulate. The name of the gateway and the Alarm Journal Profile name will appear in the Name field prefaced with the alarm journal profile name,(i.e., Ignition_Test_Journal), as shown in the following example. Click Create New Alarm Journal Profile.
You will receive a successful message stating your new Alarm Journal Profile was created.
Remote Gateway Alarm Journal Properties Table
The default name, is the name of the Remote Gateway and Alarm Journal.
Description of the journal profile. Optional
By default. the journal profile is enabled.
Name of the Remote Gateway.
Name of the Alarm Journal on the remote Gateway.
Create an Internal Alarm Journal to Log Events Locally (H3)
Ignition Gateways can now create an Internal Alarm Journal Profile that stores journal entries locally or on a remote gateway.
Go to the Gateway webpage, Config > Alarming > Journal tocreate the Internal alarm journal profile.
Internal Alarm Journal Properties Table
Third Party Accessibility
Because the Alarm Journal uses a SQL database to log alarm events, any application that has access to the database can retrieve journal data. Alarm events can be made freely available outside of Ignition, and integrated into other software packages. Additionally, other applications can write to the same tables, so Ignition applications can monitor activity in other systems.
Alarm Journal Component
While a SQL query will return data from the journal, the Alarm Journal Table component will automatically do so without manually writing a query. The component can filter on both Display Path and Source Path, as well as Date Range. The component can be configured to a single Journal Profile, so multiple instances of the component in the same project may look at different profiles.
More information on this component can be found on the Alarm Journal Table Component page.
|Name||The default name is Journal.|
|Description||Description of the journal profile.|
|Enabled||By default. the journal profile is enabled.|
This is the ONLY required setting which must be a valid database connection. Events are stored to this datasource.
|Minimum Priority||Only events equal to or greater than the specified priority will be stored. The default is Low. You can set the priority to be: Diagnostic, Low, Medium, High, and Critical.|
|Store Shelved Events||Not enabled by default. If enabled, events generated by "shelved" alarms will still be written to the journal system.|
|Use Store and Forward||Enabled by default, which means the alarm journaled events will be stored through the Store and Forward system. If not enabled, they will be stored directly against the database. This system protects data from being lost due to temporary database connectivity issues.|
Stored Event Data
Alarm events consist of two main types of data: the primary information about the alarm, such as transition state, time, etc. , and the event data.
|Static Config||By default, it is not selected. If selected, will store the values of static alarm configuration. That is, the alarm properties that are not bound. These do not change during evaluation, only when a user modifies them in the Designer, and so they are not stored by default.|
|Dynamic Config||If selected, will store the values of dynamically bound alarm configuration properties. The value of these properties can change at any time, and the values at the time of the alarm are captured on the alarm event.|
|Static Associated Data||If selected, will store the values of non-bound associated data (properties created by the user) properties on alarm that do not change during execution.|
|Dynamic Associated Data||If selected, will store the values of dynamically bound associated data (properties created by the user) properties.|
|Filter by Alarm Source||Only events matching the source will be stored. Multiple sources to match can be comma separated. Leave blank to store events from all sources.|
|Filter by Display Path||Only events matching the display path will be stored. Multiple display paths to match can be comma separated. Leave blank to store events from all display paths.|
|Filter by Display Path or Source||Only events matching the display path, if defined, will be stored. Multiple matches can be comma separated. If no display path is defined, only events matching the source will be stored. Leave blank to store all events.|
|Enable Data Pruning||If selected, data will be deleted after the specified time period as set by the Prune Age and Units below. Default is false. Note that since the data is stored directly in a database, an administrator is free to manually delete data at any time.|
|Prune Age||The number of Prune Age Units to store data for. i.e., 1 year, 5 hours, etc. The default is 1.|
|Prune Age Units||The type of Prune Age Unit. Default is Years. You can choose the unit to be Milliseconds, Seconds, Minutes, Hours, Days, Weeks, Months, or Years.|
These settings let you specify your own table names. This is especially useful when trying to use multiple alarm profiles within a single database (not common, but can happen, especially with multiple systems sharing a single database).
|Table Name||The table name for the core event table. The default is |
|Event Data Table Name|
The table name for event data associated with alarms. The default is
The Alarm Journal system will automatically create the necessary tables for you, and scripting functions can be used to query the system without having to know about the table structure. However, understanding the structure of the Alarm Journal tables can be useful for accessing the data in situations where SQL queries are more convenient.
Alarm Events (
This table stores the core data for each event that occurs. An event is a transition for an alarm between active, cleared, or acknowledged. Additionally, other events may be stored in this table that aren't directly related to an alarm, such as a system shutdown event. This table defines a primary key "id", that is used as a foreign key by the Alarm Event Data table, which stores additional information for each event.
|id||integer||A unique integer id for each event entry event|
|eventid||string||The UUID of the alarm event that this individual event is related to. Each |
The qualified path of the entity that generated the alarm event. See below for more information about qualified paths.
The value set for the "Display Path" of the alarm. Generally a user defined, friendlier version of the source.
The priority or severity of the alarm:
The type of transition represented by this event:
A numeric bitmask flag field providing additional information about the event.
Bit 0: System Event - One of the designated system events. (System Startup, System Shutdown)
|eventtime||datetime||The time of the event.|
Alarm Event Data (alarm_event_data)
This table stores the properties associated with an alarm event. The individual event is referenced through the
ID column, against the alarm event table.
|id||integer||The id that corresponds to the alarm event in the alarm_events table.|
|propname||string||The name of the property. May be one of the common alarm properties (a configuration setting), or the name of an associated data property.|
|dtype||integer||The data type of the property, indicating which data column should be used:|
The corresponding value columns for the property. Unused columns will
A qualified path in Ignition is a path to an object, described by various annotated components. Each component has a type identifier and a value, separated by a colon (
:), and each component is separated by colon-forward slash (
:/). For example, an alarm is identified by
alm:Alarm Name. It usually exists under a Tag, in which case, its fuller path would be
tag:Path/To/Tag:/alm:Alarm Name. Paths can be built up further depending on the level of specificity required by the situation.