Skip to content

Commit

Permalink
docs: disabling powerBi reports in the webapp
Browse files Browse the repository at this point in the history
  • Loading branch information
@esasova
esasova committed Jul 22, 2024
1 parent 6496e3d commit 3e9d4ff
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions doc/powerBI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ structure for this `charts` object is the following:
```

| Key | Value description |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `logInWithUserCredentials` | boolean defining if we must use "user account" (true) or "service account" mode (false) (see section [PowerBI authentication strategies](#powerbi-authentication-strategies)) |
| `dashboardsViewIframeDisplayRatio` | number defining the width/height ratio for the report iframe in the _Dashboards_ page |
| `scenarioViewIframeDisplayRatio` | number defining the width/height ratio for the report iframe in the _Scenario_ page |
Expand Down Expand Up @@ -76,7 +76,7 @@ expect the same structure:
```

| Key | Value description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `title` | report title, per language, to display in the let menu in the Dashboards view (it is not used for reports in Scenario view) |
| `reportId` | id of the report; it can be found in PowerBI, in the URL of your report: `myReportURL?reportId=<reportId>` |
| `settings` | an object to configure the [PowerBI report settings](https://github.com/microsoft/powerbi-models/blob/0d326572c4253fd9f89b73a0d8df1ae46318a860/src/models.ts#L1070) |
Expand Down Expand Up @@ -384,7 +384,7 @@ scenario, its parent or root scenarios, or even the scenarios available to the u
Here is the list of dynamic filters available:

| Filter name | Description |
| -------------------------------------- | ---------------------------------------------------------------------- |
|----------------------------------------|------------------------------------------------------------------------|
| `id` | _id_ of the current scenario |
| `csmSimulationRun` | _csm run id_ of the last run of the current scenario |
| `state` | _state_ of the current scenario |
Expand Down Expand Up @@ -438,6 +438,12 @@ For example, you can add a [IRelativeDateTimeFilter](https://github.com/microsof

See [PowerBI models](https://github.com/microsoft/powerbi-models) for further details.

### Disable the display of results
If the display of results after a simulation run isn't needed in the webapp, configuration of
`[workspace].webApp.options.charts` can be omitted and thus PowerBi will be disabled in both
Dashboards and Scenario views.


## Complete example

You can find below a complete example of a workspace YAML description file, defining the PowerBI charts to use:
Expand Down

0 comments on commit 3e9d4ff

Please sign in to comment.