diff --git a/docs/guides/improve-processes-with-optimize.md b/docs/guides/improve-processes-with-optimize.md index 4240968a1a..43d19fe06b 100644 --- a/docs/guides/improve-processes-with-optimize.md +++ b/docs/guides/improve-processes-with-optimize.md @@ -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**. diff --git a/optimize/components/userguide/creating-reports.md b/optimize/components/userguide/creating-reports.md index a317a39596..5afc271b53 100644 --- a/optimize/components/userguide/creating-reports.md +++ b/optimize/components/userguide/creating-reports.md @@ -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**. diff --git a/optimize/components/userguide/img/process-kpi-step1.png b/optimize/components/userguide/img/process-kpi-step1.png new file mode 100644 index 0000000000..e8b304090d Binary files /dev/null and b/optimize/components/userguide/img/process-kpi-step1.png differ diff --git a/optimize/components/userguide/img/process-kpi-step2.png b/optimize/components/userguide/img/process-kpi-step2.png new file mode 100644 index 0000000000..ac6e5194e1 Binary files /dev/null and b/optimize/components/userguide/img/process-kpi-step2.png differ diff --git a/optimize/components/userguide/img/processOverview.png b/optimize/components/userguide/img/processOverview.png index 80736c5688..572419ff9b 100644 Binary files a/optimize/components/userguide/img/processOverview.png and b/optimize/components/userguide/img/processOverview.png differ diff --git a/optimize/components/userguide/process-KPIs.md b/optimize/components/userguide/process-KPIs.md new file mode 100644 index 0000000000..c2ccd2f6a6 --- /dev/null +++ b/optimize/components/userguide/process-KPIs.md @@ -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) diff --git a/optimize/components/userguide/process-dashboards.md b/optimize/components/userguide/process-dashboards.md index 1946e34949..7e450cc45b 100644 --- a/optimize/components/userguide/process-dashboards.md +++ b/optimize/components/userguide/process-dashboards.md @@ -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. diff --git a/optimize_sidebars.js b/optimize_sidebars.js index a200b0e809..4d6efeec5f 100644 --- a/optimize_sidebars.js +++ b/optimize_sidebars.js @@ -1129,6 +1129,7 @@ module.exports = { }, "components/userguide/creating-reports", "components/userguide/combined-process-reports", + "components/userguide/process-KPIs", { "Process analysis": [ diff --git a/sidebars.js b/sidebars.js index 00366b60ff..74c18f5fdd 100644 --- a/sidebars.js +++ b/sidebars.js @@ -440,6 +440,7 @@ module.exports = { "Combined process reports", "components/userguide/combined-process-reports/" ), + optimizeLink("Process KPIs", "components/userguide/process-KPIs/"), { "Process analysis": [ optimizeLink(