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

Update Desktop Modeler connector template documentation #4187

Merged
merged 20 commits into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs/components/modeler/desktop-modeler/use-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,17 @@ description: "Learn how to use Camunda 8 Connectors in Desktop Modeler."

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

The Desktop Modeler fetches element templates for [pre-built Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) [automatically](#automatic-connector-template-fetching) and makes them available for use in your Camunda 8 BPMN processes.
You can [disable this feature](#disable-automatic-connector-template-fetching) and [provide Connector templates manually](#add-connector-templates-manually) for full control over the building blocks the modeler should offer.
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

The modeler fetches and updates element templates for [pre-built Camunda connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) periodically [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 you [explicitly disable it](#disable-automatic-connector-template-fetching).
Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors.

After an update check concluded, a notification indicates if the templates are up to date or have been updated:
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)

Expand All @@ -29,11 +28,11 @@ Once fetched, you can use the templates in the Camunda 8 BPMN editor.

## Disable automatic Connector template fetching

Disable automatic fetching of Connector templates through the [respective flag](./flags/flags.md#disable-connector-templates).
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 building blocks offered by the Desktop Modeler, download element templates for individual Camunda 8 Connectors manually, i.e. through the [Camunda Marketplace](https://marketplace.camunda.com/). Make them available to the 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](/components/modeler/web-modeler/camunda-marketplace.md)). Make them available to Desktop Modeler via the element template [search paths](./element-templates/configuring-templates.md).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@conceptualshark I believe we should revert this change of the link.

From the Desktop Modeler the market place is not available as shown in the linked URL, nor is any of the "integrated UI".


## Additional resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,17 @@ description: "Learn how to use Camunda 8 Connectors in Desktop Modeler."

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

The Desktop Modeler fetches element templates for [pre-built Connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) [automatically](#automatic-connector-template-fetching) and makes them available for use in your Camunda 8 BPMN processes.
You can [disable this feature](#disable-automatic-connector-template-fetching) and [provide Connector templates manually](#add-connector-templates-manually) for full control over the building blocks the modeler should offer.
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

The modeler fetches and updates element templates for [pre-built Camunda connectors](../../connectors/out-of-the-box-connectors/available-connectors-overview.md) periodically [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 you [explicitly disable it](#disable-automatic-connector-template-fetching).
Automatic Connector template fetching is enabled by default, and notifies you of any updates or errors.

After an update check concluded, a notification indicates if the templates are up to date or have been updated:
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)

Expand All @@ -29,11 +28,11 @@ Once fetched, you can use the templates in the Camunda 8 BPMN editor.

## Disable automatic Connector template fetching

Disable automatic fetching of Connector templates through the [respective flag](./flags/flags.md#disable-connector-templates).
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 building blocks offered by the Desktop Modeler, download element templates for individual Camunda 8 Connectors manually, i.e. through the [Camunda Marketplace](https://marketplace.camunda.com/). Make them available to the 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](/components/modeler/web-modeler/camunda-marketplace.md)). Make them available to Desktop Modeler via the element template [search paths](./element-templates/configuring-templates.md).

## Additional resources

Expand Down
Loading