Product(s):	WaterSight
Version(s):	10.00.
Area:	Documentation

 

What is an Access Token? How is it used?

An Access Token needs to be configured in order to setup the automatic connection with sensors or smart meter time series data.  The same token can also be used to setup the automatic connection with customer meters and billings (instead of the use of the template file) or with valve status update (automatically updating closed or open status in the hydraulic model from external source), through an API. 

The automatic connection with sensors and smart meters can be done using the sensor data pusher (OFOSC) or rest API. The automatic connection with customer meters properties and billings, which will automatically feed the monthly water balances, is done through API (or by using the upload of the template file). The connection with the valve status is also done using API and allows to automatically update the valves status (closed and opened) in the hydraulic model that is running in WaterSight. For more information about the connection with customer meters and billings or valve status update, please reach to your Bentley point of contact or submit a support ticket. 

In case an Access Token is not configured (or it has expired - they have validity of 1 year) it is not possible to bring those types of data into WaterSight. An access token contains the security credentials for a login session and identifies the user, the user's groups and the user's privileges. This Access Token is specifically used when setting the Data Pusher connection (OpenFlowsOnsiteCoordinator) in order to bring time series data automatically into WaterSight. Can also be used to bring customer meter data or billings into WaterSight. 

The administration page is used to manage access tokens for a digital twin. Up to two access tokens can be added to a digital twin, and the tokens can have an expiration of up to a year.

Upon creating a token, the user will be prompted to copy the token before closing the window. We do not store the token itself, it will be irretrievable once the window is closed. Once a token is deleted, requests that use the token will fail.

 

Configuration Steps (sensors and smart meters)

Steps are the following:

1. The Digital Twin administrator should first create the new Access Token selecting Administration > Access Tokens - Edit

2. Click on “Plus” button (+) to set a new Token. You can leave the existing one that is about to expire – it will be removed automatically after expiration.
3. Adjust the Expiration date – The maximum period is 1 year ahead.

4. Copy the Token and save it in a secured folder.

5. Click Ok.
6. Access the machine where the sensor pusher (OFOSC) is installed.
7. Go to services >> search for the OpenFlows Onsite Coordinator service and stop the service.

8. Access the C:\ or D:\ drive of the machine and look for the OFOSC installation folder.
9. Open the ServiceSettings.ini file using a text editor (for example with notepad).

10. In the “Commonly Edited settings” section lookup the parameter “Service_PersonalAccessToken” and replace the characters that appear there by the new token copied on step 4.

11. Save the ServiceSettings.ini file.
12. Go to Windows Services and Start the OpenFlows Onsite Coordinator service.

13. Check for Errors in the Log files.
14. If you encounter issues, contact Bentley’s support team.

Note: After the Access Token gets saved in the ServiceSettings.ini.file and once the OpenFlows On-Site Coordinator service starts again, the token will be automatically encrypted for security reasons. 

 

Renew the Access Token

The token is valid during one year, after that period it is necessary to renew. If it is not renewed after one year the data pusher (OFOSC) will stop sending data and WaterSight will not have updated sensor data anymore. 

To renew the access token, the user needs to generate a new token in the Admin >> Access Tokens and copy the new token inside the "ServiceSettings.ini" file inside the OFOSC folder. The detailed steps on how to do this are described above.

 

See Also

OpenFlows WaterSight TechNotes and FAQ's

WaterSight Learning Resources Guide

Sensor Data Acquisition Requirements