You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The launch of [Camunda 8](../components/concepts/what-is-camunda-8.md) also introduced an integration framework with a key goal: integrate faster to reduce the time it takes to automate and orchestrate business processes across systems.
12
12
13
13
:::note
14
-
New to Connectors? Review our [introduction to Connectors](/components/connectors/introduction.md) to get familiar with their capabilities.
14
+
New to connectors? Review our [introduction to connectors](/components/connectors/introduction.md) to get familiar with their capabilities.
15
15
:::
16
16
17
-
[Connectors](../components/connectors/introduction.md) achieve this goal. Ready to use out of the box, Connectors help automate complex [business processes](../components/concepts/processes.md) by inserting them into [BPMN diagrams](./automating-a-process-using-bpmn.md) within [Web Modeler](../components/modeler/about-modeler.md), and configuring them via the properties panel on the right side of the screen.
17
+
[Connectors](../components/connectors/introduction.md) achieve this goal. Ready to use out of the box, connectors help automate complex [business processes](../components/concepts/processes.md) by inserting them into [BPMN diagrams](./automating-a-process-using-bpmn.md) within [Web Modeler](../components/modeler/about-modeler.md), and configuring them via the properties panel on the right side of the screen.
18
18
19
-
You can also orchestrate APIs, for example by working with a [REST Connector](/guides/getting-started-orchestrate-apis.md). Learn more about [types of Connectors](/components/connectors/connector-types.md).
19
+
You can also orchestrate APIs, for example by working with a [REST connector](/guides/getting-started-orchestrate-apis.md). Learn more about [types of connectors](/components/connectors/connector-types.md).
20
20
21
-
Connectors technically consist of two parts: the business logic is implemented as a [job worker](../components/concepts/job-workers.md), and the user interface during modeling is provided using an element template. In this guide, we'll walk step-by-step through the implementation of a sample Connector.
21
+
Connectors technically consist of two parts: the business logic is implemented as a [job worker](../components/concepts/job-workers.md), and the user interface during modeling is provided using an element template. In this guide, we'll walk step-by-step through the implementation of a sample connector.
22
22
23
23
## Set up
24
24
25
-
We'll implement our Connector with [Modeler](../components/modeler/about-modeler.md). To get started, ensure you’ve [created a Camunda 8 account](/guides/create-account.md).
25
+
We'll implement our connector with [Modeler](../components/modeler/about-modeler.md). To get started, ensure you’ve [created a Camunda 8 account](/guides/create-account.md).
26
26
27
-
You'll also need to [create a SendGrid account](https://signup.sendgrid.com/) if you don't have one already, as we'll use SendGrid in our example Connector. Once you've created your account, you will immediately be prompted to create a [sender](https://docs.sendgrid.com/ui/sending-email/senders).
27
+
You'll also need to [create a SendGrid account](https://signup.sendgrid.com/) if you don't have one already, as we'll use SendGrid in our example connector. Once you've created your account, you will immediately be prompted to create a [sender](https://docs.sendgrid.com/ui/sending-email/senders).
28
28
29
29
### Create a cluster
30
30
@@ -53,25 +53,25 @@ In this example, we've designed the following BPMN diagram:
53
53
To learn more about building your own BPMN diagram from scratch, visit our guide on [automating a process using BPMN](./automating-a-process-using-bpmn.md).
54
54
:::
55
55
56
-
## Add a Connector
56
+
## Add a connector
57
57
58
-
Here, a receipt is initially uploaded for review. The first task we need to complete is notifying the manager of the uploaded receipt. If we want to leverage our email service to notify the manager, we can utilize a productivity applications Connector to replace this task.
58
+
Here, a receipt is initially uploaded for review. The first task we need to complete is notifying the manager of the uploaded receipt. If we want to leverage our email service to notify the manager, we can utilize a productivity applications connector to replace this task.
59
59
60
60
:::note
61
-
Camunda offers a variety of available Connectors. For example, utilize cloud Connectors to communicate with cloud-native applications and conform to REST, GraphQL, or SOAP protocols. Or, employ service Connectors to integrate with technology enablers like RPA, AI or IOT services. Learn more about our [available Connectors](../components/connectors/out-of-the-box-connectors/available-connectors-overview.md) to find out which may best suit your business needs.
61
+
Camunda offers a variety of available connectors. For example, utilize cloud connectors to communicate with cloud-native applications and conform to REST, GraphQL, or SOAP protocols. Or, employ service connectors to integrate with technology enablers like RPA, AI or IOT services. Learn more about our [available connectors](../components/connectors/out-of-the-box-connectors/available-connectors-overview.md) to find out which may best suit your business needs.
62
62
:::
63
63
64
-
To add our productivity applications Connector, take the following steps:
64
+
To add our productivity applications connector, take the following steps:
65
65
66
66
1. Click the start event. A context pad to the right of the start event will appear.
67
-
2. Click the **Append Connector** item in the panel.
68
-
3. To send an email via SendGrid, for example, select the **SendGrid Email Connector** option. Name this newly-created task `Notify manger of receipt`. This now replaces our original task.
67
+
2. Click the **Append connector** item in the panel.
68
+
3. To send an email via SendGrid, for example, select the **SendGrid Email connector** option. Name this newly-created task `Notify manger of receipt`. This now replaces our original task.
69
69
70
70
4. You need to fill out the required information in the properties panel of this task on the right side of the screen. Here, we'll add an example API key obtained from our [SendGrid account](https://app.sendgrid.com/settings/api_keys), a sender and receiver name and email address, and the email message content.
71
71
72
72
73
73
74
-
Our Connector is now attached and ready to use. Your completed diagram should look like the following:
74
+
Our connector is now attached and ready to use. Your completed diagram should look like the following:
75
75
76
76
77
77
@@ -95,7 +95,7 @@ Variables are part of a process instance and represent the data of the instance.
95
95
96
96
## Observe your running process
97
97
98
-
After the [user task](./getting-started-orchestrate-human-tasks.md)**Upload receipt** is completed in [Tasklist](../components/tasklist/introduction-to-tasklist.md), an email is automatically sent to the address as specified in the Connectors properties panel we configured earlier.
98
+
After the [user task](./getting-started-orchestrate-human-tasks.md)**Upload receipt** is completed in [Tasklist](../components/tasklist/introduction-to-tasklist.md), an email is automatically sent to the address as specified in the connectors properties panel we configured earlier.
99
99
100
100
101
101
@@ -105,8 +105,8 @@ In [Operate](../components/operate/operate-introduction.md), you will now see th
105
105
106
106
## Additional resources and next steps
107
107
108
-
-[Use Connectors in your BPMN process](/components/connectors/use-connectors/index.md)
Copy file name to clipboardExpand all lines: versioned_docs/version-8.7/guides/document-handling.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
id: document-handling
3
3
title: "Store, track, and manage documents"
4
-
description: "Get started with document handling by uploading a document to a BPMN process, displaying and downloading a document in a user task, and sending a document to an external system via a Connector."
4
+
description: "Get started with document handling by uploading a document to a BPMN process, displaying and downloading a document in a user task, and sending a document to an external system via a connector."
5
5
keywords: ["document handling"]
6
6
---
7
7
@@ -13,11 +13,11 @@ In this guide we will cover three main use cases:
13
13
14
14
-[Upload a document to a BPMN process](#upload-a-document-to-a-bpmn-process);
15
15
-[Display and download a document](#display-and-download-a-document);
16
-
-[Send a document to an external system via a Connector](#send-a-document-to-an-external-system-via-a-connector).
16
+
-[Send a document to an external system via a connector](#send-a-document-to-an-external-system-via-a-connector).
17
17
18
18
## Upload a document to a BPMN process
19
19
20
-
You can implement document uploads in your BPMN processes using [forms](#build-a-form-for-document-upload), [inbound Connectors](#upload-a-document-via-inbound-webhook-connector), and [Camunda 8 REST API](../apis-tools/camunda-api-rest/specifications/create-document.api.mdx).
20
+
You can implement document uploads in your BPMN processes using [forms](#build-a-form-for-document-upload), [inbound connectors](#upload-a-document-via-inbound-webhook-connector), and [Camunda 8 REST API](../apis-tools/camunda-api-rest/specifications/create-document.api.mdx).
21
21
22
22
### Build a form for document upload
23
23
@@ -58,7 +58,7 @@ Single document uploads are accessible using `value[1]` (since [FEEL](../compone
58
58
59
59
### Upload a document via inbound webhook connector
60
60
61
-
Documents can be added to a process using the [inbound](../components//connectors/connector-types.md#inbound-connectors)[HTTP webhook Connector](/components/connectors/protocol/http-webhook.md).
61
+
Documents can be added to a process using the [inbound](../components//connectors/connector-types.md#inbound-connectors)[HTTP webhook connector](/components/connectors/protocol/http-webhook.md).
62
62
63
63
You can pass the documents in both the response expression and the result expression, where the `documents` object contains the references for created documents. Below, review an example of a webhook configuration:
64
64
@@ -72,7 +72,7 @@ In this example, the result expression may look as follows, where `applicationDo
72
72
}
73
73
```
74
74
75
-
The document reference received as an output of one Connector should be stored in process variables by using the result expression or result variable.
75
+
The document reference received as an output of one connector should be stored in process variables by using the result expression or result variable.
76
76
77
77
To call the webhook sending a file, for example:
78
78
@@ -145,17 +145,17 @@ When a user opens the task, they can view and download the document directly fro
145
145
146
146
147
147
148
-
## Send a document to an external system via a Connector
148
+
## Send a document to an external system via a connector
149
149
150
-
You can reference a document in an [outbound Connector](../components//connectors/connector-types.md#outbound-connectors). Connectors can use variables with document metadata as an input. The format of inputs will depend on the Connector, as each Connector has a different input structure.
150
+
You can reference a document in an [outbound connector](../components//connectors/connector-types.md#outbound-connectors). connectors can use variables with document metadata as an input. The format of inputs will depend on the connector, as each connector has a different input structure.
151
151
152
152
The [Connector SDK](/components/connectors/custom-built-connectors/connector-sdk.md) provides document support in property/variable bindings.
153
153
154
-
In most cases for the following outbound Connectors, you can include a **Request body** under **Payload** in the properties panel to send with your request:
154
+
In most cases for the following outbound connectors, you can include a **Request body** under **Payload** in the properties panel to send with your request:
Copy file name to clipboardExpand all lines: versioned_docs/version-8.7/guides/getting-started-orchestrate-apis.md
+13-13
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
id: orchestrate-apis
3
3
title: Get started with API orchestration
4
4
sidebar_label: APIs
5
-
description: "Use Connectors to build low code process automation solutions"
5
+
description: "Use connectors to build low code process automation solutions"
6
6
keywords:
7
7
[api endpoints, orchestration, getting started, user guide, connectors]
8
8
---
@@ -14,38 +14,38 @@ keywords:
14
14
import clsx from "clsx";
15
15
import SaasPrereqs from './react-components/\_saas-prerequisites.md'
16
16
17
-
This guide will walk you through working with a REST Connector task as a first time Camunda 8 SaaS user. The REST Connector is a [protocol Connector](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md#protocol-connectors), where you can make a request to a REST API and use the response in the next steps of your process.
17
+
This guide will walk you through working with a REST connector task as a first time Camunda 8 SaaS user. The REST connector is a [protocol connector](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md#protocol-connectors), where you can make a request to a REST API and use the response in the next steps of your process.
18
18
19
19
:::note
20
-
New to Connectors? Review our [introduction to Connectors](/components/connectors/introduction.md) to get familiar with their capabilities, and have a closer look at all of the available [out-of-the-box Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md).
20
+
New to connectors? Review our [introduction to connectors](/components/connectors/introduction.md) to get familiar with their capabilities, and have a closer look at all of the available [out-of-the-box connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md).
21
21
:::
22
22
23
23
<details>
24
24
<summary>Have you signed up for Camunda yet?</summary>
25
25
<SaasPrereqs/>
26
26
</details>
27
27
28
-
The concept of a Connector consists of two parts: the business logic is implemented as a job worker, and the user interface during modeling is provided using an element template. In this guide, you will create a REST Connector task in your process, handle the HTTP response, and deploy your process. New to creating a process? Get started by [modeling your first diagram](/guides/model-your-first-process.md).
28
+
The concept of a connector consists of two parts: the business logic is implemented as a job worker, and the user interface during modeling is provided using an element template. In this guide, you will create a REST connector task in your process, handle the HTTP response, and deploy your process. New to creating a process? Get started by [modeling your first diagram](/guides/model-your-first-process.md).
29
29
30
-
## Step 1: Create a REST Connector task
30
+
## Step 1: Create a REST connector task
31
31
32
-
To use a **REST Connector** in your process, follow the steps below:
32
+
To use a **REST connector** in your process, follow the steps below:
33
33
34
34
1. Create a BPMN diagram. To do this, click **New project** within Modeler.
35
35
2. Name your project and select **Create new > BPMN diagram**.
36
36
3. Give your model a descriptive name and ID. On the right side of the page, expand the **General** section of the properties panel to find the name and ID fields. For this guide, we'll use `API Orchestration Tutorial` for the name and `api-orchestration-tutorial` for the ID.
37
-
4. Use Web Modeler to design a BPMN flow with a Connector. Create a Connector by dragging the rectangular task element from the palette, or click the existing start event and the displayed task element to the right of the start event.
38
-
5. Change the task type by clicking the wrench icon and select **REST Outbound Connector** in the **Connectors** section. Alternatively, you can directly choose a **REST Outbound Connector** by using the context pad.
37
+
4. Use Web Modeler to design a BPMN flow with a connector. Create a connector by dragging the rectangular task element from the palette, or click the existing start event and the displayed task element to the right of the start event.
38
+
5. Change the task type by clicking the wrench icon and select **REST Outbound connector** in the **Connectors** section. Alternatively, you can directly choose a **REST Outbound connector** by using the context pad.
39
39
40
40
41
41
42
42
6. Add a descriptive name using the **General** section in the properties panel. For this guide, we'll use `Make a request`.
43
43
44
-
## Step 2: Make your REST Connector executable
44
+
## Step 2: Make your REST connector executable
45
45
46
46
47
47
48
-
To make the **REST Connector** executable, fill out the mandatory **URL** field in the HTTP Endpoint section (highlighted in red) in the properties panel with `https://catfact.ninja/fact` so we can get a random cat fact from the [Cat Fact API](https://catfact.ninja/) for this example.
48
+
To make the **REST connector** executable, fill out the mandatory **URL** field in the HTTP Endpoint section (highlighted in red) in the properties panel with `https://catfact.ninja/fact` so we can get a random cat fact from the [Cat Fact API](https://catfact.ninja/) for this example.
49
49
50
50
## Step 3: Handle your response
51
51
@@ -68,7 +68,7 @@ To deploy your process, take the following steps:
68
68
69
69
Congratulations! You successfully built your first API orchestration solution with Camunda 8.
70
70
71
-
Camunda 8 empowers users to automate processes faster. Connectors are reusable components that allow you to access APIs without writing code.
71
+
Camunda 8 empowers users to automate processes faster. connectors are reusable components that allow you to access APIs without writing code.
72
72
73
73
Don't want to build the process yourself? Click this button to create it from a template in Camunda 8 SaaS, or sign up first.
74
74
@@ -92,5 +92,5 @@ Don't want to build the process yourself? Click this button to create it from a
92
92
## Additional resources and next steps
93
93
94
94
- Learn more about Camunda 8 and what it can do by reading [What is Camunda 8](/components/concepts/what-is-camunda-8.md) or watching our [Overview video](https://bit.ly/3TjNEm7) in Camunda Academy.
95
-
-[Learn about types of Connectors](/components/connectors/connector-types.md)
96
-
-[Use Connectors in your BPMN process](/components/connectors/use-connectors/index.md)
95
+
-[Learn about types of connectors](/components/connectors/connector-types.md)
96
+
-[Use connectors in your BPMN process](/components/connectors/use-connectors/index.md)
0 commit comments