Sync Niagara Alarms

Owned by Ricky Villa
Last updated: Aug 06, 2021 by Kimberly Cruz (Unlicensed)
4 min read

Sync Niagara Alarms

In order to sync the alarms made in Niagara, the user will need to do a few things in Niagara to be able to upload them to FIN. The alarm sync goes one way from Niagara to FIN.

Make sure the points exist in FIN and all are either from the "Site" or “Component” space not a combination of both.

How to sync Niagara Alarms

The user will have to have the latest NHaystack module.

1. Open the Palette in Niagara and find the nhaystack module

2. Once its open, drag and drop the NHaystackNetwork onto the Drivers folder under Config

3.Now NHaystackServer needs to be drag and dropped on the NHaystackNetwork driver just added.

4. Once the NHaystackServer is added, double click on NHaystackServer to fill out the following properties:

 

  • Internet Address: This is the IP that FIN Stack is running on (ie - 10.10.10.101:85)

  • Uri Path: /api/{projectName} (ie - /api/demo)

  • Credentials: Credentials to FIN Stack (ie - su/1234)

5. Then either right click towards the top of that NHaystackServer window or on the NHaystackServer itself and ping it to update the status to make sure it is ok.

Warning

 If it fails to connect when pinging and the error is this: org.projecthaystack.client.CallHttpException: 415: Unsupported Content-Type: text/plain; charset=utf-8, then go to the Host → Settings → API and enable “Allow Text Plain”.

Once the setting has been saved, try to ping it again.

6. Now from the Palette, drag NHaystackAlarmRecipient to AlarmService.

7. Then wire the NHaystackAlarmRecipient to the alarm class(es) used.

8. After its wired, double click on the NHaystackAlarmRecipient and then add the path of the NHaystackServer to the Haystack Server slot

  • The navigation window can be used to get the path or right click on the NHaystackServer to copy and paste the path in the slot

9. There are two other slots that also need to be filled out and they are the Misc Alarm Ref and Haystack Conn Ref.

  • Misc Alarm Ref - Needs to be the id of the site where the misc alarms that don't follow the standard layout to be displayed.

    • In the event there are some random alarms floating around, it will show up under the site chosen here. (ie - @p:demo:r:1eeaef2d-fd0e9c29)

  • Haystack Conn Ref - This will include the id of the connector from where the alarms are coming from. (ie - @p:demo:r:27d431e3-a88c6fc7)

How to include them into subscriptions

1. Add a haystack slot to the alarm class(es) being used.

2. Drag the alarm class(es) into the NHaystackService spot where it states to drag the components to add the haystack slot.

3. After doing that, the alarm class(es) will have the haystack slot.

4. From there, click on the blue arrow next to the slot and add some marker tags on which the subscription for alarms is running on.

  • In this case, the alarm subscription is running on demoAlarm and hvac marker tags. Add those marker tags so that when an alarm is triggered and it has those tags, it will send out an email.

5. Then hit OK to apply and save the settings.

  • After its saved, when something gets triggered on those tags, it will sent a subscription email

Functionality Supported

Below is what we support.

  • If active alarm is acknowledged in FIN, then an ACK is sent to Niagara. It will remain active in FIN and Offnormal in Niagara.

  • If active alarm is acknowledged in Niagara, then it returns to Normal in FIN.

  • Same alarm record is used whenever alarm states change. Doesn't create a new alarm record per state.