Bitpool Uploader
This section is a continuation from the Niagara Uploader. Example shows the process of using the Bitpool Uploader with the oBIX data source. Follow the steps with the relevant prompts for your data.
Bitpool Uploader
Check there is a Bitpool organisation created for the project that you are working on by logging into the Bitpool dashboard environment.
If there is no organisation, create a new organisation or contact Bitpool support to create the organisation.
Log into the organisation.
Bitpool Uploader User
Register a generic admin user in the Bitpool organisation for the Bitpool uploader login credentials.
Example: [email protected]
Contact [email protected] with the name of the account and the name of the Organisation you want it created in. The Bitpool Support team will create the new account and set it to the organisation you requested.
Hi Bitpool Team,
Could you please create a new account to be used with the Bitpool Uploader.
Account Name: [email protected]
Organisation Name: ACME Ltd
Company Name: ACME Ltd
ThanksThe user will now be in the User management console under the organisation.
Downloading the Bitpool Uploader
You must be an admin member of a Bitpool organisation to download the Windows uploader.
Log into Bitpool https://app.bitpool.com/login
Go to the main menu by clicking on the double back arrow.
Click on Connections, then select the Virtual Edge Uploader.
Click on the Download button.
The uploader will download, and the file is called “Bitpool.Uploader.Setup.msi”
Installing the Uploader
Copy the above downloaded file “Bitpool.Uploader.Setup.msi” to the host workstation where the data source resides. Double click on the Bitpool uploader setup executable and start the setup process.
When the Bitpool Uploader has been installed a desktop shortcut will automatically appear on your desktop with the Bitpool Logo on it.
Double click on the Bitpool Uploader icon.
Log in on the screen below:
Make sure you are logged into the organisation in app.bitpool web portal.
Click on Create (Don’t have a API Key).
This should take you to API Keys in the web portal.
Click on generate API Key and fill in the place. Key Type should be APiReadWrite. Click on generate.
Copy the API Key and paste into the log in screen and login.
Do not start the service.
Bitpool Uploader Station Settings and Creating the Data Pool
Select the station settings tab.
Click on the register New Pool button and create a new pool – this will be the new name of the Organisation pool where the streams / data will reside.
A pool will be created in the orginisation.
Enable the pool in the uploader by clicking on the check box.
This will populate the top righthand corner of the uploader with the new pool.
Connecting to Local Database
Select the Datasource settings tab and select the system that the Bitpool uploader is connecting with.
In this case select the oBIX database source.
When the icon oBIX is selected, the settings page will appear.
Complete the server, username, and password entries. (The username and password are the same ones as the Niagara oBIX User that was created in section 2.1.2). The entry for the server is http://localhost/obix
After filling in the selections, click on the test connection box. The uploader pop up window should indicate the ‘connection successful’ by displaying a popup.
If the uploader does not connect you can check the following:
Recheck you have entered the username and password correctly.
Check the Webservice is using port 80. To check this, go to the Niagara workstation, click on the station, then config, then Services and then double click WebService. Check the http port number.
If it’s not port 80 like shown in the example above, you must add that port number to the Bitpool Uploader Server section as shown below. The entry for the server will be http://localhost:85/obix
After updating the Server properties, re-test the connection.
Click OK. Use the Database drop down menu to select the database that you will be connecting with.
Point Selection
Click on the Point Selection tab at the top of the page in the Bitpool Uploader.
To import all the points, click on the Select All button at the bottom of the page.
Selective Point Selections
For selective point selection, there is a filter feature that helps you select multiple points at once, as shown in the example below. Click on the icon in the point name header.
This provides a drop-down selection box. Use this box to select the data point that you require.
In the example below the ‘is equal to’ drop down box is changed to ‘Contains’. chw_valve is added in the text section and then click on the Filter button. This has now produced all data points containing the word chw_valve. All CHW Valves can now be selected for upload by clicking on the select all button.
Uploading Data
After selecting the points needed, click on the summary tab in the top lefthand corner. Click on the Start Service button and the uploader should start uploading the points to the organisation pool that was created earlier. The stream status should change to transferring.
Backing Up
Locate the Windows Bitpool folder under the Program data folder.
Copy the “config-uploader.json” file to your back up folder for future use.
Restoring a Backup
Paste the backup file (config-uploader.json) file from your back up directory into the Windows Bitpool folder under the Program data folder.
Trouble Shooting
The OBIX uploader is not compatible with Niagara 4.11.3 due to a known issue with oBIX in this revision of Niagara.
Data has stopped uploading into the pool.
Check the connection alarm reads “False” if this is true the connection has been lost to the Bitpool Pool.
Log into the app.bitpool.com portal – Find the organisation that the uploader is uploading to.
Locate the ApiReadWrite key for the organisation and copy the key, paste it into the Bitpool Api Key in the uploader. Yellow Image box above.
Right click on the title of the uploader – select Actions and then select restart the service.
If the connection alarm remains as True after a minute – create a new Read Write API key for the organisation and repeat the process.
Some Data has stopped uploading into the pool or the uploader is stuck.
This is normally due to one or more rogue histories.
Check the waiting in queue figure is reading zero or counting down. If the figure matches the upload Max figure and is not transferring figures, there is a issue with the data.
Change from the Property sheet to the History manager.
Check the Histories that are being uploaded – too many irregular histories can cause the uploader to lock up. Make sure no histories are less than 1-minute intervals.
You will need to disable any suspect histories. After disabling the Histories, restart the service as per screen shot in item 2.
Watch the waiting in Queue figure, wait a couple of minutes. If the data is not uploading, repeat the process.
Last updated