Skip to main content

Defining templates

Templates are defined in template descriptor files as a JSON array:

[
  {
    "$schema": "https://unpkg.com/@camunda/element-templates-json-schema/resources/schema.json",
    "name": "Template 1",
    "id": "sometemplate",
    "description": "some description",
    "version": 1,
    "appliesTo": [
      "bpmn:Task"
    ],
    "elementType": {
      "value": "bpmn:ServiceTask",
    },
    "properties": [
      ...
    ]
  },
  {
    "name": "Template 2",
    ...
  }
]

As seen in the code snippet a template consist of a number of important components:

  • $schema : String: URI pointing towards the JSON schema which defines the structure of the element template .json file. Element template schemas are maintained in the element templates JSON schema repository. Following the JSON schema standard, you may use them for validation or to get assistance (e.g., auto-completion) when working with them in your favorite IDE. Note that the $schema attribute is required for Camunda Platform 8 element templates.

    Camunda Platform 7 example:

    "$schema": "https://unpkg.com/@camunda/element-templates-json-schema/resources/schema.json"

    Camunda Platform 8 example:

    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json"

  • name : String: Name of the template. Will be shown in the element template selection modal and in the properties panel (after having applied an element template).

  • id : String: ID of the template.

  • description : String: Optional description of the template. Will be shown in the element template selection modal and in the properties panel (after having applied an element template).

  • documentationRef : String: Optional URL pointing to a template documentation. Will be shown in the properties panel (after having applied an element template).

  • version : Integer: Optional version of the template. If you add a version to a template it will be considered unique based on its ID and version. Two templates can have the same ID if their version is different.

  • appliesTo : Array<String>: List of BPMN types the template can be applied to.

  • elementType : Object: Optional type of the element. If you configure elementType on a template then the element will be replaced with the specified type when a user applies the template.

  • properties : Array<Object>: List of properties of the template.

JSON schema compatibility​

The application uses the $schema property to ensure compatibility for a given element template. You find the latest supported versions here:

The tooling will ignore element templates defining a higher $schema version and will log a warning message.

For example, given the following $schema definition, the application takes 0.9.1 as the JSON Schema version of the element template.

"$schema": "https://unpkg.com/@camunda/element-templates-json-schema@0.9.1/resources/schema.json"

The JSON Schema versioning is backward-compatible, meaning that all versions including or below the current one are supported. In case no $schema is defined, Camunda Modeler assumes the latest JSON Schema version for Camunda Platform 7 element templates.

Learn more about specifing a $schema here.

Supported BPMN types​

Currently, element templates may be used on the following BPMN elements:

  • bpmn:Activity (including tasks, service tasks, and others)
  • bpmn:SequenceFlow (for maintaining condition)
  • bpmn:Process
  • bpmn:Event

Defining template properties​

With each template, you define some user-editable fields as well as their mapping to BPMN 2.0 XML as well as Camunda extension elements.

Let us consider the following example that defines a template for a mail sending task:

{
  "$schema": "https://unpkg.com/@camunda/element-templates-json-schema/resources/schema.json",
  "name": "Mail Task",
  "id": "com.camunda.example.MailTask",
  "appliesTo": ["bpmn:ServiceTask"],
  "properties": [
    {
      "label": "Implementation Type",
      "type": "String",
      "value": "com.mycompany.MailTaskImpl",
      "editable": false,
      "binding": {
        "type": "property",
        "name": "camunda:class"
      }
    },
    {
      "label": "Sender",
      "type": "String",
      "binding": {
        "type": "camunda:inputParameter",
        "name": "sender"
      },
      "constraints": {
        "notEmpty": true
      }
    },
    {
      "label": "Receivers",
      "type": "String",
      "binding": {
        "type": "camunda:inputParameter",
        "name": "receivers"
      },
      "constraints": {
        "notEmpty": true
      }
    },
    {
      "label": "Template",
      "description": "By the way, you can use freemarker templates ${...} here",
      "value": "Hello ${firstName}!",
      "type": "Text",
      "binding": {
        "type": "camunda:inputParameter",
        "name": "messageBody",
        "scriptFormat": "freemarker"
      },
      "constraints": {
        "notEmpty": true
      }
    },
    {
      "label": "Result Status",
      "description": "The process variable to which to assign the send result to",
      "type": "String",
      "value": "mailSendResult",
      "binding": {
        "type": "camunda:outputParameter",
        "source": "${ resultStatus }"
      }
    },
    {
      "label": "Async before?",
      "type": "Boolean",
      "binding": {
        "type": "property",
        "name": "camunda:asyncBefore"
      }
    }
  ]
}

The example defines five custom fields, each mapped to different technical properties:

  • Implementation Type is mapped to the camunda:class property in BPMN 2.0 XML
  • Sender, Receivers and Template properties are mapped to input parameters
  • Result Status is mapped back from the Java delegate into a process variable via an output parameter

All but the Implementation Type are editable by the user through the properties panel as shown in the following screenshot:

Custom Fields

As seen in the example the important attributes in a property definition are:

  • label: A descriptive text shown with the property
  • type: Defining the visual appearance in the properties panel (may be any of String, Text, Boolean, Dropdown or Hidden)
  • value: An optional default value to be used if the property to be bound is not yet set
  • binding: Specifying how the property is mapped to BPMN or Camunda extensions (cf. bindings)
  • constraints: A list of editing constraints to apply to the template

In addition, Camunda Platform 8 supports these properties:

  • id: An identifier that can be used to reference the property in conditional properties
  • condition: A condition that determines when the property is active

Types​

The input types String, Text, Boolean, Dropdown and Hidden are available. As seen above String maps to a single-line input, Text maps to a multi-line input.

Boolean / checkbox type​

The Boolean type maps to a checkbox that can be toggled by the user. It renders as shown below:

Boolean / Checkbox control

When checked, it maps to true in the respective field (see bindings). Note that it does not map to ${true} and can therefore not be used e.g., for mapping a boolean to a process variable.

The Dropdown type allows users to select from a number of pre-defined options that are stored in a custom properties choices attribute as { name, value } pairs:

...
  "properties": [
    ...
    {
      "label": "Task Priority",
      "type": "Dropdown",
      "value": "50",
      "choices": [
        { "name": "low", "value": "20" },
        { "name": "medium", "value": "50" },
        { "name": "height", "value": "100" }
      ]
    }
  ]
...

The resulting properties panel control looks like this:

properties panel drop down

Omitted type​
note

Omitting the type is supported in Camunda Platform 7 element templates only.

By omitting the type configuration the default UI component will be rendered for the respective binding.

For camunda:inputParameter and camunda:outputParameter bindings an Input / Output Parameter Mapping component will be rendered. The component will include a toggle to enable or disable the Variable Assignment. When untoggling, the respective camunda:inputParameter or camunda:outputParameter element will not be created in the BPMN XML.

default-rendering

Note that the configuration options editable and constraints will have no effect for the camunda:inputParameter and camunda:outputParameter default component.

For camunda:errorEventDefinition bindings, an Error component will be rendered. The component will include all properties of the referenced bpmn:Error element.

default-errors-rendering

Note that the configuration options editable and constraints will have no effect for the camunda:errorEventDefinition default component.

For the property, camunda:property, camunda:in, camunda:in:businessKey, camunda:out and camunda:field bindings, an omitted type will lead to rendering the String component (single line input).

For the camunda:executionListener binding, an omitted type will lead to the Hidden component (ie. no visible input for the user).

FEEL​
note

FEEL properties are only supported in Camunda Platform 8 element templates.

We support the feel properties optional and required. When set, the input field offers visual indications that a feel expression is expected.

  "properties": [
    {
      "label": "Optional Feel Expression",
      "type": "String",
      "feel": "optional"
    },
    {
      "label": "Required Feel Expression",
      "type": "Text",
      "feel": "required"
    }
  ]
Supported types​

Camunda Platform 8 supports feel on the following input types:

  • String
  • Text

Bindings​

The following ways exist to map a custom field to the underlying BPMN 2.0 XML. The "mapping result" in the following section will use [userInput] to indicate where the input provided by the user in the Properties Panel is set in the BPMN XML. As default or if no user input was given, the value specified in value will be displayed and used for [userInput]. [] brackets will be used to indicate where the parameters are mapped to in the XML.

Notice that adherence to the following configuration options is enforced by design. If not adhering, it logs a validation error and ignores the respective element template.

property​
Binding typeproperty
Valid property type'sall property types are supported
Binding parametersname: the name of the property
Mapping result<... [name]=[userInput] ... />

The property binding is supported both in Camunda Platform 7 and 8.

Optional bindings​

note

Optional bindings are only supported in Camunda Platform 8 element templates.

We support optional bindings that do not persist empty values in the underlying BPMN 2.0 XML.

If a user removes the value in the configured control, it will also remove the mapped element.

[
  {
    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
    "name": "Task example",
    "id": "some-template",
    "appliesTo": ["bpmn:ServiceTask"],
    "properties": [
      {
        "label": "Request",
        "type": "String",
        "optional": true,
        "binding": {
          "type": "zeebe:input",
          "name": "request"
        }
      },
      {
        "label": "Response",
        "type": "Text",
        "optional": true,
        "binding": {
          "type": "zeebe:output",
          "source": "response"
        }
      }
    ]
  }
]
Supported Bindings​

Camunda Platform 8 supports optional on the following binding types:

  • zeebe:input
  • zeebe:output
  • zeebe:taskHeader
  • zeebe:property

Scoped bindings​

note

Scoped bindings are only supported in Camunda Platform 7 element templates.

Scoped bindings allow you to configure nested elements, such as Camunda Platform 7 Connectors.

{
  "name": "ConnectorGetTask",
  "id": "my.connector.http.get.Task",
  "appliesTo": [
    "bpmn:Task"
  ],
  "properties": [],
  "scopes": [
    {
      "type": "camunda:Connector",
      "properties": [
        {
          "label": "ConnectorId",
          "type": "String",
          "value": "My Connector HTTP - GET",
          "binding": {
            "type": "property",
            "name": "connectorId"
          }
        },
        ...
      ]
    }
  ]
}

The example shows how a Connector is configured as part of the task. On task creation, the Connector is created with it and the Connector bindings are exposed to the user in a separate custom fields section.

Scoped Custom Fields

Supported Scopes​

Camunda Platform 7 supports the following scope bindings:

NameTarget
camunda:ConnectorConnectors
bpmn:ErrorGlobal BPMN Error Element

Groups​

You may define groups to organize custom fields into:

{
  "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
  "name": "Groups",
  "id": "group-example",
  "appliesTo": [
    "bpmn:ServiceTask"
  ],
  "groups": [
    {
      "id": "definition",
      "label": "Task definition"
    },
    {
      "id": "request",
      "label": "Request payload"
    },
    {
      "id": "result",
      "label": "Result mapping"
    }
  ],
  "properties": [
    ...
  ]
}

Associate a field with a group (ID) via the fields group key:

{
  ...
  "properties": [
    {
      "label": "Implementation Type",
      "type": "String",
      "group": "definition",
      "binding": {
        "type": "property",
        "name": "camunda:class"
      }
    },
    ...
  ],
  ...
}

Groups

Constraints​

Custom Fields may have a number of constraints associated with them:

  • notEmpty: Input must be non-empty
  • minLength: Minimal length for the input
  • maxLength: Maximal length for the input
  • pattern: Regular expression to match the input against
Regular expression​

Together with the pattern constraint, you may define your custom error messages:

...
  "properties": [
    {
      "label": "Web service URL",
      "type": "String",
      "binding": { ... },
      "constraints": {
        "notEmpty": true,
        "pattern": {
          "value": "https://.*",
          "message": "Must be https URL"
        }
      }
    }
  ]

Icons​

note

Icons are currently supported in Camunda Platform 8 element templates only.

It is possible to define custom icons to update the visual appearance of elements after applying an element template.

[
  {
    "name": "Template 1",
    "id": "sometemplate",
    "appliesTo": [
      "bpmn:ServiceTask"
    ],
    "icon": {
      "contents": "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='22' height='22' viewBox='0 0 22 22' fill='none'%3E%3Ccircle cx='11' cy='11' r='9' fill='black'/%3E%3Ctext x='6.9' y='14.9' fill='white' style='font-family: Arial; font-size: 10px;'%3EM%3C/text%3E%3C/svg%3E"
    },
    "properties": [
      ...
    ]
  }
]

Icons

The icon contents must be a valid data or HTTP(s) URL. We recommend using square icons as they get rendered 18x18 pixels on the canvas and 32x32 pixels in the properties panel.

Display all entries​

Per default, the element template defines the visible entries of the properties panel. All other property controls are hidden. If you want to bring all the default entries back, it is possible to use the entriesVisible property.

[
  {
    "name": "Template 1",
    "id": "sometemplate",
    "entriesVisible": true,
    "appliesTo": [
      "bpmn:ServiceTask"
    ],
    "properties": [
      ...
    ]
  }
]

Display default entries

Defining conditional properties​

note

Conditional properties are currently supported in Camunda Platform 8 element templates only.

Properties may have a condition which determines when they should be active, depending on the value of another property. When property is active, it is displayed in the properties panel, and its value is serialized in the XML. If a property is not active, it is not displayed, and its value is removed from the XML.

For a property value to be used in a condition, the property needs to have an id that can be referenced by the conditional property.

A property can depend on one or more conditions. If there are multiple conditions, they can be defined using allMatch. All of the conditions must be met for the property to be active.

There are two possible comparison operators:

  • equals: Checks if the value is equal to the value defined in the condition.
  • oneOf: Checks if the value is in the list of values defined in the condition.
...
  "properties": [
    {
      "id": "httpMethod",
      "label": "HTTP Method",
      "type": "Dropdown",
      "choices": [
        { "name": "get", "value": "GET" },
        { "name": "patch", "value": "PATCH" },
        { "name": "post", "value": "POST" },
        { "name": "delete", "value": "DELETE" }
      ],
      "binding": { ... },
    },
    {
      "label": "Request Body",
      "type": "String",
      "binding": { ... },
      "condition": {
        "property": "httpMethod",
        "oneOf": ["patch", "post", "delete"]
      }
    },
    {
      "id": "authenticationType",
      "label": "Authentication Type",
      "type": "Dropdown",
      "choices": [
        {
          "name": "None",
          "value": ""
        },
        {
          "name": "Basic",
          "value": "basic"
        }
      ],
      "binding": { ... }
    },
    {
      "label": "Username",
      "type": "String",
      "binding": { ... },
      "condition": {
       "allMatch": [
          {
            "property": "httpMethod",
            "oneOf": ["patch", "post", "delete"]
          },
          {
            "property": "authenticationType",
            "equals": "basic"
          }
        ]
      }
    },
    {
      "label": "Password",
      "type": "String",
      "binding": { ... },
      "condition": {
        "allMatch": [
          {
            "property": "httpMethod",
            "oneOf": ["patch", "post", "delete"]
          },
          {
            "property": "authenticationType",
            "equals": "basic"
          }
        ]
      }
    },
  ]