About the Microsoft Power BI category

Alumio_Bot · September 21, 2022, 11:04am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: PowerBI API Reference

Connector package documentation

1. Setting up HTTP Client PowerBI

1.1 Steps

In Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select PowerBI Client as the HTTP Client.
Fill in the Base URI, Tenant ID, Client ID and Client secret according to your PowerBI account.
(For more information, see PowerBI API Reference
Click “Grant Access to PowerBI”.
Fill in your credential in the newly opened tab then proceed.
The key will show up when you get back into Alumio Dashboard.
You can optionally enable logging of request to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from PowerBI

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select PowerBI Subscriber as the subscriber.
Select the entity you want to subscribe to from PowerBI.
Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you will request from PowerBI.
Select the PowerBI HTTP Client to use.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow PowerBI documentation on building this connector so you can easily use the connector based on PowerBI API Reference.

Entity

The entity you want to subscribe to PowerBI. Please refer to the entities from PowerBI API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the PowerBI API Reference.

Please look at the example below on how to fill Request Parameters field when subscribing Get App By Id entity. We can see in the documentation that setting by Id entity requires “appId” as a path parameter to define which order we want to fetch the details from.

We set the “appId” by providing it inside the path key in the Request Parameters

Besides “appId” in path parameters, the endpoints can use query parameters. For example, Group - Get Groups It describes that query parameters: columns are required should be defined in the query parameters. So, we need to define it inside the query key in the Request Parameters field. The data inside query parameters will be parsed as query parameters.

In Alumio we do it as follows

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

Input Transformer

Any transformer’s set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

The HTTP Client configuration you will use to access PowerBI.

3. Publishing Entity to PowerBI

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select PowerBI Publisher as the publisher.
Select the method that you want the publisher to perform with the data.
Select the PowerBI entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently we support Post, Patch, Put and Delete methods on submitting data to PowerBI.

Entity

We support publishing to most PowerBI endpoints.
Please refer to PowerBI API Reference page.

Based on the documentation, some endpoints may need one or more path parameters.
For example, we want to Group - Get Group Users.

The documentation says that we need “groupId” as path parameters. In that case, you need to provide “groupId” data into the path key in the data, either as an output from Routes or output from Transformers in Outgoing Configuration. And you can put the payload you want to send to PowerBI into the payload key in the data. Here is an example of the required data

Alumio will send an API request to PowerBI as /myorg/groups/example01/users

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.