camunda-docs icon indicating copy to clipboard operation
camunda-docs copied to clipboard

Update bpmn-coverage.md

Open aleksander-dytko opened this issue 1 year ago • 6 comments

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?

  • [ ] This is a bug fix, security concern, or something that needs urgent release support.
  • [x] This is already available but undocumented and should be released within a week.
  • [ ] This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • [ ] This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • [ ] There is no urgency with this change and can be released at any time.

PR Checklist

  • [ ] My changes are for an already released minor and are in /versioned_docs directory.
  • [ ] My changes are for the next minor and are in /docs directory (aka /next/).

aleksander-dytko avatar Aug 14 '24 11:08 aleksander-dytko

:wave: :robot: :thinking: 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/.

  • docs/components/modeler/bpmn/bpmn-coverage.md

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.

github-actions[bot] avatar Aug 14 '24 11:08 github-actions[bot]

@korthout thanks for sharing your opinion.

@saig0 @nikku could you support us here to define what would be needed so that we can claim we support Data store and data object elements?

aleksander-dytko avatar Aug 14 '24 12:08 aleksander-dytko

@saig0 @nikku could you support us here to define what would be needed so that we can claim we support Data store and data object elements?

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:

  • Visual, i.e. data stores and data objects, documentation only
  • For execution (+visual) using IO mappings (data input, and data output)

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:

image

image

image

nikku avatar Aug 14 '24 14:08 nikku

@aleksander-dytko - nudging you on this docs PR.

akeller avatar Aug 26 '24 18:08 akeller

@aleksander-dytko Ready for final review here? 😄

christinaausley avatar Sep 13 '24 20:09 christinaausley

@aleksander-dytko what's the status of this PR?

akeller avatar Sep 23 '24 21:09 akeller

Followed up with Aleksander on Slack and I'm going to help refactor this PR to include Nico’s suggestion (disclaimer for modeling only).

christinaausley avatar Oct 07 '24 16:10 christinaausley

@aleksander-dytko I've incorporated a disclaimer for DataObject and DataStore -- if this looks good to you, I will backport.

christinaausley avatar Oct 10 '24 17:10 christinaausley

@nikku This is ready for final review 👍

@aleksander-dytko Should this be backported?

christinaausley avatar Nov 25 '24 15:11 christinaausley

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.

christinaausley avatar Dec 09 '24 15:12 christinaausley

@christinaausley thanks for following up!

This feature was introduced with 8.2 - please backport this feature for versions <=8.2. Thanks!

aleksander-dytko avatar Dec 23 '24 13:12 aleksander-dytko