How to Log Any Source Alarms to PostgreSQL

Open Automation Software aggregates data from any number of sources in one place. Each Tag carries its own Data Source, so a Tag can be read by any of the OAS Drivers, set directly as a Value Tag by hand or from your own application through the OAS Data API, or derived in real time by a Calculation Tag built from one or more other Tags no matter where those Tags get their own values.

Alarm limits are set on the Tag itself, so alarms raised by Tags fed from completely different sources are logged together to a PostgreSQL database.

This guide walks you through downloading and installing OAS, creating a Tag, assigning its Data Source, setting an alarm limit and configuring alarm logging to a PostgreSQL database.

For this guide on how to log any source alarms to PostgreSQL you will need:

• A data source for your Tags, such as a device, broker or database reachable by one of the OAS Drivers. Value Tags and Calculation Tags need no external source.
• A PostgreSQL server and database

1 - Download and Install OAS

If you have not already done so, you will need to download and install the OAS platform.

Fully functional trial versions of the software are available for Windows, Windows IoT Core, Linux, Raspberry Pi and Docker on our downloads page.

On Windows, run the downloaded setup.exe file to install the Open Automation Software platform. For a default installation, Agree to the End User License Agreement and then click the Next button on each of the installation steps until it has completed.

If you'd like to customize your installation or learn more, use the following instructions:

• Windows Installation
• Linux Installation
• Raspberry Pi Installation
• Docker Installation

The OAS Service Control application will appear when the installation finishes on Windows.

Click on each START SERVICE button to start each of the three OAS services.

2 - Configure OAS

Web Configuration Application

Configuration of the OAS server is performed from the built-in Web Configuration Application. This is the main application for accessing any settings within the OAS server and is completely self-contained within the server.

You can reach this by opening your browser to:

http://<your server>:58725/app/config

If you are browsing from the OAS machine itself, you can use localhost, otherwise use the IP address of the machine. You will also need to ensure port 58725 is open on both the client and the server or you may not be able to reach the application.

On a new installation the OAS engine has no accounts yet, so the first screen you see is Create Admin Account. Once the administrator account exists that screen is not shown again, and browsing to the application displays the sign in screen instead.

1. Enter a name for the administrator in the Admin user name field. Typically you would use admin, but you can use whatever name you choose.

2. Enter a password in the Password field, then enter the same password again in the Confirm password field.

3. Click on the Create admin & sign in button. The account is created and you are signed in to the engine.

To sign in from then on, enter the Network node of the OAS engine, then the Username and Password of your account, and click on the Sign in button.

Legacy Configuration Application

1. From your operating system start menu, open the Configure OAS application.

2. Select the Configure > Tags screen.

   Important

   If this is the first time you have installed OAS, the AdminCreate utility will run when you select a screen in the Configure menu. This will ask you to create a username and password for the admin user. This user will have full permissions in the OAS platform.

   For further information see Getting Started - Security.

3. If this is the first time you are logging in, you will see the AdminCreate utility. Follow the prompts to set up your admin account. Otherwise, select the Log In menu button and provide the Network Node, username and password.

   

   

3 - Add Data Source Tag

In this section you will create a Tag to represent your data point in the field (for example a temperature sensor). This can then be transferred your desired destination.

1. In the sidebar menu, select Tags.

   

2. If you want to add a Tag to the root Tags group make sure another tag at the root is selected. Click the [+] button and select Add Tag.

   

   If you want to add a Tag to a Tag Group, select the Tag Group first and then click on the [+] button. Alternatively, you can right click on a Tag Group and select Add Tag.

   You can also add Tag Groups by clicking the [+] and selecting Add Group.

3. Provide a Tag Name such as TemperatureSensor and click the Create button.

   

4 - Assign the Tag Data Source

Every Tag in OAS carries its own Data Source, which is what makes aggregation possible. One OAS instance can hold Tags fed by a PLC, a cloud broker, a database and a calculation all at the same time, and everything downstream works from the Tag list rather than from the driver. That is why a single logging group or a single publish list can carry values that arrived from completely different places.

You will now set the Data Source of the Tag you created in the previous section.

1. Select the TemperatureSensor Tag.

   

2. Set the Data Source to whichever source supplies this Tag. Any of the following can drive it:

   • A driver. Set the Data Source to the driver you want to read from, then set the Select Driver Interface drop-down to the driver interface you configured, and complete the addressing properties for that driver. The Drivers section describes every driver, what it supports and how to configure it.

   • Value. Set the Data Source to Value for a Tag whose value is written to it rather than polled from a device. You can set it by hand in the Web Configuration Application, or write to it from your own application with the OAS Data API. Setpoints, recipe values, operator entries and values pushed in from an external system are all handled this way.

   • Calculation. Set the Data Source to Calculation to derive the value from other Tags. A Calculation Tag is evaluated in real time whenever any Tag it references changes, and it can reference one or more Tags regardless of what their own Data Sources are. This lets you convert units, scale raw counts, roll several machines up into one figure, or combine a device reading with a value that came from the cloud, before any of it is logged or transferred. See How to Create a Calculation Tag for a worked example, and the Calculations reference for the full function list.

3. Complete the remaining properties for the Data Source you selected. Driver Tags also have a Polling Rate property that sets how often the value is read, in seconds [default: 1 second].

4. Click on the Apply changes button to apply the changes.

5. Check that the quality status is Good and the Tag value is as expected.

   

5 - Set Tag Alarm Limit

1. Select the Tag where you want to enable the alarm limit.

   

2. Expand the High section to open the high alarm limit configuration.

   

3. Configure the following setting to enable the high alarm limit:

   • Turn on Enable Alarm
   • Set the High Limit value to your desired value threshold for triggering the alarm

   Optionally you can also configure:

   • Alarm Text to customize the alarm text that will be shown. You can combine this with different Alarm Text Type settings in order to prepend, append, overwrite or replace the alarm text with a calculation.
   • Group to categorize the alarm into a specific group. This can be used to filter alarms when configuring logging and notifications.
   • Priority to order and apply a specific priority to each alarm.
   • Time Delay which suppresses the alarm for the specified amount of time after it is triggered.
   • Log As Event which means the alarm will only be recorded as a single instance without an acknowledgement state.

   

4. Click on the Apply changes button to apply the alarm limit configuration.

6 - Configure Alarm Logging

You will now configure alarm logging to a PostgreSQL database.

1. Select Alarm Logging in the sidebar.

2. Click + Add, enter a meaningful Logging Group Name to give this alarm logging group a unique name, and click Create. Once created, the alarm logging group name should appear in the list of logging groups. An alarm logging group is defined by a specified filter, OAS node list (default localhost) and database connection or CSV file configuration.

3. In the Common section turn on Logging Active. New logging groups are created inactive, so this is what makes the logging group active. Leave the remaining values at their defaults.

   

4. In the Filters section you can customize which alarms should be included in your logging. This includes filtering by:

   • Alarm state
   • Alarm priority
   • Alarm type
   • Alarm group

   

5. In the Nodes section you can leave the default settings if you only want to include alarms generated on the local node. The localhost node is added to the list automatically.

   

6. In the Database section you will configure the database type and connection parameters:

   • Turn on Log to Database to enable logging to a database
   • Set Provider to PostgreSQL
   • Set Server to your PostgreSQL server (e.g., localhost)
   • Set Database to AlarmLog
   • Set Table to a table name such as Alarms
   • Set User Name to a user with permissions to manage the AlarmLog database
   • Set Password to the user password

   

7. Click on the Apply changes button to apply the alarm logging group configuration.

   

8. Your alarm logging group is now active.

7 - Save Changes

Once you have successfully configured your OAS instances, make sure you save your configuration.

On each configuration page that has a Save button, click on it.

If this is the first time you are saving the configuration, or if you are changing the name of the configuration file, OAS will ask you if you want to change the default configuration file.

If you select Yes then OAS will make this configuration file the default and if the OAS service is restarted then this file will be loaded on start-up.

If you select No then OAS will still save your configuration file, but it will not be the default file that is loaded on start-up.