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

Connectors wave 1 #4794

Draft
wants to merge 38 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
4a2247e
Initial restructure edits
mesellings Oct 13, 2024
63eedec
Draft edits
mesellings Oct 14, 2024
73467c1
Connectors A-Z and landing page
mesellings Oct 15, 2024
88a3976
Add link and icon
mesellings Oct 15, 2024
65fd7ec
Introduction edits
mesellings Oct 15, 2024
c7ef1d1
Content edits
mesellings Oct 16, 2024
ac99d0c
Add diagram
mesellings Oct 16, 2024
a00bbb7
Card CSS shadow
mesellings Oct 16, 2024
c3c9417
Start page edits
mesellings Oct 18, 2024
9fb2396
Add cover image
mesellings Oct 28, 2024
b1710b5
General edits, sidebar naming
mesellings Oct 28, 2024
3197287
Add Example Connector
mesellings Oct 29, 2024
d08a639
Image borders
mesellings Oct 29, 2024
0033453
Badges and BPMN
mesellings Oct 29, 2024
bb7ee79
Style tweaks
mesellings Oct 30, 2024
52bece1
Page tweaks
mesellings Oct 30, 2024
f26be4d
Review feedback changes
mesellings Oct 31, 2024
d4473ca
Menu and title changes
mesellings Nov 1, 2024
660e4eb
Remove Protocol
mesellings Nov 1, 2024
4d6abbc
Edit link to remove file path
mesellings Nov 5, 2024
1739422
Edit
mesellings Dec 19, 2024
b125e87
Merge branch 'main' into mes-356-connectors-restructure
mesellings Dec 19, 2024
8744d11
Remove state connector SDK update guides
mesellings Dec 19, 2024
801e64c
Home page edits
mesellings Dec 19, 2024
6b3615e
Home page edits
mesellings Dec 19, 2024
646a1ff
Connector icons
mesellings Dec 19, 2024
4647777
Connector icons
mesellings Dec 19, 2024
d77c9b9
Add icons
mesellings Dec 19, 2024
a07aa68
Add icons
mesellings Dec 20, 2024
f56dcc4
Change table to card components
mesellings Dec 20, 2024
369edaf
Convert banner to react component
mesellings Dec 20, 2024
1822841
Remove connector word from sidebar labels
mesellings Dec 20, 2024
44c6b92
Add popular and new tabs
mesellings Dec 20, 2024
f0878ec
Links and image
mesellings Dec 20, 2024
0c68ffb
Change dropdown to badges and fix links
mesellings Dec 20, 2024
1072ba4
Badge padding
mesellings Dec 20, 2024
5948653
Badge color
mesellings Dec 20, 2024
67fc0da
Minor text and grammar edits
mesellings Jan 6, 2025
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
6 changes: 1 addition & 5 deletions docs/components/connectors/connector-types.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
id: connector-types
title: Types of Connectors
title: Connector types
description: "Connectors come in type and subtypes that describe their functionality."
---

Connectors are categorized by the direction data flows into or out of Camunda 8.

:::note
Looking for pre-built, [Out-of-the-box Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md)?
:::

## Outbound Connectors

Outbound Connectors allow workflows to trigger external systems or services, making it possible to integrate workflows with other parts of a business process or system architecture.
Expand Down
17 changes: 17 additions & 0 deletions docs/components/connectors/connectors-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: connectors-start
title: Get started with Connectors
description: "Connectors come in type and subtypes that describe their functionality."
---

Learn more about Connectors and how to start integrating them into your processes today.

## Connector types

Connectors are categorized by the direction data flows into or out of Camunda 8.

## How to use Connectors

When using Modeler, you can add and use any of the available [prebuilt Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md), as well as Connectors provided by Camunda partners and community contributors in the the [Camunda Marketplace](/components/modeler/web-modeler/camunda-marketplace.md).

All Connectors are available for Camunda 8 SaaS and [Self-Managed](/self-managed/connectors-deployment/install-and-start.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: build-connector
title: Custom Connectors
description: Manage your Connector templates in Web Modeler.
---

import ConnectorArchitectureImg from "./img/diagram-connectors.png";

You can build your own custom Connectors.

## About custom Connectors

## Connector templates

### Build a Connector template

### Generate a Connector template

### Manage Connector templates

## Connector SDK

### Build a connector using the SDK

## Architecture

A Connector consists of two elements - the actual Java code, and the Modeler user interface.

<img src={ConnectorArchitectureImg}/>

- The Java code defines the Connector functionality and how it connects to an external system. For example, the [Connector function](/components/connectors/custom-built-connectors/connector-sdk.md#outbound-connector-runtime-logic) for outbound Connectors.

- You use the user interface to interact with the Connector in Modeler. This is defined in a [Connector template](../manage-connector-templates.md) that controls how the BPMN element is shown in Modeler and what configuration options are available for the Connector.

For example:

:::note

- If you are only using prebuilt Connectors in Modeler, you only need to understand how to configure and use a Connector in the Modeler interface, via the Properties panel.
- Connector templates are a specific type of [element template](/components/modeler/desktop-modeler/element-templates/about-templates.md), that can also be used when creating custom Connectors using the [Connector SDK](connector-sdk.md).

:::

- [Install Connectors in Self-Managed](/self-managed/connectors-deployment/install-and-start.md)
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.
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.
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.
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/connectors/img/icon-play.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
105 changes: 82 additions & 23 deletions docs/components/connectors/introduction.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,100 @@
---
id: introduction-to-connectors
title: Introduction
title: Connectors
description: "A Connector is a reusable building block that performs the integration with an external system and works out of the box."
keywords: [bridge, reusable component, low code]
---

A **Connector** is a reusable building block that performs the integration with an external system.
import "./out-of-the-box-connectors/connectors-table.css";
import IconPlayImg from './img/icon-play.png';
import IconConnectorImg from './img/icon-connectors.png';
import IconConnectorTypesImg from './img/icon-connector-types.png';
import AmazonEventbridgeImg from "./img/connector-amazon-eventbridge.png";
import IconConnectorSdkImg from './img/icon-connector-sdk.png';
import IconConnectorTemplateImg from './img/icon-connector-template.png';
import IconConnectorCustomImg from './img/icon-connector-custom.png';
import OverviewImg from './img/connector-overview.png';

Most processes require interaction with systems outside of Camunda to orchestrate and complete work.
<p><img src={OverviewImg} alt="Get started" style={{border:0,padding:0,paddingLeft:20,margin:0,float: 'right', width: '40%'}}/>Camunda 8 Connectors are reusable building blocks you can use to easily connect processes to external systems, applications, and data.</p>

- In **human task orchestration**, actors are notified of pending or completed processes through communication tools such as [Slack](/components/connectors/out-of-the-box-connectors/slack.md) or [Microsoft Teams](/components/connectors/out-of-the-box-connectors/microsoft-teams.md) for example in onboarding flow.
- In **business processes**, records are created or updated in enterprise business systems.
- In **microservices orchestration**, processes communicate through events pushed to a common systems through infrastructure such as [Kafka](/components/connectors/out-of-the-box-connectors/kafka.md).
For example:

Connectors are often represented as tasks in a [BPMN process](/components/concepts/processes.md), which can be configured with parameters specific for the external system. As such, it can remove the need to write custom programming code for integration.
- Use a [Slack](/components/connectors/out-of-the-box-connectors/slack.md) or [Microsoft Teams](/components/connectors/out-of-the-box-connectors/microsoft-teams.md) Connector to notify people of pending or completed processes in a human task orchestration onboarding flow.
- In microservices orchestration, use a [Kafka](/components/connectors/out-of-the-box-connectors/kafka.md) Connector to add real-time messaging to your automated processes.

Connectors offer a multilayer coding experience, enabling users with a variety of technical abilities to be successful when integrating with external systems.
Connectors are often configured as a [BPMN process](/components/concepts/processes.md) task, with the required integration parameters already set up for easy configuration. This helps remove the need for you to write custom integration programming code.

![Multilayer Coding Experience](img/multilayer-coding-experience.png)
## Get started with Connectors

A Connector consists of two parts:
Learn how to start using Connectors in your processes and about the different types of Connector available.

1. The programming code in Java to connect to the external system (for example, refer to the [Connector function](/components/connectors/custom-built-connectors/connector-sdk.md#outbound-connector-runtime-logic) for outbound Connectors.)
2. The user interface to be used during modeling, which is provided using [Connector Templates](manage-connector-templates.md).
<div class="connector-grid">
<a href="../connectors-start" class="connector-card" title="Get started with Connectors">
<img src={IconPlayImg} alt="Get started"/>
<h3>Get started with Connectors</h3>
<p>Learn how to start using Connectors in your processes.</p>
</a>
<a href="../connector-types" class="connector-card" title="Connector types">
<img src={IconConnectorTypesImg} alt="Connector types"/>
<h3>Connector types</h3>
<p>Different types of Connector include <a href="../use-connectors/inbound" title="Inbound Connectors">Inbound</a>, <a href="../use-connectors/outbound" title="Outbound Connectors">Outbound</a>, and Protocol.</p>
</a>
<a href="../use-connectors" class="connector-card" title="How to use Connectors">
<img src={IconConnectorImg} alt="How to use Connectors"/>
<h3>How to use Connectors</h3>
<p>How to create a Connector Task and use secrets.</p>
</a>
</div>

Users interacting with Connectors may only need to understand the configuration options exposed by the Connector Template in the properties panel.
## Camunda Connectors

Connectors are available [out-of-the-box (OOTB)](./out-of-the-box-connectors/available-connectors-overview.md) and come with [Connector Templates](manage-connector-templates.md) which customize how a BPMN element is shown,
and how it can be configured by process developers. Connector templates are a specific kind of [element templates](/components/modeler/desktop-modeler/element-templates/about-templates.md), which can also be used when creating custom Connectors via the [Connector SDK](./custom-built-connectors/connector-sdk.md).
Ready to start using Connectors in your processes? Explore our library of prebuilt Camunda 8 Connectors.

Additionally, the [Camunda Marketplace](/components/modeler/web-modeler/camunda-marketplace.md) provides Connectors by Camunda partners and community contributors.
**[Explore Connectors A-Z >](/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md)**

## Next steps
<!-- #### Popular Connectors

- [Learn about types of Connectors](./connector-types.md)
- [Use Connectors in your BPMN process](./use-connectors/index.md)
- [Learn about available out-of-the-box Connectors](./out-of-the-box-connectors/available-connectors-overview.md)
- [Configure Connector Templates](manage-connector-templates.md)
- [Visit the Camunda Marketplace](/components/modeler/web-modeler/camunda-marketplace.md)
- [Install Connectors in Self-Managed](/self-managed/connectors-deployment/install-and-start.md)
<div class="connector-small-grid">
<a href="path/to/connector1" class="connector-small-link">
<div class="connector-small">
<img src={AmazonEventbridgeImg} alt="Get started"/>Amazon Eventbridge
</div>
</a>
<a href="path/to/connector2" class="connector-small-link">
<div class="connector-small">
<img src={AmazonEventbridgeImg} alt="Get started"/>Amazon Eventbridge
</div>
</a>
<a href="path/to/connector3" class="connector-small-link">
<div class="connector-small">
<img src={AmazonEventbridgeImg} alt="Get started"/>Amazon Eventbridge
</div>
</a>
<a href="path/to/connector4" class="connector-small-link">
<div class="connector-small">
<img src={AmazonEventbridgeImg} alt="Get started"/>Amazon Eventbridge
</div>
</a>
</div> -->

## Custom Connectors

Build and deploy your own Connectors using Connector templates or the Connector SDK.

<div class="connector-grid">
<a href="../custom-built-connectors/build-connector" class="connector-card" title="Custom Connectors">
<img src={IconConnectorCustomImg} alt="Custom Connectors icon" class="connector-card-image"/>
<h3>Custom Connectors</h3>
<p>Learn how to build and deploy your own custom Connectors.</p>
</a>
<a href="../custom-built-connectors/connector-templates" class="connector-card" title="Connector templates">
<img src={IconConnectorTemplateImg} alt="Connector templates icon" class="connector-card-image"/>
<h3>Connector templates</h3>
<p>Create and work with connector templates.</p>
</a>
<a href="../custom-built-connectors/connector-sdk" class="connector-card" title="Connector SDK">
<img src={IconConnectorSdkImg} alt="Connector SDK icon" class="connector-card-image"/>
<h3>Connector SDK</h3>
<p> Use the Connector SDK to develop custom Connectors in Java.</p>
</a>
</div>
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: amazon-bedrock
sidebar_label: AWS Bedrock Connector
sidebar_label: Amazon Bedrock
title: Amazon Bedrock Connector
description: Interact with the Amazon Bedrock Connector from your BPMN process.
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: asana
title: Asana Connector
sidebar_label: Asana Connector
sidebar_label: Asana
description: Manage Asana projects and tasks from your BPMN process. Learn how to create an Asana Connector task, and get started.
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: automation-anywhere
title: Automation Anywhere Connector
description: Orchestrate your Automation Anywhere queue items from your BPMN process.
sidebar_label: Automation Anywhere
---

The **Automation Anywhere Connector** allows you to orchestrate an Automation Anywhere queue from your BPMN process with [Automation Anywhere RPA](https://www.automationanywhere.com/) to add work items to the queue and obtain work item results.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,30 +1,21 @@
---
id: available-connectors-overview
title: Overview
title: Camunda Connectors
description: Take a closer look at the Connectors available in Camunda 8.
---

Out-of-the-box (OOTB) Connectors accelerate solution implementation by providing pre-built, ready-to-use Connectors to popular external systems. Learn more about [Connector types](/components/connectors/connector-types.md)
import SearchableTable from './connectors-table.js';

Each Connector has a dedicated page with relevant configuration.
Explore our library of prebuilt Camunda Connectors for SaaS and [Self-Managed](/self-managed/connectors-deployment/install-and-start.md).

All Connectors are available for Camunda 8 SaaS and [Self-Managed](/self-managed/connectors-deployment/install-and-start.md).
<SearchableTable />

:::tip
Don't see the Connector you need? Build your own [custom Connector](/components/connectors/custom-built-connectors/build-connector.md), or explore the [Camunda MarketPlace](https://marketplace.camunda.com/) for more Connectors developed by Camunda, Partners, and the Community.
:::
=======
Beginners to Connectors may want to get familiar with Connectors using a [guide to configuring out-of-the-box Connectors](/guides/configuring-out-of-the-box-connector.md).

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs groupId="ootb" defaultValue="outbound" queryString values={
[
{label: 'Outbound', value: 'outbound', },
{label: 'Inbound', value: 'inbound', },
{label: 'Protocol', value: 'protocol', },
]
}>

<TabItem value='outbound'>

## Outbound Connectors

- [Amazon Bedrock Connector](/components/connectors/out-of-the-box-connectors/amazon-bedrock.md) - Interact with [Amazon Bedrock](https://aws.amazon.com/bedrock/) from your BPMN process to experiment with and evaluate foundation models (FMs) from leading AI companies.
Expand Down Expand Up @@ -62,10 +53,6 @@ import TabItem from "@theme/TabItem";
- [UiPath Connector](/components/connectors/out-of-the-box-connectors/uipath.md) - Orchestrate your [UiPath](https://cloud.uipath.com) Bots with Camunda.
- [WhatsApp Connector](/components/connectors/out-of-the-box-connectors/whatsapp.md) - Send messages with [WhatsApp Business](https://business.whatsapp.com/) from your BPMN process.

</TabItem>

<TabItem value='inbound'>

## Inbound Connectors

- [Amazon EventBridge Webhook Connector](/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md) - Start a BPMN process instance triggered by an [Amazon EventBridge service event](https://aws.amazon.com/eventbridge/).
Expand All @@ -77,10 +64,6 @@ import TabItem from "@theme/TabItem";
- [Slack inbound Connector](/components/connectors/out-of-the-box-connectors/slack.md) - Trigger a [Slack](https://slack.com) bot to start a BPMN process with an event or a slash command
- [Twilio Webhook Connector](/components/connectors/out-of-the-box-connectors/twilio.md) - Start a process instance triggered by a [Twilio webhook](https://www.twilio.com/docs/usage/webhooks). Can be used as an intermediate Connector in existing processes.

</TabItem>

<TabItem value='protocol'>

## Protocol Connectors

- [GraphQL Connector](/components/connectors/protocol/graphql.md) - Execute a [GraphQL](https://graphql.org/) query or mutation from your BPMN process.
Expand All @@ -89,10 +72,7 @@ import TabItem from "@theme/TabItem";
- [REST Connector](/components/connectors/protocol/rest.md) - Make a request to a REST API and use the response in the next steps of your process.
- [SOAP Connector](/components/connectors/protocol/soap.md) - Connect your BPMN process with Simple Object Access Protocol ([SOAP](https://en.wikipedia.org/wiki/SOAP)) services and interact with SOAP service endpoints.

</TabItem>

</Tabs>

In addition to this section on Connectors, we recommend reviewing [Connector secrets](/components/console/manage-clusters/manage-secrets.md).

If you want to build **custom Connectors**, head over to our [Connector SDK guide](/components/connectors/custom-built-connectors/connector-sdk.md).

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: blueprism
title: Blue Prism Connector
description: Orchestrate your Blue Prism queue items from your BPMN process.
sidebar_label: Blue Prism
---

The **Blue Prism Connector** allows you to orchestrate a Blue Prism queue from your BPMN process with [Blue Prism RPA](https://www.blueprism.com/).
Expand Down
Loading
Loading