Niagara Bitpool Uploader Service

Niagara service to upload point and history data to Bitpool

Overview

The Bitpool Tridium Niagara uploader runs as a service under the services container. It's designed to be a simplistic way to extract and connect historical data from Tridium systems to the Bitpool Cloud ecosystem.

Bitpool Niagara Uploader supports both Niagara 4 and Niagara AX frameworks.

Installation Process

Use the following procedure to add a Bitpool Niagara module as a service to your installation.

Step 1

Log into your Bitpool organisation and navigate to the ‘API Keys’ section under the ‘Connections’ menu, generating a new API key with ApiReadWrite. Once created, copy the API key to a safe location, as this will be use later in

Step 2

Install Bitpool module ( nBitpool-rt.jar ) into the root Niagara modules directory of your installation. Note, this may require a Niagara Station restart in order for the module to be seen in the Palette.

Step 3

Select the nBitpool module from the Palette in your Niagara Workbench and drag the BitpoolUploadSvc into the Services container. Open the AX Properties sheet view and provide the following.

  1. Bitpool API Key - paste or enter the API key you previously stored in Step 1

  2. Station Name - (optional) this slot will inherit the name of the Niagara station or alternatively you can provide a descriptive name for the controller itself.

  3. Pool Name - enter the pool name you wish to create or publish to in Bitpool

Step 4

In Workbench, under the new service, select the histories you would like to export to Bitpool Cloud - using the Pool Name provided in Step 3. Hold-Shift to select multiple histories using right-click to bring up the context menu (enable or disable exporting).

Advanced Settings

The following parameters can be tuned to improve performance under high volumes of data upload.

Upload Interval

The upload interval denotes the runtime frequency to which data will be pushed to the Bitpool Cloud environment. This parameter typically defaults to 1 second intervals, however this can be adjusted based on user preferences.

For optimal performance, please leave at the default settings

Upload Max

Denotes the maximum number of records that will be pushed at each upload interval, this parameter can be adjusted based on the device itself.

  • AX JACE - [0-800] recommended.

  • JACE 8000 - [0-2000] recommended.

  • Niagara Supervisor - [0-5000] recommended.

Should you choose to alter the default settings and experience connection alarms, reduce the Upload Max setting until stable operation is achieved.

Fill Gaps

Should Fill Gaps be enabled, the Fill Gaps From date will be used as the starting interval for uploading data to Bitpool.

This feature allows the user to back-fill any missing data, that is currently not in Bitpool.

Connection Alarm

This setting indicates if there have been any connectivity issues to the Bitpool Cloud, if there is an active alarm check the following

  • Is the system connected to the internet ?

  • Do you have an active API key ?

  • Are your Upload Max to high ?

  • Are your Upload Intervals to fast ?

How to License

This module does not require a license, however you must have a valid Bitpool account to generate your API Key.

Downloads

Version History

Last updated