NOTE: To be able to extract data from the Login Enterprise API the certificate on the Login Enterprise Webinterface should be trusted by the machine extracting the data. In case you are using the default certificate you can trust the root certificate of the Login Enterprise. This can be download from the following URL. https://<appliance>/contentDelivery/content/CA.crt. Change <appliance> in to the FQDN of your own appliance.
There are 2 files attached to this article that allow you to interact with Microsoft Power BI.
- LoginEnterprise Template v.1.2.pbit
- This can be used when interacting with the Login Enterpise API with Microsoft Power BI Desktop only. This is the standalone method of working with Login Enterprise. This file cannot be turned into an online dashboard that automatically refreshes.
- LoginEnterprise.mez
- This needs to be used to when you want to create a dashboard in office365 that will automatically refresh. The guide below relies on this file. The LoginEnterprise.mez file can also be used with Microsoft Power BI desktop.
NOTE: The template and connector only work with the v4 API version.
Option 1: Using "LoginEnterprise Template v.1.2.pbit"
- Install Microsoft PowerBI Desktop
- Open "LoginEnterprise Template v.1.2.pbit"
- Fill in the FQDN and API token of you Login Enterprise Appliance.
Option 2: Using the Login Enterprise PowerBI Connector (LoginEnterprise.mez) with Microsoft PowerBI Desktop locally.
- Install Microsoft PowerBI Desktop
- Create the following folder structure "\Documents\Microsoft Power BI Desktop\Custom Connectors"
- Place "LoginEnterprise.mez" in the "Custom Connectors" folder.
- Start Microsoft PowerBI. The Login Enterprise connector should be available when you select "Get Data > Other".
Option 3: Using the Login Enterprise PowerBI Connector (LoginEnterprise.mez) with Microsoft PowerBI Gateway for Office365 integration.
Preparation;
- Select a machine that will act as the PowerBI Gateway Server and which is able to connect to the Login Enterprise appliance through the local network. Make sure this machine has an internet connection.
- Install .Net FrameWork 4.7.2.
- If you are using Login Enterprise with the standard certificate make sure you download and trust the root certificate from the following URL. https://<FQDN>/contentDelivery/content/CA.crt . If the certificate is not trusted the PowerBI connector will not be able to extract data from the Login Enterprise API.
Set up;
- Create a folder on the machine and place the mez file in it.
- Install the PowerBI Gateway on the selected machine (not the personal gateway). The installation files can be found here; https://www.microsoft.com/en-us/download/confirmation.aspx?id=53127
- During the installation logon with your Office 365 account to connect the PowerBI Gateway to your subscription.
- When the PowerBI Gateway is installed go to “Connectors” and specify the path for the custom connectors in “Load custom data connectors from folder:”.
- If you’ve done everything right your PowerBI Gateway interface should look like this.
- Go to browse to Office.com and go to your PowerBI app. In the menu bar select the gear icon and go to Manage Gateways.
- You should see the new Gateway there.
- Install PowerBI Desktop on a local machine that can access the Login Enterprise API. Make sure this machine also trusts the Login Enterprise Certificate.
- Create the following folder structure if it doesn’t exist for the user you are logged on with. Documents\Microsoft Power BI Desktop\Custom Connectors.
- Place the LoginEnterprise.mez file in Documents\Microsoft Power BI Desktop\Custom Connectors.
- Start Microsoft PowerBI and select click on Get Data.
- In the Get Data window select “Other” and select “LoginEnterprise” and click on “Connect”
- In the URL field enter https://<FQDN>/publicApi/v4 and click “OK”.
- In the “Account Key” field enter the Public API token that you can generate under the “External Notifications > Public API” section of the Login Enterprise Console. (do NOT use the deprecated API for this). Leave everything else default and press “Connect” when finished
- Click “Load” once you see the first portion of the data. Wait for the data to load. Depending on the amount of tests you have performed this may take a while.
- Once the process completes verify that you have data by dragging “testName” on to the report canvas.
- Without changing anything else click on “Publish”.
- When asked to save store the files somewhere on your local machine. (this is a temporary but mandatory step to get your data into office365). The name you select will be the name of the dashboard in office365.
- Select a destination and click “Select”. (tip: My workspace, is your personal workspace).
- Wait for the process to finish and click “Open <name>.pbix in Power BI” to open the online version of the dashboard.
- Verify that the new Dataset is created in your workspace.
- Click on Settings, then click on Gateway Connection.
- You should see the Gateway you set up earlier. Expand the Gateway entry so the “Maps to” option is available. Select “Manually add to gateway”.
- ’
- ’
- Enter a Data Source Name to your liking and select LoginEnterprise as Data Source Type.
- Enter the Login Enterprise API URL in the “Url” field.
- Enter the API token in the “Account Key” field.
- Check “Skip Test Connection”.
- Press “Add”.
You Dataset is now configured to refresh through the PowerBI Gateway.
Note: At this point the Dataset will not automatically refresh. To configured automatic refresh you go to “Settings > Datasets > Your Dataset > Scheduled refresh”. There you can enter multiple times during a day at which the Dataset should be refreshed.
Disclaimer
The Login Enterprise Power BI connector is provided as-is and might need further configuration and customization to work successfully in each unique environment. For further Professional Services-based customization please consult with the Login VSI Support and Services team.