Release Notes - Camunda Optimize - Version 3.2.0 - HTML format

Design Task

  • [OPT-3727] - Update menu styling
  • [OPT-3728] - Live dashboard filters behaviour refinements
  • [OPT-3767] - Improve add data source modal
  • [OPT-4011] - Runtime features
  • [OPT-4189] - Dashboard template User Flow and design

Bug Report

  • [OPT-3707] - Optimize crashes when closing delete modal on slow connection
  • [OPT-3738] - Possible running date bucket inaccuracies due to timezone offsets
  • [OPT-3751] - Prevent Camunda Activity Source usage if activity event index does not exist
  • [OPT-3774] - User Task Reports grouped by Auto Start Date fails when number of instances =1
  • [OPT-3910] - Relative/Rolling Date Filters in Combined Report Results in Too Many Buckets
  • [OPT-3911] - Date reports should always return empty result when there are no instances
  • [OPT-3953] - Applied filter popover has weird arrow position
  • [OPT-3955] - Report Title Tooltip position is incorrect
  • [OPT-3978] - Combined Reports overlap if contained reports have same name
  • [OPT-3983] - Long words in report name in configuration popover overflows
  • [OPT-3992] - Count Percentage of user task reports is using wrong reference value
  • [OPT-3994] - Versions aren't sorted correctly in report building dropdown
  • [OPT-3997] - Authorization issue in multi engine scenario for users with identical ID
  • [OPT-3998] - Selection outline for flownodes not shown in even based processes modeler
  • [OPT-3999] - Timezone is applied wrong to bucketLimiting filter on group by date with unit
  • [OPT-4014] - Attempt to normalize date variable strings to Optimize compatible format
  • [OPT-4018] - Export fails when downloading empty variable number reports
  • [OPT-4038] - rawdata table rows are unaligned when disabling all columns and enabling two column
  • [OPT-4059] - Can't add report with missing opening parenthesis
  • [OPT-4069] - Optimize keeps open too many scrolls
  • [OPT-4077] - Collections permissions/roles are being removed if the application authorization request returns an error code
  • [OPT-4085] - Visualization is inconsistent after distribution change
  • [OPT-4101] - Resolve Sonarcloud Issues with list assertions
  • [OPT-4110] - Cannot switch Optimize language
  • [OPT-4117] - Import fails if suspended state of a processInstance is imported before the activity instance
  • [OPT-4125] - Elasticsearch version checker does not extract latest version correctly
  • [OPT-4139] - colorpicker is shown for distributed reports that are grouped by userTask
  • [OPT-4152] - relative value checkbox shows 'process count' in decision report
  • [OPT-4161] - CSV export for combined report can be erroneous if not all grouping values show up in all reports
  • [OPT-4177] - X-Axes displays values from latest to oldest date
  • [OPT-4183] - Telemetry tests do not test correct behaviour
  • [OPT-4191] - Sorting a decision report by evaluation date does not work
  • [OPT-4214] - Start and End date report "isComplete" flag is set incorrectly for automatic intervals
  • [OPT-4215] - missing buckets breaks reports grouped by date variables
  • [OPT-4222] - Cannot create baseline of 0 for groupBy duration reports
  • [OPT-4223] - Resolve duplicate aggregation name for automatic date reports distributed by variable
  • [OPT-4249] - events table fails to load when creating new element
  • [OPT-4250] - Import intitialization race condition when status endpoint is called
  • [OPT-4256] - Status observer subscription/unsubscription can cause import scheduler to get stuck
  • [OPT-4259] - Configured max status connections isn't reflected correctly
  • [OPT-4268] - Unnecessary scrollbar in dashboard fullscreen view
  • [OPT-4269] - Duration reports group/distribute by date variable with automatic intervals always returns `null`-value buckets
  • [OPT-4272] - Poor performance of /entities endpoint on multi-version definitions
  • [OPT-4320] - Show bucket size configuration for decision reports
  • [OPT-4322] - Evaluating shared dashboard reports in collection can lead to error
  • [OPT-4352] - Pagination to last page in Raw Data Modal not possible for Decision Reports
  • [OPT-4354] - Improve text alignment for report builder
  • [OPT-4360] - identity endpoint return incorrect total
  • [OPT-4369] - DistrBy numberVar with automatic buckets fails for very high numbers
  • [OPT-4374] - DistrBy numberVar fails when all variable values are negative in combination with negative baseline and automatic unit
  • [OPT-4393] - Add empty DistrBy Date results to avoid incomplete result map
  • [OPT-4396] - NullPointerException on incident import after upgrade
  • [OPT-4399] - configuration option "Cancelled or interrupted" leads to parsing error
  • [OPT-4405] - Canceled flownode filter crashes after changing defintion
  • [OPT-4408] - Distribiuted by End Date leads to error if no finished instances exists
  • [OPT-4409] - Dashboard Report "View Raw data" and "View Process Model" in Fullscreen
  • [OPT-4410] - Distribute by end date fails if there are no finished instances

Feature Request

  • [OPT-2210] - Make default sorting visible for table visualization
  • [OPT-2428] - Reports that distinguish FlowNode/UserTask Cancelled/Interrupted States
  • [OPT-2845] - Report on number of incidents
  • [OPT-3144] - Allow sending alerts to multiple e-mail addresses
  • [OPT-3263] - Deeplink into filtered Dashboard
  • [OPT-3297] - Allow sorting of Entity List items
  • [OPT-3308] - Add Camunda Event Counts to Camunda events in eventCount response
  • [OPT-3310] - Integrated update to new versions
  • [OPT-3315] - Trend Analysis: Process Instance Count group by start/end date distribute by variable
  • [OPT-3330] - Trend Analysis: FlowNode Count/Duration grouped by start/end date distributed by FlowNode
  • [OPT-3442] - I can use Health Check Endpoint
  • [OPT-3445] - Allow to hide the Logout Button via configuration
  • [OPT-3580] - Optimize can send essential data to production ET
  • [OPT-3623] - I can use dashboard filters in dark mode
  • [OPT-3625] - Update Menu Styling according to Design Updates
  • [OPT-3630] - Single Number Report Style on Dashboards is improved
  • [OPT-3636] - I can explicitly include certain columns only in raw data reports
  • [OPT-3643] - Performance Distribution: I can group Process/FlowNode/UserTask Instance Count by Duration
  • [OPT-3653] - Allow internationalization for dates
  • [OPT-3656] - Simplify selection of Data Sources
  • [OPT-3693] - Use latest LTS release of JRE for Optimize Docker Image
  • [OPT-3732] - I can filter string variables by contains and not contains
  • [OPT-3746] - Support Elasticsearch 7.7+7.8
  • [OPT-3804] - Use-Case driven Dashboard Templates
  • [OPT-3847] - Process Event Monitoring Example Connector: UiPath Monitoring
  • [OPT-4063] - Make Event Mapping Table sortable in UI
  • [OPT-4086] - Open cockpit deeplink in new tab per default (in raw data tables)
  • [OPT-4108] - I can see the current report result when I create an alert
  • [OPT-4127] - Provide a searchable column in alert list
  • [OPT-4130] - Make logging more easily configurable for docker Optimize
  • [OPT-4132] - Allow configuration of authorizedGroupIds for eventBasedProcesses
  • [OPT-4195] - Optimize SSO implementation
  • [OPT-4291] - Improve display of definition name in definition selection

Task

  • [OPT-866] - Create and use Tabbed panel component
  • [OPT-956] - Remove catch block that handles unexpected date formats in CustomOffsetDateTimeDeserializer
  • [OPT-1615] - Add label to configuration button
  • [OPT-2200] - Rename default IT engine alias
  • [OPT-2444] - Nightly performance tests on rest api
  • [OPT-2482] - Implement pagination for all requests with possibly large data in the Optimize rest-API
  • [OPT-2541] - Data generator creates decision definition with date variables
  • [OPT-2888] - Document mounting environment-config.yaml into docker container
  • [OPT-2995] - Test that report deletion does not create inconsistent states
  • [OPT-3001] - Configure Indices managed by the SchemaManager in a central place
  • [OPT-3068] - Use definitionKey lookup for reports when clearing event based process resources
  • [OPT-3084] - Align error and no result handling in reader layer
  • [OPT-3132] - Execute the migration/upgrade steps in a single script
  • [OPT-3185] - Refactor OptimizeRequestExecutor for easier usage
  • [OPT-3285] - Automatically add ElasticSearch version warning check
  • [OPT-3287] - DefinitionResolver should try to fetch a particular definition directly from the engine API on cache miss
  • [OPT-3361] - Update Regression Test Data Setup
  • [OPT-3397] - Prevent templated indices using the name service methods that include index suffixes
  • [OPT-3410] - Create Jenkins job to cleanup stage branch and Jenkins
  • [OPT-3434] - Grouped by Date reports contain a lot of duplicated code
  • [OPT-3484] - Automatically assign event labels when not provided
  • [OPT-3512] - Create a jenkins job to test if the startup/upgrade script output contains warnings/errors
  • [OPT-3592] - Find a solution for dropdown overflow in tables
  • [OPT-3609] - Unresolvable event traces shouldn't be counted towards sequence counters
  • [OPT-3612] - Variable name endpoints use composite aggregation to scroll through results
  • [OPT-3629] - Move the engine endpoint constants from the configuration to hard-coded constants class
  • [OPT-3631] - remove header groups from raw data table
  • [OPT-3644] - Upgrade schema integrity test
  • [OPT-3669] - Test that updating the engine-alias in the configuration does not affect functionality
  • [OPT-3761] - Create a reusable docs link component to link to user guide
  • [OPT-3786] - Move duplicated/often used process models to a single class
  • [OPT-3792] - Hide source modal context switch in edit mode
  • [OPT-3794] - Simplify usage of LocalDatetimeUtil
  • [OPT-3806] - Re-enable unit tests for pickerDateInput
  • [OPT-3814] - Add warnings/limit result when report would exceed bucket limit
  • [OPT-3831] - Split up SingleReportHandlingIT
  • [OPT-3837] - Remove sorting of report results in the frontend
  • [OPT-3839] - Sort date reports ascending by default
  • [OPT-3843] - Add a script to the demo distribution to start Elasticsearch only
  • [OPT-3904] - Find a solution to the configuration popover remounting when reevaluating the report
  • [OPT-3909] - Remove IE11 pollyfils
  • [OPT-3927] - Clean up the utility class annotations
  • [OPT-3962] - Set the timezone when retrieving the min/max values for date reports
  • [OPT-3968] - Enable Event Process Data Migration Tests
  • [OPT-3979] - Improve Time handling for Date filters
  • [OPT-3989] - Remove 3.0.0 to 3.1.0 Upgrade steps and tests
  • [OPT-3995] - Make Event List Selection Consistent
  • [OPT-4002] - update dmnjs and fix styling issues
  • [OPT-4017] - change bpmn import xml to use the promises
  • [OPT-4019] - Clean up and make Util tasks more consistent
  • [OPT-4024] - Bucket size input field formats larger numbers
  • [OPT-4025] - Adjust report sorting based on visualisation
  • [OPT-4035] - e2e related to report and event based processes are broken on browserstack
  • [OPT-4036] - Clean Up Table Columns Lists if Variables are Removed
  • [OPT-4049] - Document that events can be updated (e.g. with new variable data) in event monitoring
  • [OPT-4053] - Elasticsearch compability test are failing due to instable embedded optimize integration test
  • [OPT-4058] - Engine compatibility tests should contain the latest snapshot
  • [OPT-4061] - Remove use of deprecated APIs
  • [OPT-4067] - Remove unused deprecation warnings from CustomPrefixIT
  • [OPT-4068] - Migrate Event Count retrieval to use new Sorter parameter pattern
  • [OPT-4073] - Refactor extracting of dto fields for tableColumns and csv export
  • [OPT-4083] - Move dependabot config file so we can make use of the Github UI
  • [OPT-4092] - Use parameterized error responses for mockserver responses
  • [OPT-4100] - Add Camunda BPM 7.14 as supported version
  • [OPT-4102] - Update upgrade documentation to include warning against snapshots
  • [OPT-4105] - Counter intuitive disabling of markers
  • [OPT-4106] - The suspension filter is still showing its outdated limitations
  • [OPT-4107] - It's shown if the outlier analysis reveals no results
  • [OPT-4111] - it's tested that the german browser version works
  • [OPT-4122] - Copyedit System Configuration Docs
  • [OPT-4128] - Merge minMax range fields in command execution context
  • [OPT-4134] - Docs: correct details on telemetry data listed in config
  • [OPT-4146] - Return an empty object when there are no outliers
  • [OPT-4162] - Create a branch analysis service layer
  • [OPT-4170] - Add Cmd line argument fuer superusers
  • [OPT-4171] - Refactor script creation with parameter map
  • [OPT-4176] - Add webhook placeholder config to environment config
  • [OPT-4187] - Update reimport documentation to include docker Optimize
  • [OPT-4218] - Set current workdir to baseDir in Optimize scripts
  • [OPT-4224] - Fix typo on login page
  • [OPT-4225] - Make date format in decision raw data similar to process raw data
  • [OPT-4228] - Separate distributedBy from dateAggregationService
  • [OPT-4235] - Use consistent AssertJ assertThat import
  • [OPT-4236] - List the alpha release separately in the enterprise download page
  • [OPT-4251] - Make the Upgrade resilient to concurrent snapshot operations
  • [OPT-4252] - Add a stage superuser
  • [OPT-4258] - Cache definition authorization relevant search calls for /entities listing
  • [OPT-4261] - Migrate shared report evaluation to use POST
  • [OPT-4262] - Use POST shared report evaluation endpoint
  • [OPT-4273] - Only send status updates through the websocket if the status changed
  • [OPT-4276] - Nightly upgrade performance test ensures snapshot resilience
  • [OPT-4300] - Resolve query performance connection reset error logs
  • [OPT-4319] - Improve checkbox alignment
  • [OPT-4353] - Snapshots in Upgrade ES Schema tests do not properly restore templates
  • [OPT-4358] - Show node display configuration for distributed by flownode reports
  • [OPT-4402] - Don't remove version suffixing when pushing telemetry data
  • [OPT-4403] - Handle telemetry failing to resolve placeholder URL
  • [OPT-4404] - Update docs to include footer timezone info and remove outdated date selection
  • [OPT-4414] - Add limitation docs for running instances with incidents

Bug Part

  • [OPT-4075] - Sort order not binding properly from query params
  • [OPT-4178] - Running instances that make up the global duration max are missing in the result
  • [OPT-4247] - Camunda events sorted by name should use label where possible

Feature Part

  • [OPT-3950] - Alert API can handle multiple email addresses
  • [OPT-3951] - I can configure alerts for multiple recipients
  • [OPT-4004] - String variable filters can have "contains" operators for process reports
  • [OPT-4005] - I can use the new "contains"/"not contains" operator for string variable in reports
  • [OPT-4031] - adjust report configuration to allow specifically including certain columns
  • [OPT-4032] - add an option to include/exclude new variables from rawdata table
  • [OPT-4050] - String variable filters can have "contains" operators for decision reports and dashboard filters
  • [OPT-4057] - Allow EntityLists to be sortable
  • [OPT-4070] - I can group flow node reports by date in the report builder
  • [OPT-4093] - Add new report: view Flow Node count grouped by Flow Node start/end date distributed by Flow Node
  • [OPT-4094] - Add new report: view Flow Node duration grouped by Flow Node start/end date
  • [OPT-4095] - Add new report: view Flow Node duration grouped by Flow Node start/end date distributed by Flow Node
  • [OPT-4098] - Add new report: view Flow Node count grouped by Flow Node start/end date
  • [OPT-4115] - I can group reports by their duration in the report builder
  • [OPT-4190] - I can set a dashboard filter for shared dashboards
  • [OPT-4194] - Allow applying filters on shared dashboards
  • [OPT-4246] - I can use Templates to quickly create a Dashboard
  • [OPT-4279] - Allow saving Dashboard when adding variable filter
  • [OPT-4280] - Allow Templates to have subtitles
  • [OPT-4281] - Update Template selection focus style
  • [OPT-4282] - Focus Process Definition Selection by default
  • [OPT-4283] - Use Template Name for new entities
  • [OPT-4304] - create a resuable multi-value input
  • [OPT-4305] - Add options dropdown to multi-select
  • [OPT-4308] - Add multiple roles at once to a collection
  • [OPT-4312] - Use the multi value input for defining number and string variable filter values
  • [OPT-4351] - Evaluate combined incident reports
  • [OPT-4382] - I can filter for cancelled flow nodes
  • [OPT-4383] - I can see cancelled flow nodes for flow node reports

Design Part

  • [OPT-3690] - True multi select
  • [OPT-3898] - Grouping options in the UI
  • [OPT-3938] - Design approach to displaying incomplete, empty and broken reports
  • [OPT-4010] - UX Deep link into filtered dashboard

Sub-task

  • [OPT-4007] - Change button to text link
  • [OPT-4009] - Document String Variable Contains filter
  • [OPT-4026] - GroupBy Date Reports Refactoring Iteration 1
  • [OPT-4027] - GroupBy date Reports Refactoring Iteration 2
  • [OPT-4028] - Add performance tests for event based processes
  • [OPT-4029] - Add performance tests for fetching variables
  • [OPT-4033] - Process variable name endpoint uses composite aggregation
  • [OPT-4034] - Decision variable endpoints use composite aggregation
  • [OPT-4039] - Add definition key endpoint query parameter
  • [OPT-4040] - Remove exclude event process flag from definition key endpoint
  • [OPT-4041] - Use the Camunda query parameter when fetching definition keys for event based processes
  • [OPT-4042] - Prevent adding event sources where camunda events have not been imported
  • [OPT-4043] - Update event based process documentation with reasons for presence of definition keys
  • [OPT-4054] - Return entities according to sort parameters
  • [OPT-4055] - Return collection entities according to sort parameters
  • [OPT-4060] - Remove unused query param adjustment logic
  • [OPT-4064] - Adjust performance tests to make use of sorting
  • [OPT-4087] - GroupBy Process instance Duration for ProcessInstanceCount View reports
  • [OPT-4088] - GroupBy FlowNodeDuration for FlowNodeCount View reports
  • [OPT-4089] - GroupBy UserTaskDuration for UserTaskCount View reports
  • [OPT-4090] - Custom number bucket configuration for groupByDuration reports
  • [OPT-4091] - Create and store Optimize installation ID
  • [OPT-4103] - Combined Report range calculation for groupByDuration reports
  • [OPT-4112] - Add Telemetry Permissions Configuration
  • [OPT-4113] - Document Telemetry Permissions Config Setting
  • [OPT-4119] - Add information of whether to display settings modal
  • [OPT-4120] - Inform users whether telemetry is enabled or not
  • [OPT-4121] - Add settings modal for superusers
  • [OPT-4123] - Add telemetry reporter
  • [OPT-4124] - Add telemetry data DTOs for telemetry request payload
  • [OPT-4133] - Add License Key information to telemetry data
  • [OPT-4136] - Allow distribution of process instance count date reports by boolean and string variables
  • [OPT-4138] - add multi-line chart to distributed reports
  • [OPT-4141] - Add distribution by variable dropdown to process instance date reports
  • [OPT-4142] - add distribution by start/end for process instance count reports grouped by variable
  • [OPT-4144] - Add distribution by start/end date dropdown to process instance reports
  • [OPT-4148] - Adjust telemetry endpoint to production endpoint
  • [OPT-4149] - Remove deprecated `customNumberBucket` field
  • [OPT-4154] - Part 1: Refactor DistributedBy within config
  • [OPT-4155] - Adjust frontend to part 1 of distributedBy refactor
  • [OPT-4160] - Move Settings getter api to UIConfig api
  • [OPT-4163] - GroupBy FlowNodeDuration reports can be distributed by flow node
  • [OPT-4172] - UserTaskCount GroupBy idle/work/total duration
  • [OPT-4174] - GroupBy UserTaskDuration reports can be distributed by userTask
  • [OPT-4179] - Evaluate incident resolution duration grouped by none reports
  • [OPT-4180] - Add incident count grouped by flownode
  • [OPT-4181] - Add incident count/resolution duration reports to front-end
  • [OPT-4185] - Update telemetry login page information
  • [OPT-4186] - Document new Report Types
  • [OPT-4188] - Apply pagination parameters for unsaved raw data reports
  • [OPT-4196] - apply pagination to raw data table reports
  • [OPT-4200] - Add distribution of instance duration date reports by boolean and string variables
  • [OPT-4202] - Migrate upgrade-es-schema-tests from Ant to Groovy
  • [OPT-4203] - Merge upgrade-es-schema-tests and upgrade-optimize-data module
  • [OPT-4208] - Apply pagination parameters for saved raw data reports
  • [OPT-4209] - Convert Export service to response with pagination response
  • [OPT-4210] - Non raw data reports should not accept pagination parameters
  • [OPT-4211] - Support pagination for evaluation of shared reports
  • [OPT-4212] - Add distribution of instance count/duration date reports by number variable
  • [OPT-4227] - Remove isComplete flag from raw report evaluation response
  • [OPT-4229] - add sorting to events table in event based processes
  • [OPT-4230] - Add Camunda event counts to backend responses
  • [OPT-4231] - Make event count field sortable
  • [OPT-4232] - Update event mapping documentation to explain event counts
  • [OPT-4233] - Persist event labels for Camunda events so they can be returned in the event count
  • [OPT-4234] - Add placeholder engine installation ID list
  • [OPT-4237] - update user guide
  • [OPT-4243] - Enable count column sorting in events table
  • [OPT-4245] - Incident data is imported to Optimize
  • [OPT-4254] - Add distribution of instance count/duration date reports by date variable
  • [OPT-4264] - Add new Optimize readiness endpoint
  • [OPT-4265] - Optimize readiness endpoint usage is documented
  • [OPT-4267] - Add default values for customBuckets and dateVar unit to existing reports
  • [OPT-4271] - use 'distributedByCustomBucket' config for distributed reports
  • [OPT-4274] - Split License Key information and do not send full license key
  • [OPT-4275] - Update modal text for super user to align with Runtime Engine
  • [OPT-4301] - Migrate CI jobs to check Optimize status using new readiness endpoint
  • [OPT-4307] - Add incidents to data generation
  • [OPT-4313] - Store historic activity instance cancellation state
  • [OPT-4315] - Exclude canceled flow nodes from the executed flow node filter
  • [OPT-4316] - Add a new filter for cancelled flow nodes
  • [OPT-4317] - Documentation explains possible data inconsistency
  • [OPT-4318] - Add a new FlowNodeExecutionState for cancelled flow nodes
  • [OPT-4321] - Import incidents of custom types
  • [OPT-4324] - Evaluate incident count grouped by none reports
  • [OPT-4325] - add formatting to legends in distribute by variable reports with bucket config
  • [OPT-4326] - Add DistributeBy start/end date instance duration reports grouped by variable
  • [OPT-4327] - Upgrade succeeds if target version is already present
  • [OPT-4328] - Document how to run the Optimize upgrade as part of starting Optimize
  • [OPT-4329] - The Optimize upgrade can be run as part of the Optimize startup
  • [OPT-4341] - Handle incidents with missing process instance ids
  • [OPT-4348] - Add a configuration option in the ui-configuration to hide the logout
  • [OPT-4349] - Hide the logout button based on the ui-configuration options
  • [OPT-4363] - Adjust license key telemetry data
  • [OPT-4372] - Document sharing filtered dashboards
  • [OPT-4373] - prevent using process part for duration reports distributed by variable
  • [OPT-4381] - Add incident duration grouped by flownode
  • [OPT-4386] - Add documentation for dashboard templates
  • [OPT-4387] - Save user task cancelation state on completed activity instance import
  • [OPT-4389] - Update modal text to clarify inconsistency
  • [OPT-4406] - add user guide docs

Edit/Copy Release Notes

The text area below allows the project release notes to be edited and copied to another document.