Template Management

Enterprise Feature

Template management is only available in the enterprise edition with cibseven.webclient.modeler.enabled: true, from 3.0.0. See Enable / Disable. In the community edition, templates come from files or the REST API, see Element Templates.

Manage templates on the modeler start page opens the list of all element templates stored in the modeler database. Back to overview returns to the start page.

Element templates are shared: they are not filed in folders or projects, and every modeler user sees the same ones. Everyone who can open the modeler can manage them.

The List

The table shows every template, visible or hidden:

Column Content
Name The name of the template, with its icon when it has one
Template ID The id of the template, which diagrams refer to
Created by / Updated by The user who added or last changed it. System stands for no user, for example a template loaded from files
Visibility Whether the template is offered in the modeler, see Hiding and Showing
Actions Edit and Export

The search field above the list matches the name, the template ID, the description and the users who created or updated a template. Beside it, the number of templates found is shown against the total. The visibility filter shows all templates, only the visible or only the hidden ones.

The button at the right end switches between the table view and the categorized view. The categorized view groups the templates by the element type they apply to (appliesTo), and within that by the part of their name before the first -: the templates Email - Send and Email - Receive form the group Email. Templates without such a prefix are listed under Others. A template whose content lacks fields the grouping needs is listed under Not categorized and marked Missing required fields.

Adding Templates

Add template opens a dialog with three ways to add templates:

Mode What it takes
File Import One or more .json or .txt files, each holding one template
Batch Import One file holding an array of templates
Manual Entry The fields of one template, typed in

A file may be up to 10 MB. Every template needs an id and a name, and appliesTo, when present, must be an array of BPMN element types. The dialog lists the selected files, and a file can be taken out again before saving. After saving, the list marks what was stored and what was rejected.

A template ID can be used once: a template whose ID is already stored is rejected, and the dialog names the rejected IDs while the others are stored. To replace a template, edit it instead.

In Manual Entry, and when editing, the dialog has these fields:

Field Content
Template ID Required. Letters, digits, -, _, . and : only
Name Required
Description Optional
Icon Optional. An SVG, PNG, JPEG, GIF or WebP image of up to 30 KB. It replaces an icon given in the content
Content (JSON) Required. The template itself in the element template format. Format JSON indents it
Active Whether the template is offered in the modeler

Editing

Edit opens the same fields for a template. Saving replaces the stored template, and the change applies to every modeler user.

Templates loaded from files

A template that comes from the files at cibseven.webclient.modeler.templates.paths is stored again from its file at every start of the webclient. Changes made here to such a template, hiding it too, last only until the next start. Change the file instead. See Auto-Loading Templates from Files.

Hiding and Showing

The eye in the Visibility column hides a template or shows it again. A hidden template stays stored but is not offered in the modeler; the REST API calls this inactive. In the categorized view, the button beside a group name hides or shows every template of the group at once.

A template excluded through excludeTemplates in config.json is marked Disabled in config.json and cannot be shown here. See Excluding Templates.

Exporting

Export in a row downloads that template as a JSON file named after its template ID and the date. Export all downloads one file, element-templates-<date>.json, with an array of the visible templates; hidden templates are left out. Both files can be added again with Add template, or put where templates.paths points.

Deleting

The list offers no way to delete a template; hide it instead. To remove templates from the database, use the REST API: DELETE /modeler/element-templates/{id} or POST /modeler/element-templates/bulk-delete.

On this Page: