Use the on-premises data gateway app

Note

We recently revised the on-premises data gateway docs. We split them into content that's specific to Power BI and general content that applies to all services that the gateway supports. You're currently in the general content. To provide feedback on this article, or the overall gateway docs experience, scroll to the bottom of the article.

To open the on-premises data gateway app:

  1. On the machine where the gateway is running, enter gateway in Windows search.

  2. Select the On-premises data gateway app.

    Search for On-premises data gateway app

    On-premises data gateway opening dialog box

Some of the on-premises data gateway app features can be used only after you sign in to your Office 365 account. For example, under the Service Settings tab, you can restart the gateway without signing in, but you can't change the service account of your gateway without signing in.

Example of actions that can and can't be taken without signing in

On-premises data gateway app features

After you sign in to your Office 365 account, you have access to the following features in the on-premises data gateway app.

Tab Service Description
Status Status of the gateway cluster Indicates whether your gateway is online, the version number of the gateway, and a list of any apps currently associated with the gateway.
Service Settings Restart the gateway Provides a way of restarting the gateway whenever a restart is needed.
Service Settings Gateway service account By default, the gateway is configured to use NT SERVICE\PBIEgwService for the Windows service sign-in credential. You can change the service account to a domain user account within your Active Directory domain. Or, you can use a managed service account to avoid having to change the password.
Diagnostics Additional logging Turning this feature on provides additional verbose information in the log file, which includes duration information. This information can be useful in figuring out why some responses through the gateway are slow. Enabling this feature could increase the log size significantly depending on gateway usage. So, we recommend that you don't leave this setting enabled long term.
Diagnostics Gateway logs Provides a copy of all of the gateway logs in a single file in .zip format.
Diagnostics Network ports test Checks if the gateway has access to all required ports.
Network Network status Indicates whether the gateway can reach outside your network. The network status is displayed as either Connected or Disconnected.
Network HTTPS mode Forces the gateway to communicate with Azure Service Bus by using HTTPS instead of TCP when turned on.
Connectors Custom data connectors You can connect to and access data from Power BI by using custom data connectors that you develop.

Next steps