process-analytics / bpmn-visualization-js

A TypeScript library for visualizing process execution data on BPMN diagrams
https://process-analytics.github.io/bpmn-visualization-js/
Apache License 2.0
216 stars 29 forks source link

[FEAT] Detect the Compensation Marker of an activity #347

Open csouchet opened 4 years ago

csouchet commented 4 years ago

Is your feature request related to a problem? Please describe. BPMN specifies three types of markers for Task: a Loop marker or a Multi-Instance marker and a Compensation marker. A Task MAY have one or two of these markers.

image

image

Additional context The final shape rendering of the compensation marker won't be done as part of this issue and will be managed later, see #355.

⚠️ Check the contribution guidelines for BPMN support prior starting the implementation. For additional help about this specific issue, see https://github.com/process-analytics/bpmn-visualization-js/issues/347#issuecomment-1284336180

tbouffard commented 1 year ago

Additional information for the implementation

Note: based on the v0.27.1 code base

Parsing tests All marker parsing tests are in BpmnJsonParser.marker.test.ts and involve task, subprocess, call activity Add a test for the compensation marker (in addition to existing tests for LOOP or MULTI_INSTANCE_PARALLEL) Add test for several markers

Visual tests They test the marker position, defined in markers.01.positioning.bpmn Some use cases involving several markers are missing so the diagram must be updated, for instance

image

Parsing code ProcessConverter buildMarkers: consider the isForCompensation field, try to remove the existing ts-ignore directives as the function has a TActivity parameter that has the right type.

Rendering code (remember that only the inital rendering is implemented as part of this issue) The marker order is already defined: see orderActivityMarkers in render/utils.ts, so the markers will be rendered in the right order The rendering code is located in BaseActivityShape

tbouffard commented 1 year ago

@fatimabailoun welcome aboard, I have assigned the issue to you

tbouffard commented 1 year ago

@fatimabailoun I have just seen that you removed your assignment yesterday. Does that mean that you are not going to work on this issue?

ghost commented 1 year ago

Hi thomas yes i did not know how to inform you so i just unassigned the issue, i am sorry for that i was having some personal issues.. Thank you and good luck 🤞

On Fri, Oct 28, 2022, 7:10 PM Thomas Bouffard @.***> wrote:

@fatimabailoun https://github.com/fatimabailoun I have just seen that you removed your assignment yesterday. Does that mean that you are not going to work on this issue?

— Reply to this email directly, view it on GitHub https://github.com/process-analytics/bpmn-visualization-js/issues/347#issuecomment-1295180652, or unsubscribe https://github.com/notifications/unsubscribe-auth/A3SDGWXKRO6ULSHM2PDH3RTWFP3GLANCNFSM4OGWA5NQ . You are receiving this because you were mentioned.Message ID: @.***>

tbouffard commented 1 year ago

No problem @fatimabailoun, take care. Don't hesitate to post a comment if you want to try to contribute again in the future.