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

Documentation for end execution listeners does not explicitly state that end listeners will always trigger at the end of the activity. #3046

Closed
alan-pilic-ca opened this issue Jan 4, 2023 · 3 comments · Fixed by camunda/camunda-docs-manual#1446
Assignees
Labels
scope:documentation Changes to the product documentation. type:task Issues that are a change to the project that is neither a feature nor a bug fix. version:7.20.0-alpha1 version:7.20.0

Comments

@alan-pilic-ca
Copy link

Acceptance Criteria (Required on creation)

Documentation for end execution listeners does not explicitly state that end listeners will always trigger at the end of the activity.

For this specific use case, the customer creates an interrupting sub process that gets triggered, in addition, they add in a user task in the parent process with an end event execution listener. The confusion lies in the fact that the end execution listener fires even though the user task was not completed.

This is working as intended but in the documentation we don’t state explicitly that the end listener will always kick off when the activity has ended, even if the activity was interrupted.

Would it be possible to clarify this in the documentation for end execution listeners?

Hints

Here is what we have documented in our documentation specifically about end execution listeners.

image

Link to Documentation: https://docs.camunda.org/manual/7.18/user-guide/process-engine/delegation-code/#execution-listener:~:text=Java%20Delegates.-,Execution%20Listener,-Execution%20listeners%20allow

Links

https://jira.camunda.com/browse/SUPPORT-15500

Breakdown

Screenshot of simple BPMN breakdown of what is referenced up top.

image

Please let me know if you can provide any additional insight or if you have any questions.

@alan-pilic-ca alan-pilic-ca added the type:task Issues that are a change to the project that is neither a feature nor a bug fix. label Jan 4, 2023
@danielkelemen danielkelemen self-assigned this Jan 5, 2023
@danielkelemen
Copy link
Member

Hi @alan-pilic-ca, thanks for opening the issue and trying to improve our documentation!
Do you have any suggestions to what the documentation could look like to make this behaviour more obvious?
If you feel like you could even open a PR in the camunda-docs-manual repository.

@danielkelemen danielkelemen added the scope:documentation Changes to the product documentation. label Jan 16, 2023
@alan-pilic-ca
Copy link
Author

Hi @danielkelemen,

This would be our addition to the documentation. For context, it is the note with the title of "End execution listeners for users tasks".

image

Image provided above, let me know what you think.

This would be right above the highlighted section of this link.

Best,
Alan

@ThorbenLindhauer
Copy link
Member

I have worded it a bit differently, in my opinion clearer, and we will merge this into the 7.20 development branch. See camunda/camunda-docs-manual#1446

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:documentation Changes to the product documentation. type:task Issues that are a change to the project that is neither a feature nor a bug fix. version:7.20.0-alpha1 version:7.20.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants