For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.9

Generate an element template

You can configure and automatically generate a custom element template in Web Modeler.

Use this page​

Use this page for both BPMN element templates and connector templates:

Best practices​

When creating custom-built element templates, consider the recommended best practices to ensure they are effective, user-friendly, and maintainable.

Generate a BPMN element template​

  1. Select the Web Modeler project where you want to create the template.

  2. Create a process application to hold your template. Storing files in a process application is required for SaaS. In preparation for 8.10, it's also recommended for Self-Managed.

  3. Click Create new, then select Element template to open the Create new element template screen.
    Create the new element template

  4. Select the template starting point:

    • Call activity: Start from a call activity template.
    • Event: Start from an event template.
      You can choose from predefined event templates, such as message event, timer event, signal event.
    • Task: Start from a task template.
      You can choose from predefined task templates, such as user task, service task, script task, and more.
    • Blank: Start from a blank template. A blank template includes only the basic properties shared by all BPMN elements and allows you to customize the template from scratch.

Continue with configure the template details below.

Generate a connector template​

Use this section to create a connector template in Web Modeler.

You can start from a blank template or import an existing API definition such as an OpenAPI specification, Swagger specification, or a Postman collection. For example, download a Postman collection as a YAML file, import it into the generator, and choose which methods to include in the generated template.

To generate a connector template:

  1. Select the Web Modeler project where you want to create the template.

  2. Create a process application to hold your template. Storing files in a process application is required for SaaS. In preparation for 8.10, it's also recommended for Self-Managed.

  3. Click Create new, select Element template, and then choose the Connector tab.
    Create the new element template

  4. Select the template starting point:

    • From API definition: Import an existing API definition file as a starting point. The Import data source section will appear below the template details.
    • From blank: Start from a blank template.

Continue with configure the template details below.

Configure the template details​

In the Configure template details section, provide the following information:

  • Name: Enter a clear and descriptive name for the template. For example, include the brand name if the template connects to a service, or indicate its main feature.

  • Description: Describe the template’s main features and benefits.

  • Icon: Use a default BPMN symbol or upload a custom icon. Supported formats: SVG, PNG, JPEG. Maximum file size: 8 KB. Minimum dimensions: 512 × 512 pixels. To add an icon, enter the image URL and click Import icon, or drag and drop a file into the upload area.

    note

    If you do not configure template details at this stage, a default name and BPMN symbol are assigned. You can edit them later.

Only for connector templates: Import an API definition​

  1. If you selected From API definition, the Import data source section appears.

    1. Select the format to import (OpenAPI or Postman) and click Import file.

    2. Import the API definition:

      • Import file from URL: Enter the API definition URL and click Import icon.
      • Upload file: Drag and drop a file into the upload area, or click the link to select a file.

    3. After importing, select which actions to include from the generated list of supported methods.
      List of imported methods

    info

    For more information on working with and configuring connector templates, see Connector templates.

  2. Click Create template to generate the new template and open it in the element template editor.