Skip to content

Commit

Permalink
feat(collection): document alerts dropdown & adding sources
Browse files Browse the repository at this point in the history
related to OPT-5820
  • Loading branch information
megglos committed Jan 7, 2022
1 parent 8b39db4 commit 903ac9d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
2 changes: 2 additions & 0 deletions docs/components/optimize/userguide/creating-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ Once you have defined what your dashboard should look like, the view mode provid
Note: The refresh rate will not be saved unless it is selected in the [edit mode](#edit-mode) of the dashboard.
If it was selected in the view mode, the refresh rate will not be saved when refreshing the Dashboard page manually or switching to another page in between

- Alerts: If the created dashboard exists inside a collection, it is possible to create and manage created alerts for the reports inside the dashboard.

![process performance overview](./img/dashboard-viewMode-monitorFeatures.png)

To share the dashboard with other people or embed it in a webpage, use the sharing feature of the dashboard. Click on the share button, which opens up a popover. After turning the “enable sharing” switch on, a link is generated which you can send to people who do not have access to Camunda Optimize, and thus enable them to see the dashboard. If you applied filters on the dashboard, you can include them in the shared version of the dashboard by enabling the **Share with current filters applied** checkbox. If the checkbox is not checked, the shared dashboard will include the default filters if any have been set.
Expand Down
26 changes: 14 additions & 12 deletions docs/components/optimize/userguide/creating-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,26 +461,28 @@ As for charts and table reports, it is possible to display the total instance co

### View Mode

Once you have defined what your report should look like, the view mode provides you with different kinds of actions, such as switching to the edit mode by clicking on the edit button or deleting the whole report if you do not have any use for it anymore. To see more details about the report, you can interact with it, e.g. by moving your mouse over individual datapoints in diagrams or zooming in or out of heatmaps. The kind of interaction always depends on the report itself.
Once you have defined what your Report should look like, the view mode gives you a full view of the report visualization. To see more details about the Report, you can interact with it, e.g. by moving your mouse over individual datapoints in diagrams or zooming in or out of heatmaps. The kind of interaction always depends on the Report itself.

To download the data of the report, click **Download CSV**. The downloaded file will include the report information in a table format.
The view mode also provides you with different kinds of actions such as:

![report sharing popover in Camunda Optimize](./img/report-sharingPopover.png)

To share the report with other people or to embed it in a webpage, use the sharing feature of the report. Click on the share button, which opens up a popover. After enabling the "enable sharing" switch, a link is generated which you can send to people who do not have access to Camunda Optimize and thus enable them to see the report.
- Download CSV: In case you want to download the data of the Report, you can click the `Download CSV` button. The downloaded file will include the Report information in a table format.

You can also use the **Embed Link** button if you wish to insert the report into your webpage. Everyone that views the webpage can then see content of the report. The shared versions of the report allow to view the report itself only. There is no possibility to alter it or interact with any other features of Optimize. You can revoke the sharing any time by disabling the share switch.
- Sharing: In case you want to share the Report with other people or want to embed it in a webpage, you can use the sharing feature of the Report. Just click on the share button, which opens up a popover. After enabling the "enable sharing" switch, a link is generated which you can send to people who do not have access to Camunda Optimize and thus enable them to see the Report.

If you prefer to hide the header of the shared report or specific part of it, you can do that by adding the following parameter to the share URL:
You can also use the "Embed Link" button if you wish to insert the report into your webpage. Everyone that views the webpage can then see content of the Report. The shared versions of the Report allow to view the Report itself only. There is no possibility to alter it or interact with any other features of Optimize. You can revoke the sharing any time by disabling the share switch.

```
header : titleOnly / linkOnly / hidden
```
For example, to completely hide the header from the shared report, you can add `header=hidden` as shown:
If you prefer to hide the header of the shared report or specific part of it, you can do that by adding the following parameter to the share URL:
```
header : titleOnly / linkOnly / hidden
```
For example, to completely hide the header from the shared report, you can add `header=hidden` as shown:
```
http://<report share url>?header=hidden
```
```
http://<report share url>?header=hidden
```
- Alerts: If the created report is inside a collection, you can use the Alert dropdown to create and manage Alerts for that report. Since Alerts can only be created on reports that have a number visualization, the Alerts dropdown will be only be visible for such reports.
## Creating a combined report
Expand Down
4 changes: 2 additions & 2 deletions docs/components/optimize/userguide/data-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ id: data-sources
title: Data sources
---

If you create a collection, there are no data sources available for creating reports by default. Data sources must be added by the manager to be used in reports. To do that, go to the **Data Sources** tab of the collection.
If you create a collection, you are asked to add Data sources that can be used for creating Reports. To see the added Data sources or add extra ones, go to the **Data Sources** tab of the Collection.

![add source by definition](./img/sourceByDefinition.png)

Using the **Add** button, a manager can add one or more sources to the collection. You can also select a definition that you would like to add and then select one or more tenants for that definition. You can also select the tenant first, and then select one or more definitions for that tenant.
Using the **Add** button, a manager can add one or more sources to the collection by selecting the definitions that need to be added.

![add source by tenant](./img/sourceByTenant.png)

Expand Down

0 comments on commit 903ac9d

Please sign in to comment.