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
  • Setting up
  • Components
  • Processors
  • Integrations
  • Joule Image
  • Event Simulator
  • Event Structure
  • Note
  • Support

Was this helpful?

  1. Use case examples

Telco

Last updated 1 year ago

Was this helpful?

Overview

The objective of this project is provide a set of examples that demonstrates some of the core Joule platform capabilities. Each use case builds upon the previous to represent how use cases can be built and tested incrementally with the final use case combining all functionality to demonstrate a simple direct telco marketing campaign using simulated streaming mobile events and geospatial analytics.

A set of use case examples have been defined as a sequence to gain how incremental functionality is developed for a target use case. We start from the basic filtering of user events to direct marketing using real-time geospatial triggers. All use cases source event data from a basic mobile event simulator described further in the document.

  1. IMSI Opt-out filtering

  2. Enrich events with device information

  3. Anonymise IMSI field

  4. Trigger location tracking using predefined geofences

  5. Generate geospatial marketing messages based on location

Good to know: depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!

Setting up

Clone the is hosted on Gitlab

By building the example locally you will have the flexibility to create new use cases, analytics, processors, transports and contribute back the to project. Build the project in the root directory by following the below instructions.

First build the project

gradle clean build && cd build/distributions 
    && unzip fractalworks-telco-example-1.0.zip 
    && cd fractalworks-telco-example-1.0 
    && chmod +x bin/*.sh

Start joule processor

./bin/startJoule.sh

Events will be generated, published, consumed, process and finally published to InfluxDB and ready to be visualised in Grafana.

Components

The following Joule platform components are used

Processors

  • Filtering

  • Anonymisation

  • Geospatial

  • Joule SDK for custom plugins

Integrations

  • Geode, caching layer to provide low latency data to processing clients, integrated to Postgres

  • Postgres, database holding reference data and hosted with in a Docker container

  • InfluxDB, time series database for processed events

Joule Image

Event Simulator

Events for these examples are generated using a simulator, events are modelled on simple mobile events. The simulator has been developed using the Joule SDK by extending the AbstractConsumerTransport class.

Events are generated for five IMSIs to simulate entities moving through London streets. The default journey provided has IMSIs travelling from Waterloo station to St Pauls and back until the example process is stopped Each IMSI speed and direction is dynamically set on each movement iteration to simulate the general movement of entities in the system. Along with entity movement, the algorithm sets the corresponding connected cell tower, geospatial coordinates, data usage and dropped calls.

Event Structure

The following fields are available on each event

- ingestTime
- eventTime
- imsi
- imei
- bundleid
- bytesUp
- bytesDown
- epsAttachAttempts
- smsMo2gFailRate
- droppedCall
- latlng
- celltower

Note

You can provide your own journey path, see the below example, and geofences, see further down in the document

cat conf/sources/mobileSimulatedLondonTubeTripStream.yaml

Support

Creating examples and a platform takes a significant amount of work. Joule is independently developed, funded and maintained by Fractalworks Ltd. If you would like to support please contact Fractalworks enquiries

The latest Joule image can be pulled from the following

📱
project repository
docker hub link