Joule
  • Welcome to Joule's Docs
  • Why Joule?
    • Joule capabilities
  • What is Joule?
    • Key features
    • The tech stack
  • Use case enablement
    • Use case building framework
  • Concepts
    • Core concepts
    • Low code development
    • Unified execution engine
    • Batch and stream processing
    • Continuous metrics
    • Key Joule data types
      • StreamEvent object
      • Contextual data
      • GeoNode
  • Tutorials
    • Getting started
    • Build your first use case
    • Stream sliding window quote analytics
    • Advanced tutorials
      • Custom missing value processor
      • Stateless Bollinger band analytics
      • IoT device control
  • FAQ
  • Glossary
  • Components
    • Pipelines
      • Use case anatomy
      • Data priming
        • Types of import
      • Processing unit
      • Group by
      • Emit computed events
      • Telemetry auditing
    • Processors
      • Common attributes
      • Filters
        • By type
        • By expression
        • Send on delta
        • Remove attributes
        • Drop all events
      • Enrichment
        • Key concepts
          • Anatomy of enrichment DSL
          • Banking example
        • Metrics
        • Dynamic contextual data
          • Caching architecture
        • Static contextual data
      • Transformation
        • Field Tokeniser
        • Obfuscation
          • Encryption
          • Masking
          • Bucketing
          • Redaction
      • Triggers
        • Change Data Capture
        • Business rules
      • Stream join
        • Inner stream joins
        • Outer stream joins
        • Join attributes & policy
      • Event tap
        • Anatomy of a Tap
        • SQL Queries
    • Analytics
      • Analytic tools
        • User defined analytics
          • Streaming analytics example
          • User defined analytics
          • User defined scripts
          • User defined functions
            • Average function library
        • Window analytics
          • Tumbling window
          • Sliding window
          • Aggregate functions
        • Analytic functions
          • Stateful
            • Exponential moving average
            • Rolling Sum
          • Stateless
            • Normalisation
              • Absolute max
              • Min max
              • Standardisation
              • Mean
              • Log
              • Z-Score
            • Scaling
              • Unit scale
              • Robust Scale
            • Statistics
              • Statistic summaries
              • Weighted moving average
              • Simple moving average
              • Count
            • General
              • Euclidean
        • Advanced analytics
          • Geospatial
            • Entity geo tracker
            • Geofence occupancy trigger
            • Geo search
            • IP address resolver
            • Reverse geocoding
            • Spatial Index
          • HyperLogLog
          • Distinct counter
      • ML inferencing
        • Feature engineering
          • Scripting
          • Scaling
          • Transform
        • Online predictive analytics
        • Model audit
        • Model management
      • Metrics engine
        • Create metrics
        • Apply metrics
        • Manage metrics
        • Priming metrics
    • Contextual data
      • Architecture
      • Configuration
      • MinIO S3
      • Apache Geode
    • Connectors
      • Sources
        • Kafka
          • Ingestion
        • RabbitMQ
          • Further RabbitMQ configurations
        • MQTT
          • Topic wildcards
          • Session management
          • Last Will and Testament
        • Rest endpoints
        • MinIO S3
        • File watcher
      • Sinks
        • Kafka
        • RabbitMQ
          • Further configurations
        • MQTT
          • Persistent messaging
          • Last Will and Testament
        • SQL databases
        • InfluxDB
        • MongoDB
        • Geode
        • WebSocket endpoint
        • MinIO S3
        • File transport
        • Slack
        • Email
      • Serialisers
        • Serialisation
          • Custom transform example
          • Formatters
        • Deserialisers
          • Custom parsing example
    • Observability
      • Enabling JMX for Joule
      • Meters
      • Metrics API
  • DEVELOPER GUIDES
    • Setting up developer environment
      • Environment setup
      • Build and deploy
      • Install Joule
        • Install Docker demo environment
        • Install with Docker
        • Install from source
        • Install Joule examples
    • Joulectl CLI
    • API Endpoints
      • Mangement API
        • Use case
        • Pipelines
        • Data connectors
        • Contextual data
      • Data access API
        • Query
        • Upload
        • WebSocket
      • SQL support
    • Builder SDK
      • Connector API
        • Sources
          • StreamEventParser API
        • Sinks
          • CustomTransformer API
      • Processor API
      • Analytics API
        • Create custom metrics
        • Define analytics
        • Windows API
        • SQL queries
      • Transformation API
        • Obfuscation API
        • FieldTokenizer API
      • File processing
      • Data types
        • StreamEvent
        • ReferenceDataObject
        • GeoNode
    • System configuration
      • System properties
  • Deployment strategies
    • Deployment Overview
    • Single Node
    • Cluster
    • GuardianDB
    • Packaging
      • Containers
      • Bare metal
  • Product updates
    • Public Roadmap
    • Release Notes
      • v1.2.0 Join Streams with stateful analytics
      • v1.1.0 Streaming analytics enhancements
      • v1.0.4 Predictive stream processing
      • v1.0.3 Contextual SQL based metrics
    • Change history
Powered by GitBook
On this page
  • Overview
  • Key features of Joule's contextual data capability
  • Joule's contextual data in action
  • Types of source implementations

Was this helpful?

  1. Components

Contextual data

Enrich real-time streams with contextual data

Overview

For Joule applications, contextual (or reference) data is crucial for enabling advanced and insightful stream processing. By seamlessly integrating contextual data with real-time events, the system delivers enriched processing outcomes and better informed insights.

Within Joule, contextual data comprises both static and dynamic data:

  1. Static data Includes reference information, such as customer contracts, product SKUs, or start-of-day FX rates, machine learning predictive models etc.

  2. Dynamic data Consists of real-time metrics that drive KPI computations, machine learning (ML) engineered features, analytics, and other performance-based measures.

Some example applications include:

  1. Geospatial location analytics Leveraging well-known areas of interest for real-time geospatial insights.

  2. Real-time customer promotions Tailored promotions based on historical buying profiles and real-time customer behaviour.

  3. Multi-currency dynamic pricing Adapting pricing strategies based on live exchange rates and market conditions.

  4. Real-time spending alerts Powered by pre-engineered ML features to track and alert users of unusual spending patterns.

  5. Predictive capacity demand forecasting Using live metrics to forecast future resource or capacity needs with high accuracy.

These capabilities enable Joule to not only process data in real time but also drive actionable insights that influence business decisions.

Key features of Joule's contextual data capability

  1. Event enrichment Adds static information (i.e., geographic or device data) to live events for richer analysis.

  2. Transformation and validation Transforms and validates event attributes using predefined patterns or rules.

  3. Real-time predictive analytics Utilises engineered features for machine learning models.

  4. Machine Learning models Load and replace machine learning models

  5. KPI computation Generates real-time performance indicators based on enriched event data.

  6. Local caching Contextual data is treated as "slow-moving" and often cached locally within processing nodes to optimise performance.

Joule's contextual data in action

Joule provides every processor with implementation interfaces to access and apply contextual data within its processing scope.

The selection of a contextual data store depends on the specific access and usage requirements of each processor. For scenarios involving high-throughput event processing, an integrated, enterprise-grade, low-latency caching solution is available. For processors where models, rules, or mathematical constants require periodic updates, the MinIO S3-compatible solution is provided.

Contextual data is treated differently to event driven data, it is considered slow-moving

For further information on how Joule integrates contextual data review the following documents:

Types of source implementations

Joule integrates with various data sources to support contextual data within stream processing, these are:

PreviousPriming metricsNextArchitecture

Last updated 5 months ago

Was this helpful?

Architecture

Understand how contextual data integrates within Joule

Configuration

Set up a contextual data-driven use case

Minio S3

Multi-cloud S3-compatible interface for static contextual data (e.g., ML models)

Apache Geode

High-performance caching platform for static and slow-moving contextual data