Skip to content

Commit 85f4291

Browse files
authored
Connector casing (wave 1 - connectors) (#5702)
* Change casing in connectors section for 8.7 * Change casing for connectors section for 8.8 * Fix headings * Fix typo
1 parent 5a97d3f commit 85f4291

File tree

112 files changed

+2033
-2033
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+2033
-2033
lines changed

docs/components/connectors/connector-types.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,50 @@ description: "Connectors come in type and subtypes that describe their functiona
66

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

9-
## Outbound Connectors
9+
## Outbound connectors
1010

11-
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.
11+
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.
1212

1313
The Java code to connect to the external system is executed when the workflow reaches the service task.
1414

15-
![Outbound Connectors](img/outbound-connectors.png)
15+
![Outbound connectors](img/outbound-connectors.png)
1616

17-
Use outbound Connectors if something needs to happen in the third-party system if a process reaches a service task. For example, calling a REST endpoint or publishing a message to Slack.
17+
Use outbound connectors if something needs to happen in the third-party system if a process reaches a service task. For example, calling a REST endpoint or publishing a message to Slack.
1818

19-
## Inbound Connectors
19+
## Inbound connectors
2020

21-
Inbound Connectors enable workflows to receive data or messages from external systems or services, making it possible to integrate workflows into a wider business process or system architecture.
22-
Inbound Connectors can be used to create a new process instance, or to send a message to a running process instance.
21+
Inbound connectors enable workflows to receive data or messages from external systems or services, making it possible to integrate workflows into a wider business process or system architecture.
22+
Inbound connectors can be used to create a new process instance, or to send a message to a running process instance.
2323

24-
The Java code of the inbound Connector has a lifecycle suitable for long-running operations, such as listening for messages on a queue or waiting for a webhook to be called.
25-
The Connector code is **activated** as soon as the Connector Runtime detects an element in a process definition that references an inbound Connector. It gets `deactivated` in case of an updated or deleted process definition.
24+
The Java code of the inbound connector has a lifecycle suitable for long-running operations, such as listening for messages on a queue or waiting for a webhook to be called.
25+
The connector code is **activated** as soon as the connector Runtime detects an element in a process definition that references an inbound connector. It gets `deactivated` in case of an updated or deleted process definition.
2626

27-
Inbound Connector instances are linked to process definitions and not to specific process instances. If a process definition contains an element referencing an inbound Connector, the Connector code will be first executed when the process definition is deployed and the deployment has been detected by the Connector Runtime.
28-
The Connector object created during deployment will be kept active as long as the process is deployed, and it is reused to serve all instances of the process.
29-
When the process definition is deleted or replaced with a newer version, the Connector object will be removed or updated as well.
27+
Inbound connector instances are linked to process definitions and not to specific process instances. If a process definition contains an element referencing an inbound connector, the connector code will be first executed when the process definition is deployed and the deployment has been detected by the connector Runtime.
28+
The connector object created during deployment will be kept active as long as the process is deployed, and it is reused to serve all instances of the process.
29+
When the process definition is deleted or replaced with a newer version, the connector object will be removed or updated as well.
3030

3131
:::note
32-
Inbound Connectors currently rely on [Operate](../../operate/operate-introduction) API to retrieve the information about deployed process definitions.
32+
Inbound connectors currently rely on [Operate](../../operate/operate-introduction) API to retrieve the information about deployed process definitions.
3333

34-
If your Camunda 8 installation doesn't include Operate, you can only use outbound Connectors.
34+
If your Camunda 8 installation doesn't include Operate, you can only use outbound connectors.
3535
:::
3636

37-
![Inbound Connectors](img/inbound-connectors.png)
37+
![Inbound connectors](img/inbound-connectors.png)
3838

39-
Use inbound Connectors if something needs to happen within the workflow engine because of an external event in the third-party system. For example, because a Slack message was published, or a REST endpoint is called.
39+
Use inbound connectors if something needs to happen within the workflow engine because of an external event in the third-party system. For example, because a Slack message was published, or a REST endpoint is called.
4040

41-
There are three types of inbound Connectors:
41+
There are three types of inbound connectors:
4242

43-
1. **Webhook Connector**: An inbound Connector which creates a webhook for a Camunda workflow.
44-
2. **Subscription Connector**: An inbound Connector that subscribes to a message queue.
45-
3. **Polling Connector**: An inbound Connector that periodically polls an external system or service for new data using HTTP polling.
43+
1. **Webhook connector**: An inbound connector which creates a webhook for a Camunda workflow.
44+
2. **Subscription connector**: An inbound connector that subscribes to a message queue.
45+
3. **Polling connector**: An inbound connector that periodically polls an external system or service for new data using HTTP polling.
4646

47-
## Protocol Connectors
47+
## Protocol connectors
4848

49-
Protocol Connectors can serve as either inbound or outbound Connectors, supporting a variety of technical protocols. These connectors are highly generic, designed to provide a flexible and customizable means of integrating with external systems and services.
49+
Protocol connectors can serve as either inbound or outbound connectors, supporting a variety of technical protocols. These connectors are highly generic, designed to provide a flexible and customizable means of integrating with external systems and services.
5050

51-
Protocol Connectors can be customized to meet the needs of specific use cases using configurable [Connector Templates](manage-connector-templates.md), with no additional coding or deployment required. Examples of protocol Connectors include HTTP REST, GraphQL, as well as message queue connectors.
51+
Protocol connectors can be customized to meet the needs of specific use cases using configurable [Connector Templates](manage-connector-templates.md), with no additional coding or deployment required. Examples of protocol connectors include HTTP REST, GraphQL, as well as message queue connectors.
5252

5353
## Next steps
5454

55-
Review the current list of [available Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md).
55+
Review the current list of [available connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md).

docs/components/connectors/custom-built-connectors/build-connector.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ A connector consists of the actual Java code, and the Modeler user interface.
5959

6060
:::note
6161

62-
- 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 on the right side of the screen.
62+
- 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 on the right side of the screen.
6363
- 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).
6464

6565
:::

0 commit comments

Comments
 (0)