-
Feature Request
-
Resolution: Fixed
-
L3 - Default
-
None
-
None
-
None
User story
When working on incidents, I want to add an annotation to them so that the next person trying to resolve an open incident is up to date.
Background
Some teams have concierge roles to check for incidents in Camunda and resolve them.
As some incidents cannot be resolved during the day, there is a need to perform Incident status coordination - doing that outside Camunda is not efficient.
Therefore, the request is to have a comment facility in Cockpit were a small annotation can be left.
Acceptance criteria
- I can add/edit/delete an annotation at runtime process instance incidents that inform the next operator
- The general scope is the same as
CAM-9556, i.e. I can add an annotation to an incident and edit/delete it at any time; a comment thread or something similar is not in the scope of this ticket - The annotation is immediately propagated to the historic incident as well
- The annotation is read-only in the historic incidents
- The user needs to have the same authorizations needed to resolve an incident - any of UPDATE on PROCESS_INSTANCE and UPDATE_INSTANCE on PROCESS_DEFINITION
This is the controller panel for Smart Panels app
1.
|
In Java API, I can add/edit/delete an annotation for an incident |
|
Closed | Unassigned |
2.
|
In REST API, I can add/edit/delete an annotation for an incident |
|
Closed | Unassigned |
3.
|
In Cockpit, I can add/edit/delete an annotation for an incident |
|
Closed | Hariharan Parasuraman |
[CAM-12270] I want to add an annotation to incidents
Decisions
- We prefer the term annotation instead of comment in this case because
- comments are usually considered as a n:1 cardinality; The cardinality of annotating an incident should be 1:1
- the feature should not be compared to the already existing feature to add comments to a task
- it is consistent with the annotation feature on the User Operation Log built with
CAM-9556
- Annotations will
- be editable in Runtime Views (Process Definition and Process Instance View)
- be propagated to the corresponding historic incident immediately and visible in Historic Views (Historic Process Definition and Historic Process Instance View)
- require the same rights that the resolution of incidents does, so any of
- UPDATE permission on resource "Process Instance"
- UPDATE_INSTANCE permission on resource "Process Definition"
- be retrieved by querying the incident itself
- new column ANNOTATION_ is of type VARCHAR(4000)
- In most use cases the amount of characters is enough
- If the user want's to store an annotation > 4000, alternative storing solutions should be considered; The annotation field can than be used to store the reference to the alternative storing solution
- A REST API endpoint for setting and clearing the annotations will be built
- Consistent with annotations on User Operation Logs, an "annotation" column will be added to the necessary views (being editable in runtime views)
Hallo Andre,
This captures our requirements perfectly.
Regards
Casper