Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

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.

Info

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

How to sync Niagara Alarms

The user will have to have the latest NHaystack module. At least version 1.2.5.8 or newer.

1. First, the user will have to open Open the Palette in Niagara and find the nhaystack module

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

Image RemovedImage Added

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

Image RemovedImage Added

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

Image Added

  • 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)

Image Removed

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

Image Removed

Image Removed

5.

Image Added
Note

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”.

  • Image Added

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

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

Image RemovedImage Added

6. The user will then 7. Then wire the NHaystackAlarmRecipient to the alarm class(es) used.

Image RemovedImage Added

78. After its wired, double click on the NHaystackAlarmRecipient and then you'll see 'Haystack Server' slot.

You'll need to

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.

Image Removed
Image Added

Image Removed

89. 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 you wish all where the misc alarms that don't follow the standard layout to be displayed.

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

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

Image RemovedImage Added

How to include them into subscriptions

First the user will have to add 1. Add a haystack slot to the alarm class(es) being used. That can be done by dragging

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

Image RemovedImage Added

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

Image RemovedImage Added

4. From there, we'll need to 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,

our
  • the alarm subscription is running on

"
  • demoAlarm

"
  • and

"
  • hvac

"
  • marker tags.

So we'll add
  • Add those marker tags so that when an alarm is triggered and it has those tags, it will send out an email.

Image RemovedImage Added

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

  • After its saved,

you are set so you'll receive subscription emails as soon as
  • when something gets triggered on those tags

.Image Removed
  • , it will sent a subscription email

Image Added

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.