Embed Power BI paginated reports

With Power BI embedded analytics, you can create Power BI content that displays paginated reports in a fully integrated and interactive application. Embed paginated reports using the solution that works best for you, embed for your customers or embed for your organization.

This article describes how to embed paginated reports using the embedding sample tutorials.

Prerequisites

To get started, you're required to have:

Embed for your customers

• A service principal

• Your own Azure Active Directory tenant setup

• A capacity, with paginated reports workload enabled

If you don't have an Azure subscription, create a free account before you begin.

Embed for your organization

• A Power BI Pro license or Premium Per User (PPU) license.

• You need to have your own Azure Active Directory tenant setup.

• A Premium capacity. See What size Premium capacity do I need for paginated reports?

If you're not signed up for Power BI Pro, sign up for a free trial before you begin.

Method

To embed a paginated report using the sample app, follow these steps:

1. Create a workspace.

2. Create a capacity.

3. Assign a workspace to a capacity.

4. Enable paginated reports workload.

5. Create and upload your paginated report.

6. Embed content using the sample application.

Step 1 - Create a workspace

Embed for your customers

As you're using a service principal to sign into your application, you'll need to create a new workspace.

Your service principal must also be an admin or member of the Power BI workspaces.

Embed for your organization

In Power BI service, create a workspace for your paginated report.

Step 2 - Create a capacity

Embed for your customers

Before you import or upload a paginated report to embed, the workspace containing the report must be assigned to a capacity. There are two types of capacity you can choose from:

• Power BI Premium - For embedding a paginated report, an EM or P SKU is required. For more information about this subscription, see What is Power BI Premium?

• Azure Power BI Embedded - You can purchase a capacity from the Microsoft Azure portal. This subscription uses the A SKUs. For details on how to create a Power BI Embedded capacity, see Create Power BI Embedded capacity in the Azure portal.

  Note

  Power BI Embedded recently released a new version, called Embedded Gen2. Embedded Gen2 simplifies the management of embedded capacities, and improves the Power BI Embedded experience. For more information, see Paginated reports and Premium Gen2.

The following table describes the resources and limits of each SKU. To determine which capacity best fits your needs, see the which SKU should I purchase for my scenario table.

Capacity Nodes	Total v-cores	Backend v-cores	Frontend v-cores	RAM (GB)
EM1/A1 with Embedded Gen2	1	0.5	0.5	2.5
EM2/A2 with Embedded Gen2	2	1	1	5
EM3/A3 with Embedded Gen2	4	2	2	10
P1/A4	8	4	4	25
P2/A5	16	8	8	50
P3/A6	32	16	16	100

Embed for your organization

By creating a capacity, you can take advantage of having a resource for the content in your app workspace. For paginated reports, you must back your app workspace with an EM or a P capacity. You can create a capacity by using Power BI Premium.

The following table lists the Power BI Premium SKUs that can be used to create a capacity for paginated reports in Microsoft Office 365:

Capacity node	Total vCores	Back-end vCores	Front-end vCores	DirectQuery/live connection limits (per sec)
EM1 with Premium Gen2	1	0.5	0.5	3.75
EM2 with Premium Gen2	2	1	1	7.5
EM3 with Premium Gen2	4	2	2	15
P1	8 vCores	4 vCores, 25 GB of RAM	4 vCores	30
P2	16 vCores	8 vCores, 50 GB of RAM	8 vCores	60
P3	32 vCores	16 vCores, 100 GB of RAM	16 vCores	120
P4	64 vCores	32 vCores, 200 GB of RAM	32 vCores	240
P5	128 vCores	64 vCores, 400 GB of RAM	64 vCores	480

Step 3 - Assign a workspace to a capacity

Embed for your customers

Once you create a capacity, you can assign your app workspace to that capacity.

To assign a capacity to a workspace using a service principal, use the Power BI REST API. When you're using the Power BI REST APIs, make sure to use the service principal object ID.

Note

You can also import paginated reports into a new workspace using the Power BI REST APIs.

Embed for your organization

After you create a capacity, you need to assign your workspace to that capacity. To complete this process, follow these steps:

1. Within the Power BI service, expand workspaces and select More for the workspace you're using for embedding your content. Then select Workspace settings.

   

2. Select Premium and enable Capacity. Select the capacity you created. Then select Save.

   

3. After you select Save, you should see a diamond next to the app workspace name.

   

Step 4 - Enable paginated reports workload

Note

This step is only necessary for Embedded Gen1. If your capacity is Gen2, continue to Step 5.

After creating a capacity and assigning your workspace to it, you need to enable the paginated report workload on your capacity.

1. Sign into Power BI > Admin portal > Capacity settings.

2. Select the capacity that has the workspace you want to add a paginated report to.

   

3. Expand Workloads.

   

4. Activate the paginated reports workload.

   

Step 5 - Create and upload your paginated report

You can create your paginated report using Power BI Report Builder, and then upload the report to the service.

Note

The user uploading the paginated report needs a Power BI Pro or Premium Per User (PPU) license to publish to a workspace.

Step 6 - Embed content using the sample application

Embed for your customers

Follow the instructions in the embed content for your customers tutorial. Skip Step 4 - Create and publish a Power BI report and use the paginated report you uploaded, instead of the sample report suggested in the tutorial.

• To use a Power BI dataset as a data source:

  • In the Power BI portal, set the XMLA endpoint to Read Only or Read Write as described in enable read-write for a Premium capacity. You only need to do this once per capacity.
  • Generate a multi-resource embed token with the dataset ID specified in the request, and the XmlaPermissions set to Read Only.

• To use a Single Sign-on (SSO) enabled data source:

  SSO-enabled data sources are supported if they're either directly connected to the paginated report, or connected to a Power BI dataset which is the data source of the paginated report. When embedding a paginated report with SSO-enabled data sources, the identity blob for the data source must be provided in the DatasourceIdentity when you generate a multi-resource embed token.

Embed for your organization

Follow the instructions in the embed content for your organization tutorial.

Skip Step 3 - Create and publish a Power BI report and use the paginated report you uploaded, instead of the sample report suggested in the tutorial.

Considerations and limitations

Embed for your customers limitations

• You must use a service principal. Master user isn't supported.
• Premium Per User (PPU) isn't supported.
• When embedding a paginated report with a Power BI dataset, both the paginated report and the Power BI dataset must reside in a Premium per capacity or Embedded workspace (they can reside in two different workspaces), and the user generating the embed token should have Write permissions in the workspaces of the report and the dataset.

For a full list of supported datasets and their authentication methods, see Supported data sources for Power BI paginated reports.

Embed for your organization limitations

Premium Per User (PPU) is supported. However, if you're using PPU, only PPU users in your organization will be able to access your solution.

Next steps

Tutorial: Embed a Power BI report in an application for your organization

Capacity and SKUs in Power BI embedded analytics

Considerations when generating an embed token