cc-powerbi v1.1.0

cc-powerbi

This package provides helpers for authenticating to Azure AD and fetching PowerBI Report and Dashboard URLs for embedding. It is intended to be used from CloudCode.

Development

This is for development on the package itself, not development using the package.

Install dependencies:

yarn install

Create a .env file with the following contents (substituting in appropriate values):

TENANT_ID=
CLIENT_ID=
CLIENT_SECRET=
PB_USERNAME=
PB_PASSWORD=
REPORT_ID=
REPORT_WORKSPACE_ID=
DASHBOARD_ID=
DASHBOARD_WORKSPACE_ID=

Run the test script with one of the following options:

yarn test --report

yarn test --dashboard

yarn test --all

To see available options for test script:

yarn test --help

Installation

Create a new CloudCode task using the PowerBI Helper template.

Alternatively, add the package with yarn:

yarn add cc-powerbi

Usage

const PowerBI = require("cc-powerbi");
const program = new PowerBI.PowerBIEmbeds({
    // Azure Active Directory TenantID
    tenant: 'TENANT_ID',
    
    //The Application ID that the registration portal (apps.dev.microsoft.com) assigned your app.
    client_id: 'YOUR_CLIENT_ID',
    
    //The application secret that you created in the app registration portal for your app.
    client_secret: 'YOUR_CLIENT_SECRET',
    
    // Dedicated user with read access the PowerBI reports
    username: 'powerbi-dev@example.com',
    password: 'YOUR_PASSWORD'
})

export async function run(params) {
    return await program.run(params);
}

The value of params will be as follows for a report:

{
    type: "report",
    reportID: REPORT_ID,
    workspaceID: REPORT_WORKSPACE_ID
}

The value of params will be as follows for a dashboard:

{
    type: "dashboard",
    dashboardID: DASHBOARD_ID,
    workspaceID: DASHBOARD_WORKSPACE_ID
}