Basic Configuration

This section covers System Configuration parameters related to Power BI Integration Extensions.

After being installed a Power BI Integration Extension needs to be configured.

Configuration section for Power BI Integration could be found by navigating to Stores -> Configuration menu in Magento 2 or System -> Configuration in Magento 1.

Configuring Extension License Key

Download/Copy License Key

At this stage the License should already be purchased and assigned to a Website using Account pages on www.bimproject.net.

Once the License was assigned to a Website, the License Key got generated and is available for download. License Key can be downloaded on the Website’s Details page. To open the Website Details, navigate to “My Websites” menu (on the Account page on www.bimproject.net) and click on “Details” link in the list of Websites.

License Key can be obtained on the Website Details page:

client website details page on BIM Website

Picture: client website details page on BIM Website

Online License Key is a short version of the key. Website www.bimproject.net will be used to obtain the complete License Key by the Extension. If this communication between Magento Platform and www.bimproject.net is not desired, Offline License Key might be used. Offline License Key can be downloaded on Website Details page and uploaded to Magento Platform.

If the License comes with documentation files or any other files to download, they will be available on “Downloads” page. Extension code can be obtained using composer repository. Access data to the repository will also be available on the Website’s Details page.

Configure License Key

Once the License Key is obtained, it can be entered in Magneto Configuration. The configuration can be opened by navigating to Stores -> Configuration in Magento 2 (System -> Configuration in Magento 1). On the Configuration page navigate to BIM Extensions -> General -> License:

License key configuration for BIM extensions

Picture: License key configuration for BIM extensions

Power BI APP registration

Power BI Extension is integrated with Azure Active Directory (Azure AD) to provide secure sign in and authorization between Magento Platform and Power BI API. The following is needed in order to start using Power BI Integration Extension: Azure Active Directory tenant, an organizational user, and a Power BI service account. The extension uses a Client ID to identify itself to Azure AD. Also a Client Secret Key needs to be created.

Microsoft has developed a tool to simplify the process of Power BI App registration: https://dev.powerbi.com/apps. Please, enter the following options during the usage of the tool:

  • Use “Server-side web application (for web apps or web APIs)” as Application Type.
  • Enter domain of your store as Home Page URL.
  • Use the URL of your Magento Admin path supplied with “*” suffix as Redirect URL

Example: https://your-website-domain.com/*

  • Select all permissions.

If the tool does not work, you may look in the Power BI documentation from Microsoft for the information on how to configure the Power BI App and obtain a Client ID and a Client Secret Key:

https://docs.microsoft.com/en-us/power-bi/developer/register-app

The obtained Client ID and Client Secret Key needs to be configured for the Power BI Integration Extension on Magento Configuration page (Stores -> Configuration in Magento 2, System -> Configuration in Magento 1), section BIM Extensions -> Power BI Integration -> Power BI API:

Power BI Cliend ID and Cliend Secret configuration

Picture: Power BI Cliend ID and Cliend Secret configuration

Setting up Power BI API might take some time, especially if an organization were not using Active Directory before. Usually people face some problems due to incorrectly configured Redirect URI. Please, use the following value as Redirect URI:

https://your-website-domain.com/*
(There is an asterisk at the end of a URI!)

For the rest of information, please, refer to the Microsoft documentation as main source of the information.

As an additional support, for a quick reference, we list the steps you may need to perform in order to obtain a Client ID and a client secret key for Power BI API.

Step 1: Create an Azure account

You should be able to create an Azure account for free. You pay only for Services you are using or for an optional support subscription.

Here is the URL where you may start with registration of an account:

https://azure.microsoft.com/en-in/free/

Step 2: Create an Azure Active Directory tenant

Please, follow the instructions from Power BI documentation in order to create an Azure AD tenant:

https://powerbi.microsoft.com/en-us/documentation/powerbi-developer-create-an-azure-active-directory-tenant/

Please, note that you do not need to activate Power BI Pro account as it is stated in Microsoft documentation since you do not have to use Power BI embedded in order to setup the API.

Step 3: Create some users in your Azure Active Directory tenant

You may want to create some users if you did not do that before. Each user who will use Power BI Service or Power BI Mobile App may need to have separate Power BI user.

And if you want to share content and use Power BI Workspaces, you may add Power BI Pro licenses. Pro license is needed for the user who will create the Power BI Workspaces and populate it with content and for the users who will get access to the Workspaces.

Step 4: Register Power BI Application

You may use new Power BI App Registration Tool for that or using Azure portal.

https://powerbi.microsoft.com/en-us/documentation/powerbi-developer-register-app/

Follow instructions related to Server-side Web app or Web Applications instead of registering a Native app.

Use Redirect URL as your domain name (of the backend system) with asterisks in the end.

Redirect URI: https://your-website-domain.com/*

In result, the application should be available in the list of applications in Azure AD:

Example of an App registration record in Azure AD 

Picture: example of an App registration record in Azure AD

Step 5: Get Client ID and secret key

Please, refer to the “How to get the client id” section of the documentation to get the Client ID:

https://powerbi.microsoft.com/en-us/documentation/powerbi-developer-register-app/#how-to-get-the-client-id

To get the client secret key, you may need just few additional steps to be performed on the Azure portal: after you have selected the application, click on Keys menu under API ACCESS section and add new key there.

Clint ID inside Azure AD:

obtaining Client ID in Azure AD 

Picture: obtaining Client ID in Azure AD

Client Secret inside Azure AD:

obtaining Client Secret in Azure AD 

Picture: obtaining Client Secret in Azure AD

Scheduled updates

Power BI Integration Extension comes with a scheduler that allows performing periodically automated data actualization. To configure the schedule, navigate to Magento Configuration page using menu Stores -> Configuration in Magento 2 (System -> Configuration in Magento 1).

On the Magento Configuration page navigate to BIM Extensions -> Data Integration (ETL) -> Scheduler.

Picture: Scheduler configuration in Magento Platform

Picture: Scheduler configuration in Magento Platform

This section allows users to configure:

  1. Regular schedule for jobs that needs to be performed once per day or less often.
  2. Live schedule for jobs that need to be executed several times per day.
  3. Clean Up schedule for executing data clean up jobs from time to time.

Below you will find details about each of the options.

Enable Regular Load option allows enabling/disabling execution of the jobs by regular schedule.

Regular Load Start Time is the time of the day when to execute regular jobs. Usually users may want to set this time to a period with lowest activity, at night.

Regular Load Frequency allows setting the frequency for regular jobs: daily, weekly, monthly.

Enable Live Load option allows enabling/disabling execution of the jobs by life schedule.

Live Load Frequency allows setting the frequency for live schedule: from once per minute to once in 2 hours.

Enable Clean Up option allows enabling/disabling execution of the clean-up jobs.

Clean Up Frequency allows setting the frequency for clean-up jobs: weekly, monthly or once in two months.