Builder SDK

Joule SDK APIs enable connectors, processing, analytics and transformations

To use this section, set up the environment All gradle commands must be execute at the root of the project directory

Overview

Joule APIs enable developers to extend the platform with custom domain artefacts. The table below showcases all endpoints, a description and a specific use case example for each endpoint.

To get started to modify Joule to your needs, you will need to set up a development environment.

Follow the steps on this page to get setup for success and start unlocking the full potential of Joule’s APIs and SDKs.

This is v1.2.1 an incubating feature which is constantly being refined and extended until v1.3

API	Description	Use case
Connector	Enables users to programmatically develop custom data connectors	Use when events need to be consumed or published from unsupported connectors.
Processor	Enables users to programmatically develop custom event processors which leverages Joules existing features	Ideal for advanced analytics where additional data processing is required.
Analytics	Provides APIs for defining metrics, complex SQL queries and advanced analytics	Supports advanced analytics, machine learning and dynamic logic processing.
Metrics	Embeds computed metrics within custom processors	Support advanced analytics, machine learning, dynamic logic processing etc
SQL	Enables ANSI SQL querying within custom processors	Executes complex queries across metrics, contextual data and other datasets
Transformation	Facilitates data transformations for feature engineering and data quality functions	Developing feature engineering, data quality functions, etc
File processing	Accesses processed data directly	Primarily used for auditing and data review