-
Notifications
You must be signed in to change notification settings - Fork 189
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
Update bpmn-coverage.md #4155
Update bpmn-coverage.md #4155
Conversation
We support Data Object and Data Store in Modeler + for execution. This needs to be reflected in bpmn-coverage
👋 🤖 🤔 Hello, @christinaausley! 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While we allow processes with DataObject
and DataStore
, we don't really support these BPMN concepts. We simply don't use them in the execution.
I'm not confident in saying that we provide coverage for these concepts. I believe this would require using DataInput
and DataOutput
for Activities
like Service Tasks
. Instead, we just don't break when BPMN models contain DataObject
and DataStore
, but they are not actively used in the execution of the model.
IMO, we should discuss this with other BPMN experts before merging.
TLDR: Data stores, input and output have always been modeling only from Camunda's perspective, in C8 and C7. We don't support any of the "data features" beyond modeling (for documentation purposes) that the BPMN standard defines. BPMN implements data on two layers:
The later one is a direct competition to our own data mappings (both C7 and C8). An answer to our users could be to mark them as supported (*) with the disclaimer that this includes "modeling only/for documentation" and that we do not support IO-mappings as defined in the BPMN standard. From the spec: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me know when you're ready for final review @aleksander-dytko 👍
@aleksander-dytko - nudging you on this docs PR. |
@aleksander-dytko Ready for final review here? 😄 |
@aleksander-dytko what's the status of this PR? |
Followed up with Aleksander on Slack and I'm going to help refactor this PR to include Nico’s suggestion (disclaimer for modeling only). |
@aleksander-dytko I've incorporated a disclaimer for |
@@ -140,15 +140,19 @@ import CompensationSvg from './assets/bpmn-symbols/compensation.svg' | |||
|
|||
## Data | |||
|
|||
:::note | |||
`DataObject` and `DataStore` are supported by Camunda for modeling purposes only. Camunda does not support any additional data features the BPMN standard defines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could also frame this as "we don't support BPMN standard IO mappings (but of course allow you to map IO (in our very simple, CAmunda style) [link to our documentation for that]". This may read as "We do not support data features".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about "DataObjectand
DataStore`, like other BPMN standard IO mappings, are supported by Camunda for modeling purposes only."? We could leave out "Camunda does not support any additional data features the BPMN standard defines."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops I think we forgot about this @nikku -- WDYT here? CC @aleksander-dytko
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could leave out "Camunda does not support any additional data features the BPMN standard defines."
Yea, we could leave it out, or link to our own support for I/O. Probably easiest to leave it out.
@nikku This is ready for final review 👍 @aleksander-dytko Should this be backported? |
I am going to go ahead and merge this. If needed, can backport in a separate PR. CC @aleksander-dytko as I know he is OOO. |
We support Data Object and Data Store in Modeler + for execution. This needs to be reflected in bpmn-coverage
Description
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).