Skip to main content

On-premises Data Gateway Setup

To use the OctoMesh Connector in Power BI Service with scheduled data refresh, you need to set up an On-premises Data Gateway.

Prerequisites​

  • On-premises Data Gateway installed on a Windows server
  • Administrator access to the Gateway server
  • Power BI Service account with Gateway admin permissions

Step 1: Install the Connector on the Gateway​

  1. Download the OctoMeshConnector-*.pqx file to the Gateway server from the Download Center.

  2. Copy the file to the Gateway's Custom Connectors folder:

    C:\Windows\ServiceProfiles\PBIEgwService\Documents\Power BI Desktop\Custom Connectors
    Important

    This path is different from the user's Custom Connectors folder. The Gateway service runs under a separate account (PBIEgwService).

  3. Restart the Gateway service:

    • Open Services (services.msc)
    • Find On-premises data gateway service
    • Click Restart

Step 2: Verify Connector Installation​

  1. Open the On-premises data gateway application.
  2. Navigate to the Connectors tab.
  3. Verify that OctoMeshConnector appears in the list.

Gateway Connectors Tab

Step 3: Enable Custom Connectors in Power BI Service​

  1. Open Power BI Service.
  2. Navigate to Settings (gear icon) > Manage connections and gateways.
  3. Select your Gateway cluster.
  4. Click on Settings (three dots menu > Settings).
  5. Enable the following options under Power BI:
    • Allow user's cloud data sources to refresh through this gateway cluster
    • Allow user's custom data connectors to refresh through this gateway cluster
  6. Click Save.

Gateway Settings

Step 4: Create a Connection​

Create a Runtime Query in OctoMesh​

  1. Log in to your OctoMesh account.
  2. Navigate to the Runtime Queries section, see Runtime Query Builder Documentation.
  3. Create a new Runtime Query or select an existing one.
  4. Note the rtId of the Runtime Query you wish to use.

Create the Connection in Power BI Service​

  1. In Power BI Service, go to Settings > Manage connections and gateways.
  2. Click + New to create a new connection.
  3. Select your Gateway cluster.
  4. Configure the connection:
    • Connection name: A descriptive name (e.g., OctoMesh-Production)
    • Connection type: Select OctoMesh from the dropdown
    • Asset Repository Service URI: Your OctoMesh Asset Repository URL (e.g., https://assets.<cluster>.octo-mesh.com/ — replace <cluster> with the cluster your tenant runs on, such as prod-1 or prod-2)
    • Tenant ID: Your OctoMesh tenant identifier (e.g., meshdemo)
    • Runtime Query ID: The rtId of the Runtime Query

Configure Authentication​

Select Service Account (Client Credentials) as the authentication method:

  • Client ID: The OAuth client ID configured in OctoMesh Identity Service
  • Client Secret: The client secret for the service account

Connection with Client Credentials

Client Credentials Setup

Contact your OctoMesh administrator to create a service account with:

  • Grant Type: client_credentials
  • Scopes: assetTenantAPI.full_access

The service account must have access permissions for the tenant and Runtime Query you want to use.

  1. Click Create to save the connection.

Next Steps​