A template for new C8 inbound Connectors.
To use this template update the following resources to match the name of your connector:
- README (title, description)
- Element Template
- POM (artifact name, id, description)
- Connector Executable (rename, implement, update
InboundConnector
annotation)- Service Provider Interface (SPI) (rename)
...and delete this hint.
Read more about creating Connectors
Check out the Connectors SDK
Camunda AWS SQS Inbound Connector Template (Support Batch Request per Message)
This repository is an add-on from the original Camunda connector AWS SQS Inbound connector template to support batch request per message body. Please refer to Camunda AWS SQS Connectors for latest updates. (https://github.com/camunda/connectors/tree/main/connectors/aws/aws-sqs)
AWS Batch Request: Why AWS Batch Request? To reduce costs or manipulate up to 10 messages with a single action. The batch processing utility provides a way to handle partial failures when processing batches of messages from SQS queues, SQS FIFO queues, Kinesis Streams, or DynamoDB Streams. Read more about AWS Batch Request
Goal: To achieve the goal of of one message with multiple requests trigger multiple process instances.
You can package the Connector by running the following command:
mvn clean package
This will create the following artifacts:
- A thin JAR without dependencies.
- An uber JAR containing all dependencies, potentially shaded to avoid classpath conflicts. This will not include the SDK artifacts since those are in scope
provided
and will be brought along by the respective Connector Runtime executing the Connector.
You can use the maven-shade-plugin
defined in the Maven configuration to relocate common dependencies
that are used in other Connectors and the Connector Runtime.
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.
The Maven Shade documentation
provides more details on relocations.
Run unit tests
mvn clean verify
Use the Camunda Connector Runtime to run your function as a local Java application.
Run as standalone Spring Application:
In your IDE you can also simply navigate to the LocalContainerRuntimeMain
class in main scope and run it via your IDE.
If necessary, you can adjust application.properties
in main/resource scope.
Note: This is not a recommended way to run connector however it helps spin up your connector runtime relatively quickly.
The element templates can be found in the element-templates/inbound-template-connector.json file.