A template for new C8 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 Function (rename, implement, update
OutboundConnector
annotation)- Service Provider Interface (SPI) (rename)
...and delete this hint.
Connector Template
Camunda Connector Template
Build
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 fat 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.
Shading dependencies
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 avoiding 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.
API
Input
{
"token": ".....",
"message": "....."
}
Output
{
"result": {
"myProperty": "....."
}
}
Error codes
Code | Description |
---|---|
FAIL | Message starts with 'fail' (ignoring case) |
Test locally
Run unit tests
mvn clean verify
Test with local runtime
Use the Camunda Connector Runtime to run your function as a local Java application.
In your IDE you can also simply navigate to the LocalContainerRuntime
class in test scope and run it via your IDE.
If necessary, you can adjust application.properties
in test scope.
Element Template
The element templates can be found in the element-templates/template-connector.json file.