Skip to content

Commit

Permalink
feature(inbound-template): refactor the inbound template fix comment
Browse files Browse the repository at this point in the history
  • Loading branch information
mathias-vandaele committed Jan 15, 2025
1 parent cb83f21 commit 1be8f44
Showing 1 changed file with 12 additions and 15 deletions.
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,10 @@
> * [Service Provider Interface (SPI)](./src/main/resources/META-INF/services/io.camunda.connector.api.inbound.InboundConnectorExecutable) (
rename)
>
> ...and delete this hint.
>
> Read more
> About [creating Connectors](https://docs.camunda.io/docs/components/connectors/custom-built-connectors/connector-sdk/#creating-a-custom-connector)
>
about [creating Connectors](https://docs.camunda.io/docs/components/connectors/custom-built-connectors/connector-sdk/#creating-a-custom-connector)
>
> Check out the [Connectors SDK](https://github.com/camunda/connector-sdk)
> Check out the [Connectors SDK](https://github.com/camunda/connectors)
# Connector Template

Expand Down Expand Up @@ -46,7 +43,7 @@ This will create the following artifacts:

You can use the `maven-shade-plugin` defined in the [Maven configuration](./pom.xml) to relocate common dependencies
that are used in other Connectors and
the [Connector Runtime](https://github.com/camunda-community-hub/spring-zeebe/tree/master/connector-runtime#building-connector-runtime-bundles).
the [Connector Runtime](https://github.com/camunda/connectors).
This helps to avoid classpath conflicts when the Connector is executed.

Use the `relocations` configuration in the Maven Shade plugin to define the dependencies that should be shaded.
Expand Down Expand Up @@ -98,9 +95,9 @@ To ensure the seamless functionality of your custom Camunda connector, please fo

1. Clone the Camunda Platform repository from GitHub:

```shell
git clone https://github.com/camunda/camunda-platform.git
```
```shell
git clone https://github.com/camunda/camunda-platform.git
```

Navigate to the cloned directory and open docker-compose-core.yaml with your preferred text editor.

Expand All @@ -109,9 +106,9 @@ locally.

Initiate the Camunda suite with the following Docker command:

```shell
docker compose -f docker-compose-core.yaml up
```
```shell
docker compose -f docker-compose-core.yaml up
```

### Configuring Camunda Modeler

Expand All @@ -122,8 +119,7 @@ Initiate the Camunda suite with the following Docker command:
### Launching Your Connector

1. Run `io.camunda.example.LocalConnectorRuntime` to start your connector.
2. Create and initiate a process that utilizes your newly created connector within the Camunda
Modeler. ![Connector in Camunda Modeler](img/img.png)
2. Create and initiate a process that utilizes your newly created connector within the Camunda Modeler. ![Connector in Camunda Modeler](img/img.png)
3. Verify that the process is running smoothly by accessing Camunda Operate at [localhost:8081](http://localhost:8081).

Follow these instructions to test and use your custom Camunda connector effectively.
Expand All @@ -145,7 +141,8 @@ None required.

### Launching Your Connector

1. Start your connector by executing `io.camunda.connector.inbound.LocalConnectorRuntime` in your development environment.
1. Start your connector by executing `io.camunda.connector.inbound.LocalConnectorRuntime` in your development
environment.
2. Access the Web Modeler and create a new project.
3. Click on `Create new`, then select `Upload files`. Upload the connector template from the repository you have.
4. In the same folder, create a new BPMN diagram.
Expand Down

0 comments on commit 1be8f44

Please sign in to comment.