# Niagara Bitpool Uploader Service

## 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.
>
> The Uploader is not compatible with Niagara 4.11.3 due to a known issue with oBIX in this revision of Niagara.

## 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

<figure><img src="/files/WhQkRp0wVvBfqy3KJ68i" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/SagtT1fiZ1zrB4Z3ts3c" alt=""><figcaption></figcaption></figure>

### 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

<figure><img src="/files/RGyLz7CfmXeiyhVaZQvc" alt=""><figcaption></figcaption></figure>

### 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).

<figure><img src="/files/7SrpYbvaaUKYMGgLncfL" alt=""><figcaption></figcaption></figure>

## Advanced Settings

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

<figure><img src="/files/4GjcUxQ4za6WX00KwVp7" alt=""><figcaption></figcaption></figure>

### 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

<table><thead><tr><th width="121">Version</th><th width="140">Driver</th><th width="96">Niagara Version</th><th>Comments</th><th data-type="files">Downloads</th><th data-hidden></th></tr></thead><tbody><tr><td></td><td></td><td></td><td></td><td></td><td>Documentation</td></tr><tr><td>4.11.0.142</td><td>nbitpool-4.11.0.142.zip</td><td>N4.x</td><td>v1.1.6 Added String point uploading and stricter history type selector. Self-signed.</td><td><a href="/files/3jdMfePu8mQmg8EWGAXs">/files/3jdMfePu8mQmg8EWGAXs</a></td><td>refer above</td></tr><tr><td>4.10.1.36</td><td>nbitpool-4.10.1.36.zip</td><td>N4.x</td><td>v1.1.6 Added String point uploading and stricter history type selector. Self-signed.</td><td><a href="/files/a9EYyi0n2prsZ53ZXbus">/files/a9EYyi0n2prsZ53ZXbus</a></td><td>refer above</td></tr><tr><td>4.9.0.198</td><td>nbitpool-4.9.0.198.zip</td><td>N4.x</td><td>v1.1.6 Added String point uploading and stricter history type selector. Self-signed.</td><td><a href="/files/HWeuoZ4sw8RaPWfI3rCP">/files/HWeuoZ4sw8RaPWfI3rCP</a></td><td>refer above</td></tr><tr><td>4.8.0.110</td><td>nbitpool-4.8.0.110.zip</td><td>N4.x</td><td>v1.1.6 Added String point uploading and stricter history type selector. Self-signed.</td><td><a href="/files/ZFRGajNwvxI1kz3R32Gk">/files/ZFRGajNwvxI1kz3R32Gk</a></td><td>refer above</td></tr><tr><td>4.7.109.20</td><td>nbitpool-4.7.109.20.zip</td><td>N4.x</td><td>v1.1.6 Added String point uploading and stricter history type selector. Self-signed.</td><td><a href="/files/bPLJ43jvrJ6KhZavCjTB">/files/bPLJ43jvrJ6KhZavCjTB</a></td><td>refer above</td></tr><tr><td>4.6.96.28</td><td>nbitpool-4.6.96.28.zip</td><td>N4.x</td><td>v1.1.6 Added String point uploading and stricter history type selector. Self-signed.</td><td><a href="/files/qFeE9aNDs3BZ6efhgqdm">/files/qFeE9aNDs3BZ6efhgqdm</a></td><td>refer above</td></tr><tr><td>4.4</td><td>nbitpool-4.4.zip</td><td>N4.x</td><td>v1.1.6 Compiled for niagara v4.4</td><td><a href="/files/Os5vO0bU5QqpKUibz13n">/files/Os5vO0bU5QqpKUibz13n</a></td><td>refer above</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki-cloud.bitpool.com/bitpool-cloud-platform/niagara-connectors/niagara-bitpool-uploader-service.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.