Skip to content
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.

Sign up for GitHub

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

docs(element-templates): clarify modelerTemplate property #2794

Merged
merged 1 commit into from
Mar 1, 2022
+13 −3
Merged

docs(element-templates): clarify modelerTemplate property #2794

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/element-templates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,32 @@ Clicking the `Catalog` button will bring up a modal menu allowing to browse and

![Modal Menu](./modal.png)

Applying a template will store it via the `camunda:modelerTemplate` property and the optional `camunda:modelerTemplateVersion` property on the selected element:
Applying a template will store it via the `modelerTemplate` property and the optional `modelerTemplateVersion` property on the selected element:

Camunda Platform

```xml
<bpmn:serviceTask id="MailTask"
camunda:modelerTemplate="com.mycompany.MailTask"
camunda:modelerTemplateVesion="1" />
```

Camunda Cloud

```xml
<bpmn:serviceTask id="MailTask"
zeebe:modelerTemplate="com.mycompany.MailTask"
zeebe:modelerTemplateVesion="1" />
```

It will also setup custom fields on the diagram element and make these available to the user for inspection and editing. Properties which were not configured in the element template using custom fields, will not be available for editing for the user.

### Removing Templates

To remove an applied template from an element, either the *Unlink* or *Remove* function can be used:

* *Remove*: Remove the element template from the `camunda:modelerTemplate` property and also reset all properties of the respective element.
* *Unlink*: Remove the element template from the `camunda:modelerTemplate` property but keep the properties which were set.
* *Remove*: Remove the element template from the `modelerTemplate` property and also reset all properties of the respective element.
* *Unlink*: Remove the element template from the `modelerTemplate` property but keep the properties which were set.

![Unlink or Remove](./unlink-remove.png)

Expand Down