Skip to content

Commit

Permalink
Merge branch 'main' into OPT-6794
Browse files Browse the repository at this point in the history
  • Loading branch information
misiekhardcore committed Mar 27, 2023
2 parents c639bfe + c405d66 commit f2fa373
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
26 changes: 26 additions & 0 deletions optimize/components/userguide/instant-preview-dashboards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
id: instant-preview-dashboards
title: Instant Preview Dashboards
description: "Use automatically generated dashboards/reports from Optimize to find insights for your processes"
---

Camunda Optimize is a comprehensive process optimization tool that helps businesses to streamline their operations
and improve efficiency. One of the standout features of Optimize is its ability to automatically generate
dashboards for each process, providing users with clear insights into process performance.

When a process has been imported into Optimize, it automatically generates a dashboard for that process.
The dashboards are designed to be intuitive and easy to use and can be accessed from the [process dashboards
page](./process-dashboards.md) by clicking on the desired process.

The data displayed in this dashboard (and its corresponding reports) is coupled with the user's permissions to that
process definition, meaning that the dashboard will include data from all tenants that the user is authorized to see.
Moreover, the dashboard/reports display data from all versions of the process definition in question.

The dashboard has a predictable URL so that it can also be embedded into other tools/webpages. The URL has the format
_https://<OPTIMIZE_URL>/dashboard/instant/<BPMN-PROCESS-ID>/_. This URL is stable across Optimize versions,
so there is no need to change it when updating Optimize.

:::note
Instant Preview Dashboards cannot be shared like standard dashboards. If you wish to direct someone to it, please
share the URL. The recipient will need to sign in to Optimize to see the dashboard.
:::
2 changes: 1 addition & 1 deletion optimize/components/userguide/process-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Note the available views below:

9. KPI Results: You can see the KPI’s current and target values, plus a link to the report itself.

10. Clicking on each process on the list opens a default dashboard dedicated to this process.
10. Clicking on each process on the list opens a [default dashboard dedicated to this process](./instant-preview-dashboards.md).

:::tip
For the pie chart reports in 4, 5, and 6, both time and count are displayed in the chart according to the following format:
Expand Down
7 changes: 6 additions & 1 deletion optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -793,9 +793,14 @@ module.exports = {
"components/userguide/view-mode",
],
},
{
"Dashboards maintained by Camunda": [
"components/userguide/process-dashboards",
"components/userguide/instant-preview-dashboards",
],
},
"components/userguide/creating-reports",
"components/userguide/combined-process-reports",
"components/userguide/process-dashboards",

{
"Process analysis": [
Expand Down

0 comments on commit f2fa373

Please sign in to comment.