Support documentation URL in element template

[nikku]

Is your feature request related to a problem? Please describe

As a user I want to see detailed documentation for a templated task, to be shown in the properties panel as well as the template chooser.

Describe the solution you'd like

• I can attach a documentation URL to an elemen template

Describe alternatives you've considered

None.

Additional context

Example showing an integration into the properties panel:

Example showing an integration into the element / template chooser:

---

Related to #610.

[pinussilvestrus]

I would imagine it something like

// Element Template
{
  "name": "My Task",
  "id": "com.camunda.example.MyTask",
  "appliesTo": [ "bpmn:ServiceTask" ],
  "description": "An example task",
  "documentationRef": "https://www.example.com/myTask"
}

// JSON Schema
{
  "documentationRef": {
    "$id": "#/documentaionRef",
    "type": "string",
    "pattern": "^(https|http)://.*", // or whatever pattern we use
    "errorMessage": {
      "pattern": "Malformed documentation URL"
    }
  }
}

[nikku]

Yes, that makes sense as a start. We can relax it at a future date (i.e. also allow relative URLs).

[pinussilvestrus]

@MaxTru @marstamm could you maybe have a look at my proposal (cf. #614 (comment))? If there is nothing against it, I could already start bringing the new property to the Schema.

I would even say let's support it for both 7 and 8, there is no reason to only focus it on Camunda Platform 8.

[marstamm]

I don't see any problems with this approach, I think we can go ahead with it

[MaxTru]

👍 from me as well

[pinussilvestrus]

This is fixed upstream via camunda/element-templates-json-schema#47. A schema release is pending, though.

[MaxTru]

Implementation to follow-up with: #616