Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(dashboard): update docs to reflect new tiles naming #1842

Merged
merged 4 commits into from Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 11 additions & 11 deletions optimize/components/userguide/edit-mode.md
Expand Up @@ -7,41 +7,41 @@ description: "The edit mode allows you to configure the dashboard and adjust it
The edit mode allows you to configure the dashboard and adjust it to your needs, including the following operations:

- Rename your dashboard
- Add/remove a report
- Add/remove a tile
- Save the current state with your applied changes
- Cancel changes you already applied to the dashboard
- Set filters available on the dashboard
- Set a default auto refresh rate to periodically update the dashboard in [view mode](./view-mode.md)

![edit mode](./img/dashboard-dashboardEditActions.png)

Once you have prepared all your reports, you can now start to assemble them into a dashboard. Above the dashboard grid, click **Add a report** to open a modal where you can select one of your defined reports and add it to the dashboard. The **Add report** modal allows you to create dashboards that combine Optimize reports with data from other services as external URL reports and text reports.
Once you have prepared all your reports, you can now start to assemble them into a dashboard. Above the dashboard grid, click **Add a Tile** to open a modal where you can select one of your defined reports and add it to the dashboard. The **Add a Tile** modal allows you to create dashboards that combine Optimize reports with data from other services as external website tiles and text tiles.

### Optimize reports

In the **Add report** modal, use the **Optimize Report** tab to add reports to the dashboard. Use the **Select a Report** field to select one of the previously created reports or click **+ New Report from a template** to create a new report.
In the **Add a Tile** modal, use the **Optimize Report** tab to add reports to the dashboard. Use the **Select a Report** field to select one of the previously created reports or click **+ New Report from a template** to create a new report.

![add a report modal](./img/dashboard-addAReportModal.png)

:::note
If the dashboard is inside a collection, only reports that are in the same collection can be added. If the dashboard is not in a collection, it can only contain reports that are also not in a collection.
:::

### External reports
### External websites

In the **Add report** modal, click **External URL** to enter the URL of an external data source which should be added to the dashboard. Such external reports are added as iframes to the dashboard.
In the **Add a Tile** modal, click **External Website** to enter the URL of an external data source which should be added to the dashboard. Such external websites are added as iframes to the dashboard.

![text report editor](./img/dashboard-addAReportModal-externalReport.png)
![external website editor](./img/dashboard-addAReportModal-externalReport.png)

### Text reports
### Text tiles

In the **Add report** modal, click **Text Report** to open the text editor. This allows you to create a document which can contain formatted text, links and images.
In the **Add a Tile** modal, click **Text** to open the text editor. This allows you to create a document which can contain formatted text, links and images.

![text report editor](./img/dashboard-addAReportModal-textReport.png)
![text editor](./img/dashboard-addAReportModal-textReport.png)

### Placing report on the dashboard
### Placing tile on the dashboard

To move the report to your desired location, drag it in any direction. As soon as you release the dragged report, it snaps to the closest grid position. Dragging the handle on the lower right corner of each report will resize it. Delete the report from your dashboard by clicking the **x** button on the top right corner of each report.
To move the tile to your desired location, drag it in any direction. As soon as you release the dragged tile, it snaps to the closest grid position. Dragging the handle on the lower right corner of each tile will resize it. Delete the tile from your dashboard by clicking the **x** button on the top right corner of each tile.

![edit actions](./img/dashboard-reportEditActions.png)

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified optimize/components/userguide/img/dashboard-addAReportModal.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified optimize/components/userguide/img/dashboard-reportEditActions.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified optimize/components/userguide/img/filter-editMode.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion optimize/components/userguide/view-mode.md
Expand Up @@ -47,6 +47,6 @@ In the dashboard view mode, there is a **Filters** button which opens a panel th

![filters in view mode](./img/filter-viewMode.png)

Filters apply to all process reports on the dashboard. If a report already has filters set, they will be combined with the dashboard filter. For example, if a report has a filter to only show running instances and a dashboard filter for suspended instances is set, the report will only show instances that are both running and suspended. Dashboard filters are not applied to decision reports or external reports.
Filters apply to all process reports on the dashboard. If a report already has filters set, they will be combined with the dashboard filter. For example, if a report has a filter to only show running instances and a dashboard filter for suspended instances is set, the report will only show instances that are both running and suspended. Dashboard filters are not applied to decision reports, external websites, or text tiles.

Variable filters are only applied to reports whose process definition includes the variable. Otherwise, the filter is ignored for that report. Other dashboard filters and filters defined directly on the report are still applied.