Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(content/update): migration guide Process Instance Modification #1689

Merged
merged 4 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion content/update/minor/721-to-722/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ This document guides you through the update from Camunda `7.21.x` to `7.22.0` an
1. For administrators and developers: [Sending telemetry feature removed](#sending-telemetry-feature-removed)
1. For administrators: [Database transaction isolation level `READ_COMMITTED` is enforced](#database-transaction-isolation-level-read-committed-is-enforced)
1. For developers: [Quarkus 3.14 Extension Update](#quarkus-3-14-extension-update)
1. For administrators and developers: [Process Instance Modification Filter Changes](#process-instance-modification-filter-changes)

This guide covers mandatory migration steps and optional considerations for the initial configuration of new functionality included in Camunda 7.22.

Expand Down Expand Up @@ -292,4 +293,25 @@ This requires using the new namespace `generic-config`.

For a detailed guide on the new Quarkus properties, visit the updated [Quarkus Configuration]({{< ref "/user-guide/quarkus-integration/configuration.md" >}}) page.

To read more on how Quarkus extensions treat configuration differently, see this [Quarkus Migration Guide](https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers) and the [Mapping Configuration to Objects Guide](https://quarkus.io/guides/config-mappings).
To read more on how Quarkus extensions treat configuration differently, see this [Quarkus Migration Guide](https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.14#for-extension-developers) and the [Mapping Configuration to Objects Guide](https://quarkus.io/guides/config-mappings).

# Process Instance Modification Filter Changes

The [Process Definition View][process-instance-modification] dialog of Camunda Cockpit has been updated to use the Historic API. With this change, the `start date` filter is now available within the workflow.

[process-instance-modification]: {{< ref "/webapps/cockpit/bpmn/process-instance-modification.md#perform-a-batch-modification" >}}

## Saved Filters are Now Isolated
Filters saved in the Modify Process Instance workflow were previously shared across other pages. With this update, the filters of Modify Process Instance workflow and other pages are isolated and independent of each other.

{{< note title="Heads-up!" class="warning" >}}
After migrating to the new version of Camunda, no saved filters will be available in the Modify Process Instance workflow. Users will need to re-enter and save these filters following the migration. Please notify your users before the migration.
{{< /note >}}

## Edge Cases with Behavioral Changes

- Tokens on Async Tasks: Tokens sitting on an `asyncBefore`/`asyncAfter` task will not yield process instances when using the `activityIdIn` filter, as no history has been produced yet. Filtering here is effectively racing against the job executor. Given the job executor usually processes faster than a user can apply filters, state changes can impact query results. This filter is most applicable for true wait states (e.g., user tasks, external tasks, timers) rather than transaction boundaries.

- Compensation Scenarios: It is no longer possible to retrieve process instances with the `activityIdIn` filter on the subprocess "activity". When using `activityIdIn` filter for compensation scenarios, users need to filter by specific flow nodes rather than the broader subprocess activities.

- Incident Deletion: When an incident is deleted, the incident filters will still return the process instances that previously had an incident. This behavior aligns with the standalone batch operation page and ensures consistency across the application.
2 changes: 1 addition & 1 deletion content/user-guide/process-engine/process-engine-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ OR queries enable building queries in which filter criteria are linked together
{{< note title="Heads-up!" class="info" >}}
- This functionality is only available for task and process instance queries (runtime & history).
- The following methods cannot be applied to an OR query: orderBy...(), initializeFormKeys(),
withCandidateGroups(), withoutCandidateGroups(), withCandidateUsers(), withoutCandidateUsers().
withCandidateGroups(), withoutCandidateGroups(), withCandidateUsers(), withoutCandidateUsers(), incidentIdIn().
{{< /note >}}

After calling `or()`, a chain of several filter criteria could follow. Each filter criterion is linked together
Expand Down