Skip to content

Commit

Permalink
feat(desktop-modeler): update connector template documentation (#4187)
Browse files Browse the repository at this point in the history
  • Loading branch information
nikku authored Aug 28, 2024
1 parent 9051b5e commit dcff172
Show file tree
Hide file tree
Showing 9 changed files with 120 additions and 56 deletions.
50 changes: 25 additions & 25 deletions docs/components/modeler/desktop-modeler/flags/flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +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` |
| ["enable-connector-templates"](#enable-connector-templates) | `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` |
| ["disable-connector-templates"](#disable-connector-templates) | `false` |

## Examples

Expand Down Expand Up @@ -153,14 +153,14 @@ To use the new context pad, configure your `flags.json` as follows:

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

### Enable Connector templates
### Disable Connector templates

To enable the automatic fetching of Camunda 8 Connector templates, configure your `flags.json` as follows:
<span class="badge badge--cloud">Camunda 8 only</span>

To [disable automatic Connector template fetching](../use-connectors.md#automatic-connector-template-fetching), configure your `flags.json` as follows:

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

[Learn more about using Connectors](../use-connectors.md).
25 changes: 16 additions & 9 deletions docs/components/modeler/desktop-modeler/use-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,36 @@ 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).
Use [Camunda 8 Connectors](../../connectors/introduction.md) to access a growing range of external services or communication protocols.

## Fetch Camunda 8 Connector templates automatically
Desktop Modeler automatically fetches and updates [element templates](./element-templates/about-templates.md) for [pre-built Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) from the [Camunda Marketplace](https://marketplace.camunda.com/en-US/listing?pl=3038&attr=20486&cat=107792&locale=en-US). This happens automatically, in the background, unless explicitly [disabled](#disable-automatic-connector-template-fetching). Connector templates can also be provided [manually](#add-connector-templates-manually), offering you full control over the building blocks provided by the modeler.

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.
## Automatic Connector template fetching

On startup, a notification indicates if the templates are up to date or have been updated:
Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors.

After an update check has concluded, 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:
In case of an error you'll see a notification:

![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
## Disable automatic Connector template fetching

Disable automatic fetching of Connector templates using the `#disable-connector-templates` [feature flag](./flags/flags.md#disable-connector-templates).

## Add 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).
For full control over the building blocks offered by Desktop Modeler, download element templates for individual Camunda 8 Connectors manually (for example, through the [Camunda Marketplace](https://marketplace.camunda.com/)). Make them available to Desktop Modeler via the 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)
- [About Camunda 8 Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md)
- [About Element Templates](./element-templates/about-templates.md)
- [Desktop Modeler flags](./flags/flags.md#disable-connector-templates)
8 changes: 5 additions & 3 deletions docs/reference/release-notes/860.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@ keywords:

<!-- https://github.com/camunda/product-hub/issues/2253 -->

You can now enable automatic fetching of Camunda 8 Connector templates in Desktop Modeler, so you can always use the latest templates in your BPMN diagrams. This feature enhances workflow efficiency and reduces setup time.
Modeler now offers templates in BPMN diagrams for pre-built Camunda 8 Connectors. This ensures you can easily connect to a growing list of services and protocols, out of the box.

- To enable automatic fetching, set the `enable-connector-templates` flag to `true`.
- To learn more about this feature, see [use Connectors](/components/modeler/desktop-modeler/use-connectors.md). <!-- Via https://github.com/camunda/camunda-docs/pull/4053 -->
- To learn more about this feature, see [use Connectors](/components/modeler/desktop-modeler/use-connectors.md).
- To disable this feature, configure the [`disable-connector-templates` flag](/components/modeler/desktop-modeler/flags/flags.md#disable-connector-templates).

<!-- Via https://github.com/camunda/camunda-docs/pull/4187 -->

### Get started with human task orchestration

Expand Down
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` |
| ["disable-connector-templates"](#disable-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)

### Disable Connector templates

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

To [disable automatic Connector template fetching](../use-connectors.md#automatic-connector-template-fetching), configure your `flags.json` as follows:

```json
{
"disable-connector-templates": true
}
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
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>

Use [Camunda 8 Connectors](../../connectors/introduction.md) to access a growing range of external services or communication protocols.

Desktop Modeler automatically fetches and updates [element templates](./element-templates/about-templates.md) for [pre-built Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) from the [Camunda Marketplace](https://marketplace.camunda.com/en-US/listing?pl=3038&attr=20486&cat=107792&locale=en-US). This happens automatically, in the background, unless explicitly [disabled](#disable-automatic-connector-template-fetching). Connector templates can also be provided [manually](#add-connector-templates-manually), offering you full control over the building blocks provided by the modeler.

## Automatic Connector template fetching

Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors.

After an update check has concluded, 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 notification:

![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)

## Disable automatic Connector template fetching

Disable automatic fetching of Connector templates using the `#disable-connector-templates` [feature flag](./flags/flags.md#disable-connector-templates).

## Add Connector templates manually

For full control over the building blocks offered by Desktop Modeler, download element templates for individual Camunda 8 Connectors manually (for example, through the [Camunda Marketplace](https://marketplace.camunda.com/)). Make them available to Desktop Modeler via the element template [search paths](./element-templates/configuring-templates.md).

## Additional resources

- [About Camunda 8 Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md)
- [About Element Templates](./element-templates/about-templates.md)
- [Desktop Modeler flags](./flags/flags.md#disable-connector-templates)
1 change: 1 addition & 0 deletions versioned_sidebars/version-8.5-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@
"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 dcff172

Please sign in to comment.