feat(DMN): add hints on the returned Java types

[falko]

No description provided.

[nikku]

Thanks for your PR.

Just based on the code you submitted (without any explaination) it is not quite clear what you would you like to achieve. Could you elaborate why this is an improvement (from the user perspective)?

[falko]

Sorry for my brevity while opening this live during a customer workshop.

In consulting, we frequently experience that customers do not understand the result mapping and what they can expect from the different settings. In our developer trainings, we explain that with the resulting Java types. So the next logical step was to put that type hint also into the labels shown in the property panel. That way users can decide easier and don't have to search the docs or write unit tests in order to figure it out.

[falko]

To give even more context:
DMN Decision Tables have different result structures, depending on the Hit Policy. By selecting a mapping that matches the result structure of their model, users can simplify the work with the result later in the process, e.g. in expressions.

[nikku]

As an alternative to your solution we could simply link the docs, too. Which solution would you prefer?

[falko]

Both.

[falko]

I guess, this would be the right link to put: https://docs.camunda.org/manual/latest/user-guide/process-engine/decisions/bpmn-cmmn/#predefined-mapping-of-the-decision-result

Nevertheless, we could save people some time by directly putting the hints in the labels, which are not exactly self-explanatory.

[falko]

Should this already be available in 3.0.0-nightly builds? I didn't see it there.

[nikku]

It is in there, however with a display bug:

[falko]

It is in there, however with a display bug:

Any idea how to fix that display bug? Encoding? HTML entities?

[nikku]

We do not properly sanitize element labels we build the UI from: https://github.com/bpmn-io/bpmn-js-properties-panel/blob/master/lib/factory/SelectEntryFactory.js#L51

This means that entities such as < have interesting effects on the UI.

[nikku]

I've created #296 to track the bug.

[falko]

Is there anything that I can do as a workaround until #296 is fixed?

[nikku]

Unfortunately not. We scheduled #296 this as a bug in our next milestone.