Base Configuration Guide
Introduction
This guide provides basic directions for installing nHaystack and setting up the Synergy software. After completing all the steps, the user will have a range of Reports enabled.
Key Assumption
Before starting the nHaystack download and Synergy setup, it is recommended the IT requirements and supporting VPN documentation below are shared with your company’s IT group.
Service Commitments and System Requirements
In order to have a successful connection, Niagara must be open to “talk” on port 443 and OpenVPN requires outbound access on UDP 1194.
Step 1: Download and Install nHaystack
Note: The following directions and images are based on using nHaystack version AX. Requirements for other versions will be noted.
- Use the table below to download the version of nHaystack that best fits your systems Niagara.
Niagara | nHaystack Version | Download Link |
4.7 - 4.8 | v3.0.1 Beta | https://stackhub.org/download/nHaystack/3.0.1 |
4.9 - 4.10 | v3.1.0.4.9 | https://stackhub.org/download/nHaystack/3.1.0.4.9 |
AX | v1.3.1 | https://stackhub.org/download/nHaystackAx/1.3.1 |
4.9 and up | v3.2.0.4.10.1.36 v3.2.0.4.9.0.198 |
2. Open the download that appears at the bottom of the browser.
3. Install the extracted files in the Modules file folder for Niagara.
Note: Niagara N4 installations will have an additional ".wb" jar file to install.
4. In the Modules folder, open the Palette in Niagara and drag the nHaystack Service into the "services" container in the station.
5. In the Station services, right-click the nHaystack service > select Actions > select Initialize Haystack.
6. Select "UserService" from the Services menu.
7. In the Permissions line select "Super User".
8. In the Password Expiration line select "Never Expires".
9. Click [OK].
Step 2: Create a New Resolute Customer
1. Log in to Synergy through the Resolute Login Portal using the credentials established during the account setup or by clicking the [Sign in with Google] button.
Note: Upon initial login, the Home screen contains no data and will remain in this state until a new customer is created.
2. Click the [Create New Customer] tile. The "Add New Customer" dialog box appears.
3. In the Add New Customer dialog box, do the following:
- Add a Customer Name
- Confirm today's date is in the Start Date text box
- Choose "Reports" as your Fusion Root Feature
- Select "Action Center", "Analytics", "Reports", and "Documents Tab" in the page features section
4. Click [Save].
Step 3: Create a New Connector
1. Click the "Connectors" link in the Customer Tile.
2. Click the [New Connector] button.
3. In the New Connector dialog box, select the "NHaystack" option, then click the [Continue] button.
4. Select the "Connection to a private Niagara Server through OpenVPN" toggle, and click [Continue].
5. In the "Create new VPN" text box, enter the new VPN username. Click [Continue].
6. Click [Download].
7. A download will appear at the bottom of the browser. Click [Open] to run the OpenVPN Installer Setup.
8. Follow the directions on the OpenVPN Setup Wizard.
Note: If further directions are needed for the Setup Wizard, visit the Installing OpenVPN article.
9. After completing the Setup Wizard, in Windows file explorer, navigate to the file log “C:\Program Files\OpenVPN\log\config.log” to confirm the VPN is attempting to connect.
10. Close the log and after 90 seconds, reopen it to confirm the VPN had a successful connection.
11. After receiving the "Initialization Sequence Complete" line in the log, resume setup in the Synergy application. Click [Continue].
12. Entering the Username and Password in the New Connector dialog box. Click [Test Connection].
13. If the connection was successful a “Connection established” dialog box will appear. Click [Create] and you will be navigated to the Point Mapper screen.
Step 4: Map Points
Points coming from an outside source are mapped based on their Metric IDs and run the Rules that feed to the Reports. To use the Bulk Tagging feature in the following steps, all Points associated with the same piece of equipment must be tagged with the same options.
1. On the Point Mapper screen, confirm the "Map Points" operation toggle is selected in the Unmapped tab.
Note: The empty Mapping search bar displays the Asset hierarchy to follow.
2. Apply a mapping filter by double-clicking a MetricID in the table. The Metric ID will appear in the "Step 1: Mapping" search bar.
3. Replace the Metric ID asset in the search bar with mapping assets by double-clicking any section of the Metric ID. The mapping options menu will appear as a dropdown list.
Note: The mapping filter needs a minimum of a {building} and a {point}. However, the best results are achieved by changing all known Assets of the Metric ID.
4. In the menu, click the mapping option that corresponds with the Metric Id assets you want to replace.
Note: The following figure provides an example of replacing Metric ID assets with mapping assets.
5. Click the [Apply] button. The table is filtered based on your selections.
Note: If you have more than one building that matches the mapping filter, select the specific building you want to map points from the "Select Building" dropdown menu, and then click the [Apply] button. Now only the selected points will be mapped as specified for that building.
6. Click the [Map Points] button.
To map another set of points:
1. Click the "Clear Filter" link and the table will repopulate with the remaining Points that have yet to be mapped. It is recommended to repeat this process until all Points related to HVAC equipment and zones have been mapped.
Step 5: Tag Equipment
Equipment Tagging
For the initial setup, only the VAV and AHU Equipment Types will be assigned.
1. Click the Equipment Tagging icon in the side navigation panel.
2. Use the Search and Filter functions to narrow the table results to show all VAV Equipment Types.
Note: Using Search Bar Wildcards
The asterisk symbol (*) is the wildcard identifier and replaces parts of an asset path or display name in searches. Use a wildcard at the beginning to find all equipment that ends with the search term. Use one at the end to find all equipment that begins with the term. Finally, use a wildcard at the start and end to find equipment with any use of that search term and between terms to search by more than one term.
3. After you have finished your query, click the [Apply Filter] button.
4. Select the dropdown menu from the Type column and select "VAV" to bulk tag the Equipment.
5. Click [Apply Changes].
6. Repeat the above steps for AHU Equipment Types.
Assigning Parent Relationships
Parent (airside) relationships must be assigned to the terminal units now that the equipment has been tagged. The process is similar to Equipment Tagging, however, you will be using the Parent and MetaDataTagging tab in the Equipment Tagging Screen.
1. Click the Parent & MetaData Tagging tab at the top of the Equipment Tagging Screen.
2. Select "vav" from the Equipment Type dropdown in the filter bar.
3. Select [Apply Filter].
4. After the table is filtered to only VAV equipment, select the parent unit from the dropdown list.
Note: If there is more than one parent unit available, use the search bar to further refine the VAV equipment results. Repeat the process until all the Parent units have been assigned.
5. Click [Apply Changes].
Step 6: Tag Points
Mapped Points must be tagged so they can be recognized by the system to configure Computed Points, Rules, and Reports. The VAV and AHU points will be tagged for the initial setup.
1. Click the Points Tagging icon in the side navigation panel.
2. Filter data by selecting "vav" in the Equipment Type dropdown menu.
3. Click the [Apply Filter] button.
4. Click the arrow by the "Name" column to sort points alphabetically.
5. Tag the points in the table below for the VAV equipment by clicking the individual point template and selecting the coordinating tag from the list.
VAV |
DaTemp(air, discharge, sensor, temp) |
DaFlow(air, discharge, flow, sensor) |
DaFlowSp(air, discharge, effective flow, sp) |
DmprCmd(air, cmd, damper) |
EffCoolSp(air, cooling, effective, sp, temp, zone) |
EffHeatSp(air, effective, heating, sp, temp, zone) |
RhtCmd(cmd, reheat) |
ZoneTemp(air, sensor, temp, zone) |
ZoneTempSp(air, effective, sp, temp, zone) |
6. Click [Apply Changes].
7. Filter data by selecting "ahu" in the Equipment Type dropdown menu.
8. Click the [Apply Filter] button.
9. Click the arrow by the "Name" column to sort points alphabetically.
10. Tag the points in the table below for the VAV equipment by clicking the individual point template and selecting the coordinating tag from the list.
AHU |
ClgCmd(cmd, cooling) |
DaFanCmd(air, cmd, discharge, fan, run) |
DaFanSpd(air, cmd, discharge, fan, speed) |
DaFanSts(air, discharge, fan, run, sensor) |
DaPress(air, discharge, pressure, sensor) |
DaPressSp(air, discharge, pressure, sp) |
DaTemp(air, discharge, sensor, temp) |
DaTempSp(air, discharge, sp, temp) |
EaDmprCmd(air, cmd, damper, exhaust) |
MaTemp(air, mixed, sensor, temp) |
OaDmprCmd(air, cmd, damper, outside) |
OaDmprMinPosSp(air, damper, min, outside, sp) |
RaFamCmd(air, cmd, fan, return, speed) |
RaFanSpeedSig(air, cmd, fan, return, speed) |
RaFanSts(air, fan, return, run, sensor) |
HtgCmd(cmd,heating) |
11. Click [Apply Changes].
Step 7: Apply Computed Points
Generate Candidates:
- Click the Computed Points icon in the side navigation panel.
- Click the "Generate Candidates" tab.
- Select the checkbox next to "Building Name" to select all buildings.
- Click [Generate Candidates].
Apply Computed Points:
- Click the "Disabled" tab at the top of the screen.
- Select "vav" from the Asset Type dropdown list.
- Select "100.1.4 ZoneTempDev" from the Computed Point dropdown list.
- Click [Apply Filter].
5. The table will display the points based on the filter results. Click [Enable All].
Step 8: Apply Rules
Rules are a key analytical feature that identify performance issues and provide operation parameters for the equipment they are attached to. Generating Rules allows you to get the most up to date data.
Generate Candidates
- Click the Rules icon in the side navigation panel.
- Click the "Generate Candidates" tab.
- Select the checkbox next to "Building Name" to select all buildings.
- Click [Generate Candidates].
Apply Rules
1. Click the "Disabled" tab.
2. Click [Enable All]. All rules displayed on the table will be enabled.
Note: The tables below list all the Rules that should be enabled for VAV and AHU equipment.
AHU Rules |
3.1.1.1 - AHU Simultaneous Heating and Cooling |
3.1.5.1 - Outside Air Damper Does Not Meet the Minimum Position Setpoint |
3.1.8.1 - Operating Outside of Schedule |
3.1.9.1 - Discharge Air Temperature Sensor Failure |
3.1.9.2 - Mixed Air Temperature Sensor Failure |
3.1.10.1 - Discharge Air Pressure Sensor Failure |
3.1.14.1 - Discharge Air Fan VFD Invariant |
3.1.15.1 - Discharge Fan Static Pressure Setpoint Is Greater Than High Limit |
3.1.16.1 - Discharge Fan Static Pressure Is Greater Than Setpoint |
3.1.17.1 - Discharge Fan Static Pressure Is Less Than Setpoint |
3.1.19.1 - Outside Damper Open When Unit Is Off |
3.1.20.1 - Fan Status Off When Commanded On |
3.1.21.1 - Fan Status OnWhen Commanded Off |
3.1.25.1 - Discharge Air Static Pressure Setpoint Can Be Decreased |
3.1.31.1 - Majority of VAV’s In Heating Mode |
3.1.32.1 - Discharge Air Temperature Setpoint Is Less Than Low Limit |
3.1.33.1 - Discharge Air Temperature Is Greater Than Setpoint |
3.1.34.1 - Discharge Air Temperature Is Less Than Setpoint |
3.1.35.1 - Unexpected Temperature Across Cooling Coil |
3.1.37.1 - Low Temperature Differential Across Cooling Coil |
VAV Rules |
3.2.5.1 - Unexpected Increase in VAV Discharge Temperature |
3.2.9.1 - VAV Zone Temperature Sensor Failure |
3.2.9.2 - VAV Discharge Air Temperature Failure |
3.2.16.1 Occupied Zone Temperature Heating Setpoint Above High Limit |
3.2.17.1 - Occupied Zone Temperature Cooling Setpoint Below Low Limit |
3.2.18.1 - VAV Discharge Airflow Sensor Failure |
3.2.19.1 - Zone Temperature Setpoint Dead Band is Too Low |
Step 9: Enable Reports
Each report takes in the Tagged Equipment within a building and performs a calculation that results in a ROS (Resolute Optimization Score), these scores and reports are available to view and download in Fusion.
1. Click the Reports icon in the side navigation menu.
2. Click the "Select All" checkbox by the Building Column.
3. Click [Enable Reports].
Note: The table below lists all the Reports that should be enabled.
Reports |
AHU Controller Performance |
AHU Operations |
High Demand Zones |
IAQ Scorecard |
VAV Controller Performance |
VAV Scorecard |
4. The Enabled tab will display the available reports. This will complete the base configuration setup.