Skip to content

Commit 50e5b07

Browse files
committed
docs(hub): rewrite Generate an element template
1 parent 870e9a3 commit 50e5b07

1 file changed

Lines changed: 35 additions & 39 deletions

File tree

docs/components/hub/workspace/modeler/element-templates/element-template-generator.md

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: Generate an element template
44
description: Learn how to generate element or connector templates for easier creation of custom reusable elements.
55
---
66

7-
You can configure and automatically generate a custom element template in Web Modeler.
7+
Configure and generate a custom element template in Camunda Hub.
88

9-
## Use this page
9+
## About
1010

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

@@ -20,64 +20,60 @@ When creating custom-built element templates, consider the [recommended best pra
2020

2121
## Generate a BPMN element template
2222

23-
1. Select the Web Modeler project where you want to create the template. Camunda recommends storing element templates in root project folders, not projects, to simplify template management and avoid unnecessary versioning overhead.
24-
2. Click **Create new**, then select **Element template** to open the **Create new element template** screen.
25-
![Create the new element template](./img/element-template-generator/configure-element-template-details.png)
23+
Create a BPMN element template in Camunda Hub.
2624

27-
3. Select the template starting point:
28-
- **Call activity**: Start from a call activity template.
29-
- **Event**: Start from an event template.
30-
You can choose from predefined event templates, such as message event, timer event, signal event.
31-
- **Task**: Start from a task template.
32-
You can choose from predefined task templates, such as user task, service task, script task, and more.
33-
- **Blank**: Start from a blank template.
34-
A blank template includes only the basic properties shared by all BPMN elements and allows you to customize the template from scratch.
25+
1. Select the Camunda Hub project where you want to create the template.
26+
2. Click **Create new > Element template**. This opens the **Create new element template** screen.
27+
3. Select **BPMN element**.
28+
4. Choose a starting point for your template:
29+
- **Call activity**
30+
- **Event**. Also select an event type.
31+
- **Task**. Also select a task type.
32+
- **Blank**. A blank template includes only the basic properties shared by all BPMN elements. With this, you can customize the template from scratch.
3533

36-
Continue with [**configure the template details**](#configure-the-template-details) below.
34+
Next, [**configure the template details**](#configure-the-template-details).
3735

3836
## Generate a connector template
3937

40-
Use this section to create a connector template in Web Modeler.
38+
Create a connector template in Camunda Hub.
4139

42-
You can start from a blank template or import an existing API definition such as an [OpenAPI specification](https://swagger.io/resources/open-api/), [Swagger specification](https://swagger.io/resources/open-api/), or a [Postman collection](https://www.postman.com/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.
40+
You can start from a blank template or import an existing API definition such as an [OpenAPI specification](https://swagger.io/resources/open-api/), [Swagger specification](https://swagger.io/resources/open-api/), or [Postman collection](https://www.postman.com/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.
4341

44-
To generate a connector template:
45-
46-
1. Select the Web Modeler project where you want to create the template. Camunda recommends storing element templates in root project folders, not projects, to simplify template management and avoid unnecessary versioning overhead.
47-
2. Click **Create new**, select **Element template**, and then choose the **Connector** tab.
48-
![Create the new element template](../../../../connectors/custom-built-connectors/img/configure-connector-template-details.png)
49-
50-
3. Select the template starting point:
42+
1. Select the Camunda Hub project where you want to create the template.
43+
2. Click **Create new > Element template**. This opens the **Create new element template** screen.
44+
3. Select **Connector**.
45+
4. Choose a starting point for your template:
5146
- **From API definition**: Import an existing API definition file as a starting point. The **Import data source** section will appear below the template details.
5247
- **From blank**: Start from a blank template.
5348

54-
Continue with [**configure the template details**](#configure-the-template-details) below.
49+
Next, [**configure the template details**](#configure-the-template-details).
5550

5651
## Configure the template details
5752

58-
In the **Configure template details** section, provide the following information:
53+
Under **Configure template details**, provide the following information:
5954

6055
- **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.
6156
- **Description:** Describe the template’s main features and benefits.
6257
- **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.
6358

64-
:::note
65-
If you do not configure template details at this stage, a default name and BPMN symbol are assigned. You can edit them later.
66-
:::
59+
:::note
60+
If you do not configure template details at this stage, a default name and BPMN symbol are assigned. You can edit them later.
61+
:::
6762

6863
## Only for connector templates: Import an API definition
6964

70-
1. If you selected **From API definition**, the **Import data source** section appears.
71-
1. Select the format to import (OpenAPI or Postman) and click **Import file**.
72-
2. Import the API definition:
73-
- **Import file from URL:** Enter the API definition URL and click **Import icon**.
74-
- **Upload file:** Drag and drop a file into the upload area, or click the link to select a file.
65+
If you're generating a connector template, and you selected **From API definition**, you need to import the data source.
66+
67+
1. Under **Import data source**, select the format to import (OpenAPI or Postman).
68+
2. Import the API definition:
69+
- **Import from URL:** Enter the API definition URL, and click **Import file**.
70+
- **Upload file:** Drag and drop a file into the upload area, or click the link to select a file.
71+
3. After importing, select which actions to include from the generated list of supported methods.
7572

76-
3. After importing, select which actions to include from the generated list of supported methods.
77-
![List of imported methods](../../../../connectors/custom-built-connectors/img/Imported-methods.png)
73+
:::info
74+
For more information on working with and configuring connector templates, see [Connector templates](/components/connectors/custom-built-connectors/connector-templates.md).
75+
:::
7876

79-
:::info
80-
For more information on working with and configuring connector templates, see [Connector templates](/components/connectors/custom-built-connectors/connector-templates.md).
81-
:::
77+
## Create the template
8278

83-
2. Click **Create template** to generate the new template and open it in the [element template editor](/components/connectors/manage-connector-templates.md).
79+
Click **Create template** to generate the new template and open it in the element template editor.

0 commit comments

Comments
 (0)