Document job result in Job Workers concept page #4813
+37
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👋 🤖 🤔 Hello, @ce-dmelnych! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
ce-dmelnych
added
8.7.0-alpha3
- Added a short section on job results in `completing or failing jobs`. - Linked to the `User task listeners` concept page - Added note that job result is used for the user task listeners only right now. Co-authored-by: Ana Vinogradova <[email protected]>
ce-dmelnych
force-pushed
the
26344-job-workers-document-job-result
branch
from
f0b6578 to
30a6955
Compare
|
The preview environment relating to the commit b0ae4ad has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4813/index.html |
ce-dmelnych
changed the title
korthout
approved these changes
Jan 7, 2025
| Job results are used to define: | ||
|
|
||
| 1. **Corrections**: Updates to specific user task attributes, such as assignee, due date, follow-up date, candidate users, candidate groups, and priority, before the task transition is finalized. For more details, see [Correcting user task data](components/concepts/user-task-listeners.md/#correcting-user-task-data). | ||
| 2. **Denial**: Indicates that the operation should be explicitly denied. Denying an operation prevents the task lifecycle transition and discards any corrections made by previous listeners. For more details, see [Denying the operation](components/concepts/user-task-listeners.md/#denying-the-operation). |
There was a problem hiding this comment.
Similar to other documentation about the topic, let's refer to task lifecycle transition rather than operation.
Suggested change
| 2. **Denial**: Indicates that the operation should be explicitly denied. Denying an operation prevents the task lifecycle transition and discards any corrections made by previous listeners. For more details, see [Denying the operation](components/concepts/user-task-listeners.md/#denying-the-operation). | |
| 2. **Denial**: Indicates that the lifecycle transition should be explicitly denied. Denying the task lifecycle transition rolls back the user task to the previous state, and discards any corrections made by previous listeners. For more details, see [Denying the operation](components/concepts/user-task-listeners.md/#denying-the-operation). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Scope:
completing or failing jobs.User task listenersconcept pageThese changes were made together by @ana-vinogradova-camunda and @ce-dmelnych so they don't require additional Engineering review. A Technical writer review is appreciated.
closes camunda/camunda#26344
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).