Power BI Connector for API

Build 23.0.8839

Install and Configure the Gateway

Install and Configure the Gateway (Standard Mode)

If multiple users will need access to your published datasets, use the Standard Mode of the Power BI Gateway.

Complete the following steps to prepare the Power BI Gateway for use with the CData Power BI Connector for API.

  1. Download the Standard Mode installer from the Power BI Gateway download page.
  2. Run the installer and click Install.
  3. Provide an email address in the Email address to use with this gateway field and click Sign in. Sign in with the Microsoft account selection form.
  4. Choose register a new gateway on this computer and click Next.
  5. Create a name and recovery key for the gateway, then click Configure.
    The gateway then starts and its desktop application, "On-premises data gateway", opens.
  6. Open the Connectors tab and set Load custom data connectors from folder: to the location of the custom connectors. By default, these are installed to C:\Users\<installing user>\Documents\Power BI Desktop\Custom Connectors.
    • Note: Your custom connector folder must be present on your local machine. You can't use a folder that mirrors a cloud storage service folder, such as a OneDrive folder.
  7. Click Apply > Apply & Restart. A table displays the custom connectors that have been discovered.
  8. Ensure that the service account that the Power BI Gateway runs under, 'NT Service\PBIEgwService', has access to the Custom Connectors folder you set in the previous step:
    1. Right-click the Custom Connectors folder and select Properties.
    2. On the Security tab, click Edit.
    3. Click Add....
    4. Set the Enter the object names to select field to "NT Service\PBIEgwService" and click OK > Apply > OK > OK.
  9. To register the changes with the Gateway, in the On-premises data gateway desktop UI, navigate to Service Settings > Restart the Gateway and click Restart now.

Install and Configure the Gateway (Personal Mode)

If you're the only user who needs access to the dataset, use the Personal Mode of the Power BI Gateway.

Complete the following steps to prepare the Power BI Gateway for use with the CData Power BI Connector for API.

  1. Download the Personal Mode installer from the Power BI Gateway download page.
  2. Run the installer and click Install.
  3. Provide an email address in the Email address to use with this gateway field and click Sign in. Sign in with the Microsoft account selection form.
  4. The gateway then starts and its desktop application, "On-premises data gateway (personal mode)", opens. Open the Connectors tab and set Load custom data connectors from folder: to the location of the custom connectors. By default, these are installed to C:\Users\<installing user>\Documents\Power BI Desktop\Custom Connectors.
    • Note: Your custom connector folder must be present on your local machine. You can't use a folder that mirrors a cloud storage service folder, such as a OneDrive folder.
  5. Click Apply > Apply & Restart. A table displays the custom connectors that have been discovered.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839