Product(s): | WaterSight |
Version(s): | 10.00. |
Area: | Documentation |
WaterSight consists on a cloud application which heavily relies on integration with real time data from sensors (from SCADA systems, dataloggers or any other telemetry system). To automatically integrate this data there are two main methods:
Below it is presented a summary with the main types of connection.
For more complete detail on how to setup the connections, please ask your Bentley point of contact for the OFOSC and RestAPI Detailed Guide.
1. Data Pusher (OFOSC) - Types of connection
WaterSight consists of the cloud application and includes also an on-premise software tool called the “Sensor data pusher.” The WaterSight Sensor Data Pusher collects and pushes the raw Sensor values periodically to the WaterSight cloud database at a predefined interval. The sensor data pusher can connect to the following data sources:
The data pusher should be installed in a on-premise machine or server that has the right access to the defined data sources, in order to ingest raw Sensor data into WaterSight in the Azure cloud. The installation of this pusher tool will only be done after the utility provides all the access and permission to the on-premise machine and data sources.
Information that the utility needs to prepare (if database connection):
If sensors and smart meters are both available, it is required to set up two instances of the OFOSC, one for sensors and the other one for the smart meters.
Data Pusher General Architecture
Minimum data requirements for the server where the Sensor data pusher gets installed:
As an alternative to the data pusher, an existing REST API connection can be used if available. In this case, there is no need to install any on-premise component and all the work is done by WaterSight.For this case, the requirements are the following:
Below is an example:
Request:
URL:
GET https://api.mycompany.com?tagId=MySensorTag&startInstant=20230101010000&endInstant=20230201020000
Header:
Authenthication: Bearer MyPersonalAccessTokenHere
Response:
Body:
[
{
“timestamp”: “2023-01-01 00:00:00”,
“value”: 20.0,
},
{
“timestamp”: “2023-01-01 01:00:00”,
“value”: 30.0,
},
{
“timestamp”: “2023-01-01 02:00:00”,
“value”: 15.2,
},
]
In the request url above, “tagId”, “startInstant” and “endInstant” are just examples of the 3 minimum parameters required, and can be replaced by aby naming convention. They can also exist in any part of the URL (e.g. in the base url route or as query parameters).
In the response body above, “timestamp” and “value” can be replaced by any naming convention.For other structures not described above, some additional customization may be required and should be discussed with the Bentley team.
OpenFlows WaterSight TechNotes and FAQ's
WaterSight Learning Resources Guide