Power BI Read

In this article

Overview

Use this Snap to read data resources from a specified workspace.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None.

Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper Snap
  • Copy Snap
A document containing details of the workspace/entity to read.
Output

Document

  • Min: 1
  • Max: 1
  • Mapper Snap
  • Copy Snap
A document containing details of the entities.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.
Power BI ReadRead Employee Record
WorkspaceString

Required. Enter the workspace from which to read the resource. Alternatively, click the  icon to fetch a list of workspaces associated with the Power BI account and select the workspace. 

N/AEmployee Records
Entity typeString

Required. Select the entity type to read.

Available options are:

  • DashboardSingle-page canvas for visualizations based on reports. The visualization units are called tiles.
  • Dataset: Collection of tables from different data sources ready for reporting and visualizations.
  • ReportVisualized interpretations, findings, and insights of a dataset. A report can include many pages.
  • Imports: Data imported from OneDrive or local files.
  • GatewayConnections between Power BI's cloud-based analysis service and on-premise data sources. 
  • Dataflow: Collection of entities (tables) that you create and manage in workspaces.
  • Dataflow Storage Accounts: Stores data flows in the organization's Azure Data Lake Storage account and connects them to Power BI.
DashboardReport
Entity idString

Enter the ID of the entity to retrieve. Alternatively, click the  icon to fetch the IDs of all entities of the specified entity type available in the workspace. 

Leave this field blank to retrieve all entities of the specified entity type in the workspace. 

N/ASalesMarketingDataset (XXXXXXXXXXXXX) or XXXXXXXXXXXXX
Get objectString

Select the read operation to perform upon the specified entity/entity type. The available read operations vary based on your configuration of the Entity type field. 

This field is mandatory when configuring the Object id field.

Available options based on entity types are:

  • Dashboard:
    • Get Tile
  • Report
    • Get Page
    • Get Datasources
  • Dataset
    • Get Datasources
    • Get Parameter
    • Get Refresh History
    • Get Refresh Schedule
    • Get Gateway Datasources
    • Get Direct Query Refresh Schedule
  • Gateway
    • Get Datasources
    • Get Datasources Status
    • Get Datasources Users
  • Import
    • None
N/AGet Datasources
Object idString

Enter the ID of the object to retrieve. Alternatively, click the  icon to fetch the IDs of all entities of the specified entity type available in the workspace. 

Leave this field blank to retrieve all entities of the specified entity type in the workspace. 

N/ANumber of Projects (1a2345d6-7890-123a-b45f-678a9fe01234)
Connection details

Use this field set to configure the network connection parameters.

This field set consists of the following fields:

  • Connection timeout
  • Number of retries
  • Retry interval (seconds)

Number of retries

IntegerRequired. Specify the maximum number of re-connections if the connection fails or is timed-out.34

Retry interval (seconds)

IntegerRequired. Specify the interval in seconds between reconnections.1030
Connection timeoutIntegerRequired. Specify the connection timeout duration in seconds.1030
Snap ExecutionString

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Validate & ExecuteExecute only

Troubleshooting

ErrorReasonResolution
HTTP Response Exception:400

Invalid OAuth endpoint/token URL.

Verify the values of the OAuth2 endpoint or token URLs in the account settings.

HTTP Response Exception:401Invalid refresh token or access token.Verify the values of the refresh or access tokens in the account settings.
HTTP Response Exception:409ConflictVerify the network and Snap settings. 

Invalid input.

Your input in the Get object field is invalid.

Verify whether you have entered it correctly. Alternatively, select it from the drop-down list to avoid any human errors.

Property value is missing.

Your input for 'Workspace'/'Entity id' is missing.

Required fields cannot be blank. Verify whether you have configured all required fields correctly. 

Examples

Retrieving Refresh Schedules for Specific Datasets

We want to retrieve the refresh schedules for the SalesMarketing dataset from the My Workspace workspace. This Pipeline demonstrates how we can use the Power BI Read Snap to accomplish this task.

First, we use a Power BI Read Snap to retrieve all datasets from the My Workspace workspace as shown below: 

Since the Power BI Read Snap above is configured without any entity ID, the Snap retrieves all datasets from the workspace.

We use the JSON Splitter Snap to split each record from the Power BI Read Snap into a separate document. Since the output contains details of all datasets, we use the Filter Snap to output only those records with SalesMarketing value in the $name field.

A preview of the Filter Snap's output shows that only the SalesMarketing records are passed in the output.

We want to retrieve the refresh schedules of the dataset for specific entities. Therefore, we need the entity IDs of the target data sources. Hence, we use the Mapper Snap to pass only the $id field downstream.

Accordingly, the Mapper Snap outputs only the entity IDs.

Finally, we configure the Power BI Read Snap to utilize the entity IDs passed by the Mapper Snap, we also configure the Power BI Read Snap to retrieve refresh schedules.

Upon successful validation, the Power BI Read Snap outputs details of the specified entity IDs.

Download this pipeline.

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File Example_PowerBI_READ_View_the_Refresh_Schedules.slp

Mar 02, 2022 by Subhajit Sengupta

Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

November 2024main182 StableUpdated and certified against the current SnapLogic Platform release.

August 2024

main180

 


Stable

Updated and certified against the current SnapLogic Platform release.

May 2024main172 StableUpdated and certified against the current SnapLogic Platform release.
February 2024main168 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main155StableUpdated and certified against the current SnapLogic Platform release.

August 2023

main138

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023

main130 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023main114 StableUpgraded with the latest SnapLogic Platform release.
November 2022main113 StableUpgraded with the latest SnapLogic Platform release.
August 2022

main111

 StableUpgraded with the latest SnapLogic Platform release.
4.29main108 StableUpgraded with the latest SnapLogic Platform release.
4.28main100  StableUpgraded with the latest SnapLogic Platform release.
4.27main93 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main88StableUpgraded with the latest SnapLogic Platform release.
4.25main80 StableNo updates made.
4.24patchesmain80 LatestEnhanced the following Snaps in the Microsoft Power BI Snap Pack by supporting data flows with two options, Dataflow and Dataflow Storage Accounts.
4.23main76 LatestUpdated the dependencies and documentation links for all the Microsoft Power BI Snaps.

4.23

main73


Latest

Introduced the Microsoft Power BI Snap Pack that enables you to access and control entities such as datasets, reports, gateways, and dashboards in the workspace. The Microsoft Power BI Snap Pack contains the following Snaps:


See Also