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.

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

Split element templates docs into C7 and C8 #2369

Merged
merged 12 commits into from
Aug 14, 2023
Original file line number Diff line number Diff line change
Expand Up @@ -612,7 +612,7 @@ You can, for example, allow the user to model and configure the following **REST

## Develop Connector templates

You can develop Connector templates using the [`element template` feature](/components/modeler/desktop-modeler/element-templates/defining-templates.md). You can also look at existing [examples](https://github.com/camunda/camunda-modeler/blob/master/resources/element-templates/cloud-samples.json).
You can develop Connector templates using the [`element template` feature](/components/modeler/desktop-modeler/element-templates/defining-templates/index.md). You can also look at existing [examples](https://github.com/camunda/camunda-modeler/blob/master/resources/element-templates/cloud-samples.json).

## Providing and using Connector templates

Expand Down
2 changes: 1 addition & 1 deletion docs/components/connectors/manage-connector-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Take the following steps to create a new Connector template:
The components of the editor interface are as follows:

- In the **breadcrumbs bar** at the top of the screen, you can rename your template by clicking the chevron next to the template name. Note that you cannot change the name of your template in the template JSON, but only with this action.
- On the left, you see the **template JSON editor**. Here, you define the actual template descriptor. The descriptor follows the [most recent element template schema](https://github.com/camunda/element-templates-json-schema). The editor is divided into two sections: a read-only section, containing the schema reference, the template name, the template id, and an editable section, where you can [define your template descriptor](/components/modeler/desktop-modeler/element-templates/defining-templates.md).
- On the left, you see the **template JSON editor**. Here, you define the actual template descriptor. The descriptor follows the [most recent element template schema](https://github.com/camunda/element-templates-json-schema). The editor is divided into two sections: a read-only section, containing the schema reference, the template name, the template id, and an editable section, where you can [define your template descriptor](/components/modeler/desktop-modeler/element-templates/defining-templates/index.md).
- On the right, you see the live **Visual Preview**. The live preview shows how the properties panel will look when you apply the template to an element. It automatically updates on every valid change, and reflects the latest valid state of the template. The preview allows you to interactively check your template before publishing, enhancing its usability.
- In the upper left, you can **Upload an icon** for your template. You can upload any image file you want, however we recommend to use squared SVG graphics. The icons get rendered 18x18 pixels in the element on the modeling canvas, and 32x32 pixels in the properties panel.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Applicable element templates can be assigned to a BPMN element via the propertie

Applying an element template configures the diagram element with pre-defined values for BPMN properties, input/output mappings, and extension properties.

As seen in the _Mail Task_ example above, it also provides custom editing UI, input validation, and assistance.
As seen in the _REST Connector_ example above, it also provides custom editing UI, input validation, and assistance.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ id: additional-resources
title: Additional resources
---

Try playing around with custom elements and our example templates for [Camunda Platform 7](https://github.com/camunda/camunda-modeler/tree/master/resources/element-templates/samples.json) or [Camunda Platform 8](https://github.com/camunda/camunda-modeler/tree/master/resources/element-templates/cloud-samples.json).
Try playing around with custom elements and [our example templates](https://github.com/camunda/camunda-modeler/tree/master/resources/element-templates/cloud-samples.json).

If you get stuck, ask for help [in our forums](https://forum.camunda.org/c/modeler).
If you get stuck, ask for help in our [forums](https://forum.camunda.org/c/modeler).
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: Configuring templates
description: "Learn about global and local templates, which are loaded by the modeler at application startup."
---

Templates will be loaded by the modeler at application startup. Reloading it using `CtrlOrCmd+R` will also reload all templates. Templates will be treated as global or local depending on their location in your file system.
Templates are loaded by Desktop Modeler at application startup. Reloading it using `CtrlOrCmd+R` reloads also all templates. Templates are treated as global or local depending on their location in your file system.

### Global templates
## Global templates

For templates to be available for all diagrams store them in the `resources/element-templates` directory containing the Camunda Modeler executable. Alternatively, for element templates to be available across Camunda Modeler installations, you can store them in the `resources/element-templates` directory in the modeler's [data directory](../../search-paths#user-data-directory).

#### Example (Windows)
### Example (Windows)

```
└── camunda-modeler-5.10.0-win-x64
Expand All @@ -20,11 +20,11 @@ For templates to be available for all diagrams store them in the `resources/elem
└── my-element-templates.json
```

### Local templates
## Local templates

For element templates to only be available for specific diagrams, you can store them in a `.camunda/element-templates` directory in the diagrams parent directory or any of their parent directories.

#### Example
### Example

```
├── diagram.bpmn
Expand Down
Loading
Loading