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

Overview

This article describes the procedure to configure the OpenFlows Connector for the Power BI’s On Premise Data Gateway Service provided by Microsoft. The on-premises data gateway service acts as a bridge with to provide the data transfer between data sources like OpenFlows WaterSight, and Microsoft cloud services, like Power BI’s. By using the gateway, users can keep the dashboards automatically updated with a predefined frequency. 

The Power BI’s Data Gateway application needs to be installed in a server/machine that is operating all the time (24/7) if you are planning to have reports updated every day. If you install this app in your work machine, for instance, if it shutdown or sleeps for any reason, the gateway’s service will be stopped, and all scheduled refreshes will be suspended. 

The following picture illustrates the architecture and workflow of the gateway connection. The Power BI construction should be done using Power BI’s Desktop application, and it can be connected to different data sources, including WaterSight’s. This connection is explained in another user manual available here: A Guide on how to create PowerBI Reports.

Once having the Power BI report done, it needs to be Published to Power BI’s web capacity held by your account/company, and its embedded URL can be stored into WaterSight (process also explained in a separated manual). The automatic update of this report will be handled by the Power BI’s data gateway service, that is configured in the Power BI’s workspace management accessed by any internet browser, then user can configure the automatic refresh frequency. 

Architecture

Prerequisites 

In order to execute the installation and configuration of the on-premise data gateway software, user must need to hold a valid Power BI license that enables the usage of Power Bi Desktop application and publication of dashboards to Power BI cloud. For more information about Power BI license, user must contact a Microsoft representative. 

This manual was written using as base the version 3000.182.5 of the on-premise data gateway (July 2023).  

The executable file to install the application should be downloaded in advance.  

For support and guidance, access the following link: 

https://learn.microsoft.com/en-us/data-integration/gateway/service-gateway-install 

It’s recommended to install the gateway on a 24/7 server if you are planning to have continuous dashboard updates. The installation adds a Windows Service named “On-premises data gateway service”, and runs initially using the local service account “NT SERVICE\PBIEgwService”: 

This account can be changed during the creation of the gateway connection. 

A- Downloading the OpenFlows Connector  

• Before configuring the data gateway service, log in to WaterSight and open the Digital Twin. 
• Access the Administration page and Click in Download > Power BI Gateway Connector. 

 

It downloads a file named “OpenFlowsConnector_Gateway.mez” 

• Using Windows Explorer, create a folder to store the Connector file. 
• Move the Connector file to this folder. 

The user that runs the service should have read/write permission access to this folder. 

B - Installation of the Gateway application 

Before installing the Gateway application, move the OpenFlows Connector to a separated folder like “Documents/PowerBI_Connectors”. This folder will be referenced during the configuration of the application. 

• Run the Executable file as Administrator. 
• Follow the installation instructions as follows: 

 

• Click Install 
• Enter your Power BI’s user email address 

• Click in Sign In 

• Select the Option to Register a new gateway on your computer 
• Click Next 

1. Enter a Name for the Gateway service 

1. Create a recovery key (save it in a text file for cases that you need to reinstall the gateway service). 

1. Click in Configure 

When done it opens the On-premises data gateway application: 

This application also installs a Windows Service named “On-Premises data gateway service, that is configured to Automatic restart after computer restart, and it run using a Service account named “PBIEgwService”. 

 

C - Configuring the Gateway Connector Service 

• If you close the app, you can reopen thru Start Menu: 

• Log in using your Windows credentials if needed 
• Using the left panel, click in “Connectors” 
• Click in the Ellipsis button to locate the folder that stores the OpenFlows Connector MEZ file 

• Click in the “Service Settings” tab thru the left panel 

• Click in Restart Now  
• After getting the application restarted, open the “Connectors” tab and check if the OpenFlows Connector is listed in the table as follows: 

This concludes the installation of the Power BI’s On Premises Data Gateway service. 

 

D - Creating a Connection in the Power BI Workspace 

• Access the Workspace where you published the Power Bi reports using the link https://app.powerbi.com/. Use the same credential used in the Gateway app configuration. 
• Click in the gear icon (upper right corner) and select “Manage connections and gateways”. 

• Click in the “On-Premises data gateways” tab and confirm that you have listed the Service you created thru the application: 

• Select the tab “Connections” 
• Click on New 

• Using the Panel that open on the right, select the On-Premise gateway created as “Gateway cluster name” 
• Set a name for the connection 
• Select “OpenFlowsConnector” as “Connection Type” 

• In the Authentication Method, select “OAuth 2.0” and click in the Edit Credentials 

• Enter your WaterSight user credentials 

• Click in Create 

E - Configuring the Automatic Refresh of a Power BI Report 

• Still in your Power BI Workspace, click on “My Workspace” using the left panel 

• Select the dataset to be configured and click in the Ellipsis button: 
• Click in “Settings” 

• Expand the “Gateways and cloud connections” group 
• Select the radio button next to the Gateway name (“OpenFlows_23_09” in the example – Defined on Item B-8) 
• Select the connection under the “Maps to” field (“WaterSight_23_09” in the example – Defined on Item D-14) 

• Expand the “Refresh” group and turn on the key to enable the Refresh Schedule: 
• Select the Refresh frequency and Timing desired 

• Check the Option “Dataset owner” if you desire to receive email if any refreshed scheduled fails. 
• Click Apply. 

 

See also

Accessing PowerBI reports in WaterSight

PowerBI Administration

Creating PowerBI Reports

OpenFlows WaterSight TechNotes and FAQ's

WaterSight - Learning Resources Guide