Your use of this download is governed by Stonebranch’s Terms of Use.

Version Information

Refer to Changelog for version history information.

Overview

Microsoft Power BI is a Business Intelligence Tool. Power BI users can connect to and combine data from multiple data sources through a secure interface, creating Power BI datasets. Additionally, users may combine and transform collections of tables into a data pipeline, creating Power BI dataflows. This integration provides the capability to perform refresh actions on Microsoft PowerBI Datasets and Dataflows.

A typical Use Case is when UAC is used as a Data Pipeline orchestrator, where the last step of a workflow could be the refresh of a Microsoft Dataset or Dataflow.

Key Features

Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Configuration examples

Scenario A: Connect to Power BI Services using Domain, Username & Password Authentication and Client ID. Afterwards, refresh selected Dataflow from given list and start polling every 10 seconds for the refresh’s status for 10 poll cycles.

Scenario B: Connect to Power BI Services using Domain and Client Credentials Authentication. Afterwards, refresh selected Dataset from given list and start polling every 10 seconds until refresh is completed.

Action Output

 {
    "exit_code": 0,
    "status_description": "Refresh executed successfully",
    "invocation": {
        "extension": "ue-ms-powerbi",
        "version": "1.0.0",
        "fields": { ... }
    },
    "result": {
        "dataset_refresh_info": [
            {
                "requestId": "4047116e-983f-45c2-b85d-f7981ef0d921",
                "id": 55042190,
                "refreshType": "ViaApi",
                "startTime": "2024-07-30T14:45:05.277Z",
                "endTime": "2024-07-30T14:45:07.12Z",
                "status": "Completed",
                "refreshAttempts": [
                    {
                        "attemptId": 1,
                        "startTime": "2024-07-30T14:45:05.3538777Z",
                        "endTime": "2024-07-30T14:45:06.9476825Z",
                        "type": "Data"
                    },
                    {
                        "attemptId": 1,
                        "startTime": "2024-07-30T14:45:06.9476825Z",
                        "endTime": "2024-07-30T14:45:07.0883145Z",
                        "type": "Query"
                    }
                ]
            }
        ]
    }
}

{
    "exit_code": 1,
    "status_description": "Execution Failed: Maximum number of daily refreshes reached.",
    "invocation": {
        "extension": "ue-ms-powerbi",
        "version": "1.0.0",
        "fields": { ... }
        }
    },
    "result": {
        "errors": [
            "Execution Failed: Maximum number of daily refreshes reached."
        ]
    }
}

Output Fields

The following output-only fields provide better visibility during the execution of Universal Task Instances.

Cancelation and Rerun

• In case of cancellation, extension stops polling for refresh status. The refresh process does not get cancelled if it has already been initiated.

• In case of rerun the extension executes all commands from the beginning. That means that the extension will try to start the refresh even if the same dataset is currently being refreshed. In case a new refresh request is sent while the old one is still ongoing an appropriate error message will be raised.

Exit Codes

STDOUT and STDERR

STDOUT of this integration is empty and STDERR provides additional information to the user, the detail of it is tuned by Log Level Task Definition field.

How To

Import Universal Template

To use the Universal Template, you first must perform the following steps.

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

2. To import the Universal Template into your Controller, follow these instructions.

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to Integration Modifications.

Configure Universal Task

For a new Universal Task, create a new task, and enter the required input fields.

Integration Modifications 

Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.

• Python code modifications should not be done.

• Template Modifications

  • General Section

    • "Name", "Extension", "Variable Prefix", and "Icon" should not be changed.

  • Universal Template Details Section

    • "Template Type", "Agent Type", "Send Extension Variables", and "Always Cancel on Force Finish" should not be changed.

  • Result Processing Defaults Section

    • Success and Failure Exit codes should not be changed.

    • Success and Failure Output processing should not be changed.

  • Fields Restriction Section 

                     The setup of the template does not impose any restrictions. However, concerning the "Exit Code Processing Fields" section.

                      i. Success/Failure exit codes need to be respected.

                      ii. In principle, as STDERR and STDOUT outputs can change in follow-up releases of this integration, they should not be considered as a reliable source for determining the success or failure of a task.

Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.

Document References

This document references the following documents:

Changelog 

ue-ms-powerbi-1.0.0 (2024-08-14)

Initial release supporting execution and monitoring of Dataset and Dataflow refreshes on MS Power BI.