camunda / connectors

Camunda Connectors
https://docs.camunda.io/docs/components/integration-framework/connectors/out-of-the-box-connectors/available-connectors-overview/
Apache License 2.0
39 stars 38 forks source link

Message start event templates should not have a Correlation key (process) property #3224

Open chillleader opened 2 weeks ago

chillleader commented 2 weeks ago

Describe the Bug

All generated message start event element templates have both Correlation key (process) and Correlation key (payload). However, Correlation key (process) does not apply to message start event (since the process is not yet running and has no variables). Although present in the element template, this redundant property doesn't show up in the latest versions of the Modeler.

Steps to Reproduce

  1. Go to the Modeler
  2. Apply a message start event element template for any connector
  3. Make sure there is no Correlation key (process) in the properties panel
  4. Inspect the element template JSON and discover the Correlation key (process) property there

Expected Behavior

We should remove this property from all message start event templates

chillleader commented 1 week ago

Concern: correlation key is needed for message start events inside subprocesses

johnBgood commented 1 week ago

Discussion about the example below (https://camunda.slack.com/archives/C02JLRNQQ05/p1725454462715789)

Example BPNM:

simpleTest.bpmn.txt

nikku commented 1 week ago

We identified that correlationKey cannot simply be removed, but there is different use-cases for message start events:

The documentation currently states:

The binding name of correlationKey is not applicable to message start events on a process. In such cases, the property is automatically hidden.

So while this property is redundant in some scenarios, it is applicable in others, and our implementation should already handle that case (*).

* To be verified 🙂