Build and deploy

Once the custom component is tested and validated its ready to be deployed within the Joule execution project


See Setting up the environment documentation

Note all gradle commands must be execute at the root of the project directory

Build and deploy steps

  1. Defined components in

  2. Build, test and package

  3. Deploy to project

Explaining each step

Step 1: Define components in

Create a file with a similar definition for your custom class or classes under the resources/META-INF/services directory. If you are packaging more than one component add the definition on a new line.


Step 2: Package, test and package

A single project can have a number of custom components which can be packaged into a single or multiple jar files. The template project provides basic file. The project will execute these tests during the gradle build cycle and deploy to your local maven repository.

Example gradle file

plugins {
    id "java"
    id 'maven-publish'

jar.doFirst {
    archiveBaseName = 'mydomain-customtransformer-processor'
    manifest {
        attributes "Class-Path" : configurations.compileClasspath.collect { it.getName() }.join(' ')

dependencies {
    implementation "com.fractalworks.streams.platform:fractalworks-stream-platform:$platformVersion"

Execute the below command at the project root. This will build, test, package and publish the resulting artifacts to your local maven repository.

gradle build publishToMavenLocal

Step 3: Deploy to project

Once your package has been successfully created you are ready to deploy to a Joule project. The resulting jar artefacts' needs to be placed in to the userlibs directory in your Joule projects directory. See provided examples documentation for further directions.

cp build/libs/<your-component>.jar <location>/userlibs

Last updated