Update a Data Management Gateway

After you create a gateway in the Power BI for Office 365 Admin Center, you can view and update settings for the gateway in the Admin Center. Similarly, after you install and configure the gateway on an on-premises computer, you can use the Data Management Gateway Configuration Manager to view and update settings for the gateway on the on-premises computer.

View and update gateway settings using Power BI Admin Center

The following procedure has steps to view and update settings for a gateway using the Power BI Admin Center.

  1. On the Admin Center, switch to the gateways tab if the tab is not already active.
  2. Click … (ellipsis) next to your gateway name in the list of gateways.
  3. You can perform the following operations in this window:
  1. View the status of the gateway (not registered, online, offline, error, etc…).
  2. View the version of the gateway.
  3. View the version status of the gateway (Up to date, expiring, expired, etc…).
  4. View where credentials for the data sources associated with the gateway are stored (credential store - (local vs. cloud).
  5. View the name of the computer on which the gateway was installed (Installed On). When you click on the name of the computer, you can remote desktop into the gateway computer.
  6. Click Regenerate to regenerate the key. When you click Regenerate, you will be shown the newly generated key along with an option to hide the gateway key.
  7. Click Download gateway installation package here to navigate to the download location for the installation package.
  8. Click Delete to delete the gateway.
  9. Click Edit to edit the gateway details. In the details page, do the following:
    1. View the name of the gateway. You cannot change the name of the gateway.
    2. Update description for the gateway.
    3. Select Enable cloud credential store to achieve business continuity option if you want the gateway to use the cloud credential store instead of the local store. Note that once you select Enable cloud credential store to achieve business continuity for the gateway setting and save the gateway in Admin Center, you will not be able to revert back to using the local store for storing credentials. If the gateway is already using the cloud credential store, this option (check box) is checked but disabled so that you won’t be able to clear the option.
    4. Click save to save the settings. If you had selected Enable cloud credential store to achieve business continuity, you will see a message box about a certificate being generated by Power BI. This certificate is used for encrypting data source credentials stored in the cloud store. Click yes to continue. You will see messages about the status of the migration process from the bell icon.

 Important    In the Data Management Gateway Configuration Manager on the gateway computer, you may need to refresh the settings page to see a new tab named Certificate.

View and update gateway settings using Data Management Gateway Configuration Manager

You can view settings such as status of the gateway as well as customize configurations for the gateway using the Data Management Gateway Configuration Manager. If the tool is not open, launch it from %ProgramFiles%\Microsoft Data Management Gateway\1.0\Shared\ConfigManager.exe or click Start\All Programs\Data Management Gateway\Data Management Gateway Configuration Manager Preview. Confirm that you see Connected to Data Management Gateway Cloud Service message in the status bar of this too.

 Note    Only the members of the Data Management Gateway Users group on the computer will be able to use the Data Management Gateway Configuration Manager to configure the gateway. The user who installed the gateway is automatically added to the group. You will need to manually add any other user who needs to use the configuration manager to the Windows group.

 Note    If you have multiple data management gateways installed in your organization, ensure that you are launching the tool on the machine that is running the gateway associated with the data source for which you enabled the OData feed and want to secure the access to the feed.

The Data Management Gateway Configuration Manager has two main tabs: Home and Settings. The Help tab provides brief introduction to the gateway and the licensing information.

Home tab

The Home tab allows you to register the gateway by using a valid gateway key that you can obtain from the Admin Center after creating a gateway in the portal. To register the gateway, click change gateway key, paste the key copied from the Admin Center. This is also useful when you delete a gateway in the Power BI Admin Center and then create a new one or you want to associate the client gateway with a different gateway in the Power BI Admin Center.

Data Management Gateway Configuration Manager - Home Page

On the Home tab, do the following:

  1. Confirm that the name of the gateway (Gateway name) matches the name of the gateway in the Admin Center.
  2. Confirm that the status of the gateway (Gateway key status) is set to Registered.
  3. Confirm that the status of the Data Management Gateway Host Service (Service status) is set to Started. The Data Management Gateway Host Service is a Windows service that provides the Data Management Gateway with management and data access services. If the Status field for the service is set to Stopped, start the service by clicking Start Service button.

Settings tab

The Settings tab has two pages: Gateway and Certificate. You see the Certificate page only if the gateway uses the cloud store for storing the credentials for accessing data sources associated with the gateway. If you had migrated the store from local to cloud and do not see this page, you may need to click the refresh button at the left corner of this tab.

Gateway page

The gateway enables you to expose the data from on-premises data sources as an Open Data Protocol (OData) feed. This data can be accessed either using HTTP or HTTPS. When using HTTPS, a SSL certificate required. Click change to change the endpoint settings from HTTP to HTTPS or vice versa using the following steps:

Data Management Gateway Configuration Manager - Settings Tab - Gateway Page

  1. Click Change. You should see the Specify HTTP/HTTPS Endpoint dialog box.
  2. In the Specify HTTP/HTTPS Endpoint dialog box, specify the protocol (HTTP or HTTPS) to access the OData feeds. If you select HTTP, specify the Port.

Data Management Gateway Configuration Manager - Specify HTTP/HTTPS

  1. If you select HTTPS, specify the Port and the SSL Certificate by clicking Select. After you are done with selecting the certificate, click OK on the Specify HTTP/HTTPS Endpoint dialog box. The gateway needs a certificate to provide SSL over HTTP connection. We recommend that you use a certificate from a certificate authority (CA). You can use a self-signed certificate for testing purposes. See Create a Self-signed Certificate for Testing for details.
  2. If you selected HTTPS, confirm that the Status field on the Gateway page is set to Enabled. There may be some delay in seeing the updated status. Wait for few seconds and click Refresh (top-left corner) if you do not see the status set to Enabled.

Certificate page

You use the Certificate page to view details of the certificate that is used to encrypt data source credentials before they are stored into the cloud credential store, export or back up the certificate, and change the certificate. You can see this page only if the gateway uses the cloud credential store. If you had just moved the store from local to cloud using the Power BI Admin Center, you may need to refresh (using button at top-left corner of the settings tab).

Data Management Gateway Configuration Manager - Certificate Management Page

You can do the following operations on this page:

  • Click view to view the details of the certificate being used.
  • Click export to export the certificate to a file. In the Export certificate dialog box, enter a password to protect the private key. Click next on the dialog box. Navigate to the folder in which you want to save the certificate and click Save. By default, name of the PFX file is set to <Gateway Name>-<Machine Name>-<Date Time Stamp>.PFX.
  • Click change to change the certificate. You can either generate a new certificate and use it or use an existing certificate.

See Also

 
 
Applies to:
Power BI for Office 365