OData Integration for Power BI and Tableau

Overview

๐Ÿ“˜

Note

The OData integration is only supported for PowerBI and Tableau.

LeanIX enables you to integrate with Power BI and Tableau business intelligence tools. Integration with Power BI and Tableau tools allows you to strengthen your ad-hoc reporting capabilities above and beyond what LeanIX already provides.

The current OData integration provides a read-only connector to export workspace data to Power BI and Tableau. Since this is only a one-way integration, importing data back into the LeanIX workspace is not possible. The current integration supports OData version 4.

Procedure

Follow these steps:

  1. In LeanIX:
    1. In the Integrations section of the administration area, enable the OData integration.
    2. In the Inventory, create and save searches with the required fields within the Table View. OData sharing is only available for saved searches created within the Table View.
    3. In the configuration of saved searches, enable OData sharing and set the permission to Unrestricted or Write Restricted.
  2. In Power BI or Tableau:
    1. Access the endpoint of the workspace with an API token. You can obtain an API token by creating a Technical User. For more information, see Technical Users.
    2. Select Saved Searches.
    3. Load your saved searches within the desired tool.

Video Tutorial

Sharing Data within the LeanIX Inventory

You can enable OData Sharing for shared saved searches within the settings of a saved search.

๐Ÿ“˜

Note

  • OData sharing is disabled when the search permission is set to Read & Write Restricted.
  • Avoid usage of the dot(.) and @ in the column names as this interferes with the annotations in OData.
Enabling OData Sharing in the Settings of a Saved Search

Enabling OData Sharing in the Setting of a Shared Search

On the Manage Saved Searches page, you can see if OData is enabled for the saved search.

'Manage Saved Searches' Page

'Manage Saved Searches' Page

You can find the "Manage Saved Searches" screen with options as follows:

  1. In the main navigation, click on Inventory.
  2. Then, click on Manage Searches in the bottom left-hand corner.

When you try to delete a saved search, which is enabled for the OData, you will get a pop-up message asking you to confirm the deletion.

You can choose the fields to be shared by OData via the "Table View" Editing. If you change the visibility of any fields, make sure to save the search.

Loading OData Feed into Power BI

LeanIX exposes an OData endpoint that allows you to import your saved searches (also referred to as bookmarks) into PowerBI. The endpoint can be accessed via the following URL schema, either referencing the domain (if SSO is enabled) or, alternatively, the instance:

https://{SUBDOMAIN}.leanix.net/services/import-export/v1/odata/BookmarkService.svc/

Alternative endpoint with technical property names (for example, "Application_displayName" instead of "Display Name"):

https://{SUBDOMAIN}.leanix.net/services/import-export/v1/odata/BookmarkDataService.svc/

Authentication

Authentication is currently handled via the Basic Authentication, a mechanism that is commonly supported and available in most popular BI tools on the market.

Please provide the endpoint with the following credentials:

User namePassword
API tokenYour API token

To obtain an API token, create a Technical User. For more information, see Technical Users.

Integration

Microsoft PowerBI already comes with an OData Feed connector. This makes querying the exposed, saved searches simple.

To import saved searches into Power BI, follow these steps:

  1. In the Get Data overlay, search for the OData Feed connector, then click Connect.

    Searching for the 'OData Feed' Connector

    Searching for the 'OData Feed' Connector

  2. In the overlay that appears, enter the URL of the OData endpoint, then click OK.

    Entering the URL of the OData Endpoint in the OData Configuration

    Entering the URL of the OData API Endpoint in the Configuration of the OData Feed Connector

  3. If this is your first time connecting to the OData Feed, you will be prompted to choose a way to authenticate with the endpoint. In the sidebar, select Basic, then enter your authentication details.

๐Ÿ“˜

Note

In the User name section, you have to input the API token (not the name of the technical user that is created for the API token).

Configuring Basic Authentication for an OData Feed

Configuring Basic Authentication for the OData Feed Connector

The connection should be established. You should see a list of exposed saved searches.

๐Ÿ“˜

Note

Due to OData limitations, the names of your saved searches are normalized.

Viewing Imported Saved Searches in Power BI

Viewing Imported Saved Searches in Power BI

You can load or transform the imported data as needed.

Imported Saved Searches in Table View in Power BI

Imported Saved Searches in Table View in Power BI

Changing Credentials

If you need to change your credentials, follow these steps:

  1. On the menu bar, select File, then select Options and settings.

  2. Select Data source settings.

    Selecting the 'Data Source Settings' Option

    Selecting the 'Data Source Settings' Option in Power BI

  3. Select your domain, then click Edit Permissions.

    Selecting 'Edit Permissions' in the Data Source Settings

    Selecting 'Edit Permissions' in the Data Source Settings

  4. In the overlay that appears, click Edit, then click OK.

    Navigating to the Page for Editing Credentials for an OData Feed

    Navigating to the Page for Editing Credentials for an OData Feed

  5. In the overlay that appears, navigate to the Basic tab, enter your new API token, then click Save.

    Entering a New Password for Basic Authentication for an OData Feed

    Entering a New API Token in the Configuration of the OData Feed Connector

Loading OData Feed into Tableau

LeanIX exposes the OData endpoint that allows you to import your saved searches (also referred to as bookmarks) in Tableau. The endpoint can be accessed via the following URL schema:

https://{SUBDOMAIN}.leanix.net/services/import-export/v1/odata/BookmarkService.svc/

Alternative endpoint with technical property names (e.g. "Application_displayName" instead of "Display Name"):

https://{SUBDOMAIN}.leanix.net/services/import-export/v1/odata/BookmarkDataService.svc/

Authentication

Authentication is currently handled via Basic Authentication, a mechanism that is commonly supported and available in most popular BI tools on the market.

Please provide the endpoint with the following credentials:

Entering Authentication Details for OData Connection

Entering Authentication Details for OData Connection

The connection should be established. You should see a list of exposed saved searches.

Viewing Imported Saved Searches in Tableau

Viewing Imported Saved Searches in Tableau

You can drag and drop the exported fields of your searches within Sheets.

๐Ÿ“˜

Note

Data will remain shared with the BI tool even after disabling the OData integration in the settings as long as the sharing of the individual 'Saved Search' is not disabled actively in the 'Saved Search details'.

Viewing External Content in Dashboards

To allow users to view content from Power BI or Tableau in their dashboards, do the following:

  1. In LeanIX, enable the Do not restrict external content option for your Workspace. Alternatively, restrict external content to specific URLs. For more information, see External Content.
  2. In Power BI or Tableau, configure appropriate permissions to publish content to external systems without making it public to everyone.

Resources