Skip to content

Commit

Permalink
feat: move remaining "next" optimize docs into new optimize instance …
Browse files Browse the repository at this point in the history
…(subset #2) (#1214)

* feat: move remaining next/optimize docs into new optimize section

* fix: a few out-dated links from $ into $
  • Loading branch information
pepopowitz authored Sep 1, 2022
1 parent 21b62bd commit 0fc9611
Show file tree
Hide file tree
Showing 90 changed files with 117 additions and 127 deletions.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Optimize now imports the user operation log. Due to this, the engine user now re

### Suspension filter

Due to a limitation of the user operations log data retrieval in the engine API, process instance suspension states of instances suspended after Optimize has been started are not correctly imported. This leads to inaccuracies in the [Suspended Instances Only Filter](./../../../components/optimize/userguide/process-analysis/instance-state-filters.md#suspended-and-non-suspended-instances-only-filter), which will only apply to instances which were suspended before they were imported by Optimize.
Due to a limitation of the user operations log data retrieval in the engine API, process instance suspension states of instances suspended after Optimize has been started are not correctly imported. This leads to inaccuracies in the [Suspended Instances Only Filter]($optimize$/userguide/process-analysis/instance-state-filters#suspended-and-non-suspended-instances-only-filter), which will only apply to instances which were suspended before they were imported by Optimize.

Furthermore, since the suspension state of process instances in Optimize is updated according to historic data logs, if you have [history cleanup](./../configuration/history-cleanup.md) enabled it is possible that the relevant data will be cleaned up before Optimize can import it, leading to inaccuracies in the state of suspended process instances which will then not appear in the appropriate filter.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ However, any canceled flow nodes and user tasks already imported by Optimize bef

### No running flow node instances visible if blocked by an incident

Optimize 3.2.0 introduces the visibility of [incidents](./../../../components/optimize/userguide/process-analysis/metadata-filters.md#incident-filter), but in contrast to Camunda Cockpit, Optimize currently does not show flow node instances in flow node view reports for those flow node instances that are blocked by an incident.
Optimize 3.2.0 introduces the visibility of [incidents]($optimize$/userguide/process-analysis/metadata-filters#incident-filter), but in contrast to Camunda Cockpit, Optimize currently does not show flow node instances in flow node view reports for those flow node instances that are blocked by an incident.
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The Optimize 3.5 update will not succeed if it is run on data which has already

### Flow node selection in report configuration moved to flow node filter

The flow node selection previously found in the report configuration menu has now been migrated to the flow node filter dropdown as a ["Flow Node Selection" Filter](./../../../components/optimize/userguide/process-analysis/flow-node-filters.md#flow-node-selection). Existing flow node selection configurations in old reports will be migrated to an equivalent Filter with the Optimize 3.5.0 migration. Note that this filter now also filters out instances which do not contain any flow nodes that match the filter.
The flow node selection previously found in the report configuration menu has now been migrated to the flow node filter dropdown as a ["Flow Node Selection" Filter]($optimize$/userguide/process-analysis/flow-node-filters#flow-node-selection). Existing flow node selection configurations in old reports will be migrated to an equivalent Filter with the Optimize 3.5.0 migration. Note that this filter now also filters out instances which do not contain any flow nodes that match the filter.

## Changes in requirements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To configure an alert, take the following steps:
3. To give the alert a name, select the report and define a target webhook or email address of the person who will receive the alert.

:::note
In Camunda Platform 7 and Camunda Platform 8 Self-Managed, you must configure the email service to receive notifications. See the [technical guide](../../../../self-managed/optimize-deployment/configuration/system-configuration.md#email) for which properties need to be defined.
In Camunda Platform 7 and Camunda Platform 8 Self-Managed, you must configure the email service to receive notifications. See the [technical guide]($docs$/self-managed/optimize-deployment/configuration/system-configuration#email) for which properties need to be defined.
:::

Note that alerts can only be created for reports which are visualized as a single number and are in the same collection as the alert. Visit the [reports section](../creating-reports.md) on how to define single-number reports.
Expand All @@ -32,4 +32,4 @@ Finally, you'll get a resolve notification as soon as the report value is within

## Send alerts to external systems

It's possible to configure Optimize to send alerts to an external system when needed. For details on how to configure and add target systems, visit the [technical guide](../../../../self-managed/optimize-deployment/configuration/system-configuration.md#alert-notification-webhooks). Once at least one target system is configured, alerts will have a new input option to select one of the configured systems.
It's possible to configure Optimize to send alerts to an external system when needed. For details on how to configure and add target systems, visit the [technical guide]($docs$/self-managed/optimize-deployment/configuration/system-configuration#alert-notification-webhooks). Once at least one target system is configured, alerts will have a new input option to select one of the configured systems.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ their execution. This means only active and completed instances are considered.

## Suspended and non suspended instances only filter

By default, a report considers all process instances, regardless of whether they are [suspended](../../../best-practices/operations/operating-camunda-c7.md#suspending-specific-service-calls) or not. Adding this filter makes it possible to only evaluate process instances that are in the suspension state. Note that if you have enabled history cleanup, this might affect the accuracy of this filer given the suspension state is imported from historic data.
By default, a report considers all process instances, regardless of whether they are [suspended]($docs$/components/best-practices/operations/operating-camunda-c7#suspending-specific-service-calls) or not. Adding this filter makes it possible to only evaluate process instances that are in the suspension state. Note that if you have enabled history cleanup, this might affect the accuracy of this filer given the suspension state is imported from historic data.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In this section of the report builder, you are characterizing the output of the

First, you need to select which part of the data you want to view. Optimize differentiates between the view (e.g. process instance or flow node) and the measure (e.g. count or duration):

1. Raw Data: View just a table with the actual data listed as rows. This can come in handy if you found interesting insights in certain process instances and need detailed information about those instances, or you are exploring a process definition with a limited number of instances. This report type also allows you to inspect raw [object variable values](../../../../../self-managed/optimize-deployment/configuration/object-variables.md).
1. Raw Data: View just a table with the actual data listed as rows. This can come in handy if you found interesting insights in certain process instances and need detailed information about those instances, or you are exploring a process definition with a limited number of instances. This report type also allows you to inspect raw [object variable values]($docs$/self-managed/optimize-deployment/configuration/object-variables).

2. Process instance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Similar to the other variables, there are two input switches that allow you to e

## List variable filters

To filter based on the value of a [list variable](../../../../self-managed/optimize-deployment/configuration/object-variables.md#list-variables), the applied filter will depend on the primitive type of items within the list. For example, you will be creating a numeric variable filter for a variable which is a list of numbers, a string variable filter for a list of strings, and so on. It is important to note here that filters are applied on each individual item within the list variable and not the list itself.
To filter based on the value of a [list variable]($docs$/self-managed/optimize-deployment/configuration/object-variables#list-variables), the applied filter will depend on the primitive type of items within the list. For example, you will be creating a numeric variable filter for a variable which is a list of numbers, a string variable filter for a list of strings, and so on. It is important to note here that filters are applied on each individual item within the list variable and not the list itself.

For example, an "is" filter on a list of string values filters for those instances where any individual list item is equal to the given term. For example, instances whose list variable "contains" the selected value.

Expand Down
118 changes: 23 additions & 95 deletions optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -653,130 +653,58 @@ module.exports = {
"userguide/view-mode",
],
},

docsComponentsLink(
"Creating reports",
"components/optimize/userguide/creating-reports/"
),
"userguide/creating-reports",
"userguide/combined-process-reports",
"userguide/processes",

{
"Process analysis": [
docsComponentsLink(
"Overview",
"components/optimize/userguide/process-analysis/process-analysis-overview/"
),
docsComponentsLink(
"Outlier analysis",
"components/optimize/userguide/process-analysis/outlier-analysis/"
),
docsComponentsLink(
"Branch analysis",
"components/optimize/userguide/process-analysis/branch-analysis/"
),

"userguide/process-analysis/process-analysis-overview",
"userguide/process-analysis/outlier-analysis",
"userguide/process-analysis/branch-analysis",
{
"Report analysis": [
docsComponentsLink(
"Report process analysis",
"components/optimize/userguide/process-analysis/report-analysis/overview/"
),

"userguide/process-analysis/report-analysis/overview",
{
"Edit mode": [
docsComponentsLink(
"Overview",
"components/optimize/userguide/process-analysis/report-analysis/edit-mode/"
),
docsComponentsLink(
"Select process definitions",
"components/optimize/userguide/process-analysis/report-analysis/select-process-definitions/"
),
docsComponentsLink(
"Define reports",
"components/optimize/userguide/process-analysis/report-analysis/define-reports/"
),
docsComponentsLink(
"Measures",
"components/optimize/userguide/process-analysis/report-analysis/measures/"
),
docsComponentsLink(
"Compare target values",
"components/optimize/userguide/process-analysis/report-analysis/compare-target-values/"
),
docsComponentsLink(
"Process instance parts",
"components/optimize/userguide/process-analysis/report-analysis/process-instance-parts/"
),
docsComponentsLink(
"Configure reports",
"components/optimize/userguide/process-analysis/report-analysis/configure-reports/"
),
"userguide/process-analysis/report-analysis/edit-mode",
"userguide/process-analysis/report-analysis/select-process-definitions",
"userguide/process-analysis/report-analysis/define-reports",
"userguide/process-analysis/report-analysis/measures",
"userguide/process-analysis/report-analysis/compare-target-values",
"userguide/process-analysis/report-analysis/process-instance-parts",
"userguide/process-analysis/report-analysis/configure-reports",
],
},

docsComponentsLink(
"View mode",
"components/optimize/userguide/process-analysis/report-analysis/view-mode/"
),
"userguide/process-analysis/report-analysis/view-mode",
],
},

{
Filters: [
docsComponentsLink(
"Overview",
"components/optimize/userguide/process-analysis/filters/"
),
docsComponentsLink(
"Metadata filters",
"components/optimize/userguide/process-analysis/metadata-filters/"
),
docsComponentsLink(
"Instance state filters",
"components/optimize/userguide/process-analysis/instance-state-filters/"
),
docsComponentsLink(
"Flow node filters",
"components/optimize/userguide/process-analysis/flow-node-filters/"
),
docsComponentsLink(
"Process instance filters",
"components/optimize/userguide/process-analysis/process-instance-filters/"
),
docsComponentsLink(
"Variable filters",
"components/optimize/userguide/process-analysis/variable-filters/"
),
"userguide/process-analysis/filters",
"userguide/process-analysis/metadata-filters",
"userguide/process-analysis/instance-state-filters",
"userguide/process-analysis/flow-node-filters",
"userguide/process-analysis/process-instance-filters",
"userguide/process-analysis/variable-filters",
],
},
],
},

{
"Decision analysis": [
docsComponentsLink(
"Overview",
"components/optimize/userguide/decision-analysis/decision-analysis-overview/"
),
docsComponentsLink(
"Single report",
"components/optimize/userguide/decision-analysis/decision-report/"
),
docsComponentsLink(
"Filters",
"components/optimize/userguide/decision-analysis/decision-filter/"
),
"userguide/decision-analysis/decision-analysis-overview",
"userguide/decision-analysis/decision-report",
"userguide/decision-analysis/decision-filter",
],
},

{
"Additional features": [
docsComponentsLink(
"Alerts",
"components/optimize/userguide/additional-features/alerts/"
),
"userguide/additional-features/alerts",
"userguide/additional-features/event-based-processes",
"userguide/additional-features/export-import",
"userguide/additional-features/footer",
Expand Down
Loading

0 comments on commit 0fc9611

Please sign in to comment.