Optimize 3.7.0 update

docs/components/optimize/userguide/additional-features/filters.md

@@ -163,10 +163,6 @@ Use the `Variable Filter` to retrieve only those process instances which hold th
 Variable filters can only filter for the final value of the variable. For instance, assume you want to analyze only those process instances which have the variable `department` with the value `marketing`. Say you also have some instances where this variable had the value `marketing` at the start of the execution yet this was later reassigned to the value `sales`.These instances will not be included in the filter.
 :::
 
-:::note
-The variable filter can only filter for variables of a [primitive type](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/#supported-variable-values).
-:::
-
 :::note
 To use complex types like object, you can use the Variable Import Customization feature to transform your object variables into primitive type variables.
 :::
@@ -205,6 +201,14 @@ This filters all instances where the selected date variable has a value within a
 
 Similar to the other variables, there are two input switches that allow you to exclude or include process instances where a particular date variable is either `null` or `undefined`.
 
+### List Variable Filters
+If you wish to filter based on the value of a [list variable](../../../../../self-managed/optimize-deployment/setup/object-variables#list-variables), the applied Filter will depend on the primitive type of items within the list, eg 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, ie instances whose list variable “contains” the selected value. Similarly, the “contains” Filter matches process instances whose list variable contains at least one value which in turn contains the given substring.
+
+### Combine multiple variables filters with OR logic
+
+Additionally to using variable filters individually, there is also the option of combining all the previously mentioned variable filters with OR logic. This means that variables which fullfill the condition specified in at least one filter will be displayed.
+
 ## Assignee and candidate group filters
 
 These filters allow you to include or exclude instances based on the assignee or the candidate group of at least one User Task of a particular process instance.

docs/components/optimize/userguide/creating-dashboards.md

@@ -24,6 +24,7 @@ The edit mode allows you to configure the dashboard and adjust it to your needs,
 - 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)
 
 ![edit mode](./img/dashboard-dashboardEditActions.png)
 
@@ -74,7 +75,11 @@ Once you have defined what your dashboard should look like, the view mode provid
 
 - Fullscreen: Display the dashboard in fullscreen and only see the essential information of your dashboard - the reports - and hide the header, control panel, and footer. While in fullscreen mode, you can click on the **Toggle Theme** button to switch between the default light theme and a dark theme.
 
-- Auto-refresh: This feature periodically updates the dashboard with the latest data. You can decide how often the update should be performed by setting a time span reaching from 1 to 60 minutes. An animation indicates when the next update is occurring. If you do not wish to use that feature anymore, you can disable it anytime. Note that when refreshing the dashboard page manually or switching to another page in between, the auto-refresh must be enabled again.
+- Auto-refresh: This feature periodically updates the dashboard with the latest data. You can decide how often the update should be performed by setting a time span reaching from 1 to 60 minutes. An animation indicates when the next update is occurring. If you do not wish to use that feature anymore, you can disable it anytime. <br />
+Note: The refresh rate will not be saved unless it is selected in the [edit mode](#edit-mode) of the dashboard.
+If it was selected in the view mode, the refresh rate will not be saved when refreshing the Dashboard page manually or switching to another page in between
+
+- Alerts: If the created dashboard exists inside a collection, it is possible to create and manage created alerts for the reports inside the dashboard.
 
 ![process performance overview](./img/dashboard-viewMode-monitorFeatures.png)
 

docs/components/optimize/userguide/creating-reports.md

@@ -66,7 +66,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. 
+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/setup/object-variables).
 2. Process instance
   * Count: View how many process instances were executed.
   * Duration: View how long the process instances took to complete.
@@ -461,26 +461,28 @@ As for charts and table reports, it is possible to display the total instance co
 
 ### View Mode
 
-Once you have defined what your report should look like, the view mode provides you with different kinds of actions, such as switching to the edit mode by clicking on the edit button or deleting the whole report if you do not have any use for it anymore. To see more details about the report, you can interact with it, e.g. by moving your mouse over individual datapoints in diagrams or zooming in or out of heatmaps. The kind of interaction always depends on the report itself.
+Once you have defined what your Report should look like, the view mode gives you a full view of the report visualization. To see more details about the Report, you can interact with it, e.g. by moving your mouse over individual datapoints in diagrams or zooming in or out of heatmaps. The kind of interaction always depends on the Report itself.
 
-To download the data of the report, click **Download CSV**. The downloaded file will include the report information in a table format.
+The view mode also provides you with different kinds of actions such as: 
 
 ![report sharing popover in Camunda Optimize](./img/report-sharingPopover.png)
 
-To share the report with other people or to embed it in a webpage, use the sharing feature of the report. Click on the share button, which opens up a popover. After enabling the "enable sharing" switch, a link is generated which you can send to people who do not have access to Camunda Optimize and thus enable them to see the report.
+- Download CSV: In case you want to download the data of the Report, you can click the `Download CSV` button. The downloaded file will include the Report information in a table format.
 
-You can also use the **Embed Link** button if you wish to insert the report into your webpage. Everyone that views the webpage can then see content of the report. The shared versions of the report allow to view the report itself only. There is no possibility to alter it or interact with any other features of Optimize. You can revoke the sharing any time by disabling the share switch.
+- Sharing: In case you want to share the Report with other people or want to embed it in a webpage, you can use the sharing feature of the Report. Just click on the share button, which opens up a popover. After enabling the "enable sharing" switch, a link is generated which you can send to people who do not have access to Camunda Optimize and thus enable them to see the Report.
 
-If you prefer to hide the header of the shared report or specific part of it, you can do that by adding the following parameter to the share URL:
+    You can also use the "Embed Link" button if you wish to insert the report into your webpage. Everyone that views the webpage can then see content of the Report. The shared versions of the Report allow to view the Report itself only. There is no possibility to alter it or interact with any other features of Optimize. You can revoke the sharing any time by disabling the share switch.
 
-```
-header : titleOnly / linkOnly / hidden 
-```
-For example, to completely hide the header from the shared report, you can add `header=hidden` as shown:
+    If you prefer to hide the header of the shared report or specific part of it, you can do that by adding the following parameter to the share URL:
+    ```
+    header : titleOnly / linkOnly / hidden 
+    ```
+    For example, to completely hide the header from the shared report, you can add `header=hidden` as shown: 
+    ```
+    http://<report share url>?header=hidden
+    ```
 
-```
-http://<report share url>?header=hidden
-```
+- Alerts: If the created report is inside a collection, you can use the Alert dropdown to create and manage Alerts for that report. Since Alerts can only be created on reports that have a number visualization, the Alerts dropdown will be only be visible for such reports.
 
 ## Creating a combined report
 

docs/components/optimize/userguide/data-sources.md

@@ -3,11 +3,11 @@ id: data-sources
 title: Data sources
 ---
 
-If you create a collection, there are no data sources available for creating reports by default. Data sources must be added by the manager to be used in reports. To do that, go to the **Data Sources** tab of the collection.
+If you create a collection, you are asked to add Data sources that can be used for creating Reports. To see the added Data sources or add extra ones, go to the **Data Sources** tab of the Collection.
 
 ![add source by definition](./img/sourceByDefinition.png)
 
-Using the **Add** button, a manager can add one or more sources to the collection. You can also select a definition that you would like to add and then select one or more tenants for that definition. You can also select the tenant first, and then select one or more definitions for that tenant.
+Using the **Add** button, a manager can add one or more sources to the collection by selecting the definitions that need to be added.
 
 ![add source by tenant](./img/sourceByTenant.png)
 

docs/reference/supported-environments.md

@@ -38,7 +38,7 @@ Run Camunda Optimize in a Java-runnable environment. The following environments
 
 ### Elasticsearch
 
-- Elasticsearch 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+
+- Elasticsearch 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+, 7.16.2+
 - Any minor version above the ones listed in the previous point is likely to be supported as well, but this hasn't been tested. For this reason, Camunda doesn't give any warranty.
 - Any major version smaller or greater than ElasticSearch 7 will be rejected by Optimize. For example, Optimize won't work with ElasticSearch 6.X or 8.X.
 - For the supported versions mentioned before, the Elasticsearch community as well as any professional version is supported. However, bear in mind that the professional edition comes with additional safety features that allow you to secure Elasticsearch. If you use the community edition, securing Elasticsearch needs to be done manually.

docs/self-managed/optimize-deployment/migration-update/3.6-to-3.7.md

@@ -17,4 +17,10 @@ Here you will find information about:
 * limitations,
 * known issues,
 * changes in the supported environments,
-* any unexpected behavior of Optimize (e.g due to a new feature)
+* any unexpected behavior of Optimize (e.g due to a new feature)
+
+## New Behavior
+
+### Added Support for Object and List Variables
+With Optimize 3.7.0, we have added support for object and list variables. Variables with type `Object` are now automatically imported and flattened into dedicated "sub variables" for each object property. If you have previously used a variable import plugin to achieve the same, you may disable this plugin after migrating to Optimize 3.7.0.  
+You can find more information about importing object variables [here](../../setup/object-variables).

docs/self-managed/optimize-deployment/rest-api/report/report-api.md → docs/self-managed/optimize-deployment/rest-api/authorization.md

@@ -1,15 +1,9 @@
 ---
-id: report-api
-title: "Report API"
-description: "Working with the Optimize Report API"
+id: authorization
+title: "Authorization"
 ---
 
-<span class="badge badge--platform">Platform only</span>
-
-
-## Authorization
-
-Every request needs to include an authorization token 
+Most requests of the Public REST API need to include an authorization token 
 either as an [`Authorization`](https://tools.ietf.org/html/rfc7235#section-4.2) request header or as a URI Query Parameter named `access_token`.
 
 Given a valid token `mySecret` the header would need to be set in one of the following ways:
@@ -21,14 +15,14 @@ Authorization: Bearer mySecret
 ```
 For sending the token as a query parameter the HTTP Query would look like the following:
 ```
-GET /api/public/export/report/{report-ID}/result/json?access_token=mySecret
+DELETE /api/public/dashboard/{dashboard-ID}?access_token=mySecret
 ```
 
-The token to be used to access the Optimize Report API is a configurable shared secret.
-Please refer to [Data Export REST API Configuration](./../../setup/configuration.md/#other) 
+The token to be used to access the Optimize API is a configurable shared secret.
+Please refer to [Public API Configuration](../../setup/configuration/#public-api) 
 for the particular configuration key to set this token.
 
 The following is an example configuration with a token value of `mySecret`:
 
-      json:
+      api:
         accessToken: mySecret

docs/self-managed/optimize-deployment/rest-api/dashboard/delete-dashboard.md

@@ -1,6 +1,6 @@
 ---
 id: delete-dashboard
-title: "Dashboard Delete"
+title: "Delete Dashboards"
 description: "The REST API to delete Dashboards from Optimize."
 ---
 
@@ -27,7 +27,7 @@ The following request headers have to be provided with every delete request:
 
 |Header|Constraints|Value|
 |--- |--- |--- |
-|Authorization|REQUIRED*|See [Authorization](dashboard-api.md/#authorization)|
+|Authorization|REQUIRED*|See [Authorization](../../authorization)|
 
 * Only required if not set as a query parameter
 
@@ -37,7 +37,7 @@ The following query parameters have to be provided with every delete request:
 
 |Parameter|Constraints|Value|
 |--- |--- |--- |
-|access_token|REQUIRED*|See [Authorization](dashboard-api.md/#authorization)|
+|access_token|REQUIRED*|See [Authorization](../../authorization)|
 
 * Only required if not set as a request header
 
@@ -56,12 +56,10 @@ Possible HTTP Response Status codes:
 |Code|Description|
 |--- |--- |
 |204|Request successful.|
-|401|Secret incorrect or missing in HTTP Header. See [Authorization](dashboard-api.md/#authorization) on how to authenticate.|
+|401|Secret incorrect or missing in HTTP Header. See [Authorization](../../authorization) on how to authenticate.|
 |404|The requested Dashboard was not found, please check the provided dashboard-ID.|
 |500|Some error occurred while processing the request, best check the Optimize log.|
 
-
-
 ## Example
 
 ### Delete a Dashboard