Skip to content

Commit

Permalink
docs(optimize): document kpi modal (#3541)
Browse files Browse the repository at this point in the history
* docs(optimize): document kpi modal

related to #12374

* Update process-dashboards.md

* Update process-KPIs.md

* docs(optimize): update the report creation reference

---------

Co-authored-by: christinaausley <[email protected]>
  • Loading branch information
2 people authored and theburi committed Jun 5, 2024
1 parent 8b3d587 commit 98d2c82
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/guides/improve-processes-with-optimize.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Optimize offers collaborative capabilities, too. Click the **Share** tab to shar

To create a custom report based on a key performance indicator (KPI) you’d like to analyze, and to incorporate this report into a dashboard, follow the steps below:

1. On the right side of the **Home** page, select **Create New > New Report**. Here we’ll take a look at a single process, though you can also view data from multiple processes.
1. On the right side of the **Collections** page, select **Create New > Report**. Here we’ll take a look at a single process, though you can also view data from multiple processes.
2. Click the text box under **Select Process** and select the process you’d like to analyze.
3. Select the type of report you’d like to use on the right side of the **Create new Report** box. As with dashboards, Optimize offers preconfigured templates such as heatmaps and tables. We’ll begin with a heatmap.
4. Click **Create Report**.
Expand Down
2 changes: 1 addition & 1 deletion optimize/components/userguide/creating-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Each report consists of the [edit mode](./process-analysis/report-analysis/edit-

To create a custom report based on a key performance indicator (KPI) you’d like to analyze, and to incorporate this report into a dashboard, follow the steps below:

1. On the right side of the **Home** page, select **Create New > New Report**. Here we’ll take a look at a single process, though you can also view data from multiple processes.
1. On the right side of the **Collections** page, select **Create New > Report**. Here we’ll take a look at a single process, though you can also view data from multiple processes.
2. Click the text box under **Select Process** and select the process you’d like to analyze.
3. Select the type of report you’d like to use on the right side of the **Create new Report** box. As with dashboards, Optimize offers preconfigured templates such as heatmaps and tables. We’ll begin with a heatmap.
4. Click **Create Report**.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
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/processOverview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions optimize/components/userguide/process-KPIs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
id: process-KPIs
title: Process KPIs
description: "Learn how key performance indicators (KPIs) can be created and used in Optimize."
---

Key performance indicators (KPIs) are reports represented by single numerical values with predefined targets.
To create a custom KPI, follow the steps below:

1. On the right side of the **Collections** page, select **Create New > Report > Process KPI**.
2. Select one of the predefined KPI templates and the process you’d like to analyze.

![KPI creation step 1](./img/process-kpi-step1.png)

3. Set the target value that you would like to achieve
4. Define the required filters.

![Set creation step 2](./img/process-kpi-step2.png)

5. Click **Create process KPI**.
6. (Optional) Edit the created KPI report and define your own filters/extra configuration.

## Setting existing process reports as KPIs

Existing process reports can be configured to act as a KPI. This can be done through the report configuration panel.
The checkbox to make the report a KPI is only visible for reports with a number visualization.

![Set KPIs](./img/kpiConfiguration.png)

Once a report is set as a KPI, its status is visible on the **Dashboards** page.

![Processes page](./img/processOverview.png)
2 changes: 1 addition & 1 deletion optimize/components/userguide/process-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section also allows you to set a process owner and take responsibility of a

## Set time and quality KPIs

KPIs, or Key Performance Indicators, are reports represented by single numerical values with predefined targets. The process of configuring a report as a KPI is done through the report configuration panel. The classification into a time or quality KPI occurs internally in Optimize based on the chosen measure.
KPIs, or Key Performance Indicators, are reports represented by single numerical values with predefined targets. The process of creating KPI reports is explained in [process KPIs](./process-KPIs.md). The classification into a time or quality KPI occurs internally in Optimize based on the chosen measure.

Once a report is set as a KPI, its status is visible on the **Dashboards** page. Hovering over the status provides a preview of specific information related to the KPI, including the set target, the current actual value of the single-number report, and a link to it. Users accessing the report via this link without proper authorization won't be able to view any data in the report view.

Expand Down
1 change: 1 addition & 0 deletions optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1129,6 +1129,7 @@ module.exports = {
},
"components/userguide/creating-reports",
"components/userguide/combined-process-reports",
"components/userguide/process-KPIs",

{
"Process analysis": [
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,7 @@ module.exports = {
"Combined process reports",
"components/userguide/combined-process-reports/"
),
optimizeLink("Process KPIs", "components/userguide/process-KPIs/"),
{
"Process analysis": [
optimizeLink(
Expand Down

0 comments on commit 98d2c82

Please sign in to comment.