Integrate Power BI

Integrate with Power BI to receive automated notifications for important reporting changes in Citrix Workspace.

Use the following process to enable the Power BI Integration. Ensure you meet the prerequisites and provide connection details. After you complete this process, your existing level of audit logging persists, including any actions carried out by the use of Citrix Microapps.

For a comprehensive list of out-of-the-box Power BI microapps, see Use Power BI microapps.

Review prerequisites

You must have a Power BI service account. For more information, go to https://powerbi.microsoft.com/en-us/landing/signin/. For any report to be shared through Citrix Microapps, the report must be shared with the Power BI service account.

Depending on your set up, potentially two accounts are needed:

  • An account that has permissions to create an app registration in Azure AD. This account might be problematic depending on which subscription/tenant it associates with first.
  • A service account that is used to authenticate the integration.

These prerequisites assume you administer the Power BI instance of your organization to set up the integration. The service account must have the following API Permissions assigned with Type: Delegated:

Group API/Permissions name Type Description
Azure Active Directory Graph (1) User.Read Delegated Sign in and read user profile.
Power BI Service (18) App.Read.All Delegated View all Power BI apps.
  Capacity.Read.All Delegated View all capacities.
  Dashboard.Read.All Delegated View all dashboards.
  Dataflow.Read.All Delegated View all dataflows.
  Dataset.Read.All Delegated View all datasets.
  Gateway.Read.All Delegated View all gateways.
  Report.Read.All Delegated View all reports.
  StorageAccount.Read.All Delegated View all storage accounts.
  Workspace.Read.All Delegated View all workspaces

After you set up this integration in Power BI, you will need these artifacts to add the integration in Citrix Workspace Microapps:

  • Client ID
  • Client Secret
  • OAuth Authorization

Register your application

Navigate to https://dev.powerbi.com/apps, and register your application with Azure AD to allow your application to access the Power BI REST APIs and to set resource permissions for your application. Through this registration process, you create your Client ID and Client Secret.

The first callback that is listed does not change. The second callback depends on the target application, and can be found in your URL address bar when creating the integration. The section {yourmicroappserverurl} is composed of a tenant part, a region part, and an environment part: https://{tenantID}.{region(us/eu/ap-s)}.iws.cloud.com.

  1. Enter a name for your application.
  2. Select Server-side web application.
  3. Enter your application’s Home Page URL.
  4. Enter the following Redirect URLs: https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback https://{yourmicroappserverurl}/admin/api/external-services/com.sapho.services.powerbi.PowerBiService/auth/serverContext

    Note:

    It has been reported that for some users two URLs are not permitted in this field. In this case, go to Azure AD App Registration to add the second URL.

  5. Select all read only APIs check boxes.
  6. Select Register.

Add the integration to Citrix Workspace Microapps

Add the Power BI integration to Citrix Workspace Microapps to connect to your application. This delivers out-of-the-box microapps with pre-configured notifications and actions which are ready to use within your Workspace.

Follow these steps:

  1. From the overview page, select Get Started.

    The Manage Integrations page opens.

  2. Select Add New Integration, and Add a new integration from Citrix-provided templates.
  3. Choose the Power BI tile.
  4. Enter a name for the integration.

    Power BI connector parameters, Client ID, Client Secret, Tenant, OAuth Authorization

  5. Enter the Connector parameters that you collected in the previous procedures.
    • Enter your Client ID and Client Secret.
    • Enter you Office 365 Tenant ID.
  6. Select Log in with your Power BI account to enable OAuth Authorization. A Power BI sign-in page opens in a new tab. You are prompted to enter an account name, enter a password, and accept requested permissions.

  7. Select Add.

The Microapp Integrations page opens with your added integration and its microapps. From here you can add another integration, continue setting up your out-of-the-box microapps, or create a new microapp for this integration.

You are now ready to set and run your first data synchronization.

For more information, see Verify needed entities and Set data synchronization in the Configure the integration article.

For more details of API endpoints and table entities, see Power BI connector specifications.

Use Power BI microapps

Existing Web/SaaS integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs.

Our Power BI integration comes with the following preconfigured out-of-the-box microapps:

Dashboards: View details of Power BI dashboards.

Notification or Page Use-case workflows
Dashboards page Provides a list of available dashboards with a link to a page with details.
Dashboards Detail page Provides a read only detailed view of a dashboard with a link to the target source of record for a more detailed view.

Reports: View details of Power BI reports.

Notification or Page Use-case workflows
New Report Added notification When a new report is added to an account, subscribers receive a notification.
Report Detail page Provides a read only detailed view of a report.
Reports page Provides a list of available reports with a link to a page with details with a link to the target source of record for a more detailed view.