Skip to content

Commit

Permalink
Document connector templates in desktop modeler (#4053)
Browse files Browse the repository at this point in the history 
* feat: document connector templates in desktop modeler

Related to camunda/camunda-modeler#4302

* chore: proposed rephrase

* feat: add dedicated section to flags docs

* fix: fix typo

* style(formatting): add period

* style(formatting): grammatical review

---------

Co-authored-by: Nico Rehwaldt <[email protected]>
Co-authored-by: christinaausley <[email protected]>
  • Loading branch information
@philippfromme @nikku @christinaausley
3 people authored Aug 12, 2024
1 parent 042f0d4 commit 2532753
Show file tree
Hide file tree
Showing 6 changed files with 67 additions and 19 deletions.
51 changes: 32 additions & 19 deletions docs/components/modeler/desktop-modeler/flags/flags.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,25 +30,26 @@ Flags passed as command line arguments take precedence over those configured via

## Available flags

| flag | default value |
| ---------------------------------------------------------- | ----------------------------------- |
| ["disable-plugins"](#disable-plug-ins) | false |
| "disable-adjust-origin" | false |
| "disable-cmmn" | true |
| "disable-dmn" | false |
| "disable-form" | false |
| ["disable-httl-hint"](#disable-history-time-to-live-hint) | false |
| ["default-httl"](#default-history-time-to-live) | false |
| "disable-platform" | false |
| "disable-zeebe" | false |
| "disable-remote-interaction" | false |
| "single-instance" | false |
| "user-data-dir" | [Electron default](../search-paths) |
| ["display-version"](#custom-display-version-label) | `undefined` |
| ["zeebe-ssl-certificate"](#zeebe-ssl-certificate) | `undefined` |
| ["c7-engine-version"](#default-execution-platform-version) | `undefined` |
| ["c8-engine-version"](#default-execution-platform-version) | `undefined` |
| ["enable-new-context-pad"](#enable-new-context-pad) | `false` |
| flag | default value |
| ----------------------------------------------------------- | ----------------------------------- |
| ["disable-plugins"](#disable-plug-ins) | false |
| "disable-adjust-origin" | false |
| "disable-cmmn" | true |
| "disable-dmn" | false |
| "disable-form" | false |
| ["disable-httl-hint"](#disable-history-time-to-live-hint) | false |
| ["default-httl"](#default-history-time-to-live) | false |
| "disable-platform" | false |
| "disable-zeebe" | false |
| "disable-remote-interaction" | false |
| "single-instance" | false |
| "user-data-dir" | [Electron default](../search-paths) |
| ["display-version"](#custom-display-version-label) | `undefined` |
| ["zeebe-ssl-certificate"](#zeebe-ssl-certificate) | `undefined` |
| ["c7-engine-version"](#default-execution-platform-version) | `undefined` |
| ["c8-engine-version"](#default-execution-platform-version) | `undefined` |
| ["enable-new-context-pad"](#enable-new-context-pad) | `false` |
| ["enable-connector-templates"](#enable-connector-templates) | `false` |

## Examples

Expand Down Expand Up @@ -151,3 +152,15 @@ To use the new context pad, configure your `flags.json` as follows:
```

![New context pad](./img/new-context-pad.png)

### Enable Connector templates

To enable the automatic fetching of Camunda 8 Connector templates, configure your `flags.json` as follows:

```json
{
"enable-connector-templates": true
}
```

[Learn more about using Connectors](../use-connectors.md).
Binary file added docs/components/modeler/desktop-modeler/img/use-connectors/apply.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/components/modeler/desktop-modeler/img/use-connectors/error.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/components/modeler/desktop-modeler/img/use-connectors/up-to-date.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions docs/components/modeler/desktop-modeler/use-connectors.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: use-connectors
title: Use Connectors
description: "Learn how to use Camunda 8 Connectors in Desktop Modeler."
---

<span class="badge badge--cloud">Camunda 8 only</span>

To use [Camunda 8 Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) in Desktop Modeler, enable [automatic fetching](#fetch-camunda-8-connector-templates-automatically) of the respective Connector templates. Alternatively, for greater control, you may [fetch and configure templates manually](#add-camunda-8-connector-templates-manually).

## Fetch Camunda 8 Connector templates automatically

You can enable automatic fetching of Connector templates for [Camunda 8 Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) through the [`enable-connector-templates` flag](./flags/flags.md#enable-connector-templates). Once set, it will fetch Camunda 8 Connector templates in the background and you'll be able to use them in your BPMN diagrams.

On startup, a notification indicates if the templates are up to date or have been updated:

![Camunda Connector templates up to date notification](./img/use-connectors/up-to-date.png)

In case of an error you'll see a nofication:

![Error updating Camunda Connector templates notification](./img/use-connectors/error.png)

Once fetched, you can use the templates in the Camunda 8 BPMN editor.

![Using Camunda Connector templates in the Camunda 8 BPMN editor](./img/use-connectors/apply.png)

## Add Camunda 8 Connector templates manually

For greater control, you can download individual Camunda 8 Connector templates manually through the [Camunda Marketplace website](https://marketplace.camunda.com/) and make them available in Desktop Modeler via the [standard element template search paths](./element-templates/configuring-templates.md).

## Additional resources

- [Learn about Camunda 8 Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md)
- [Desktop Modeler flags](./flags/flags.md)
1 change: 1 addition & 0 deletions sidebars.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ module.exports = {
"components/modeler/desktop-modeler/model-your-first-diagram",
"components/modeler/desktop-modeler/connect-to-camunda-8",
"components/modeler/desktop-modeler/start-instance",
"components/modeler/desktop-modeler/use-connectors",
{
type: "category",
label: "Element templates",
Expand Down

0 comments on commit 2532753

Please sign in to comment.