> For the complete documentation index, see [llms.txt](https://docs.fractalworks.io/joule/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fractalworks.io/joule/use-case-examples/banking.md).

# Banking

## Overview <a href="#overview" id="overview"></a>

The objective of this project is to demonstrate Joule real-time analytics capabilities using time and event based window aggregate functions. Six use case files have been created that demonstrates various platform capabilities.

External market data events are generated using a basic simulator based upon a static nasdaq end of day market data file, published on to Kafka quotes topic. Events are consumed and processed by Joule with resulting analytics published into a InfluxDB time series bucket. Thereafter Grafana visualisations or and other suitable tool can be applied.

### Joule features demonstrated <a href="#joule-features-demonstrated" id="joule-features-demonstrated"></a>

1. Sliding windows (i.e. time and event based)
2. Group by aggregate functions
3. User defined analytics using SDK (Bollinger Bands)
4. Event filtering
5. Event projection
6. InfluxDB transport
7. Kafka publisher and consumer transports
8. Kafka event transformers
9. SQLTap that captures processed events within stream
10. RestAPI to access raw and processed events

{% hint style="info" %}
**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!
{% endhint %}

### Setting up

{% tabs %}
{% tab title="Install" %}
Clone the Gitlab examples [repository](https://gitlab.com/joule-platform/fractalworks-stream-gettingstarted)
{% endtab %}

{% tab title="Build" %}
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

<pre class="language-bash"><code class="lang-bash">gradle clean build &#x26;&#x26; cd build/distributions 
<strong>    &#x26;&#x26; unzip fractalworks-banking-example-1.0.zip 
</strong>    &#x26;&#x26; cd fractalworks-banking-example-1.0 
    &#x26;&#x26; chmod +x bin/*.sh
</code></pre>

{% endtab %}

{% tab title="Run" %}
Start joule processor

```bash
./bin/startJoule.sh
```

Events will be generated, published, consumed, process and finally published to InfluxDB and ready to be visualised in Grafana.
{% endtab %}
{% endtabs %}

### Stock Quote Simulator <a href="#stock-quote-simulator" id="stock-quote-simulator"></a>

Simulated stock quote events are created using the StockQuoteSimulator driver. A total of 7514 stock quotes are generated and published on each processing cycle. Update the StockQuoteSimulator class for additional fields and processing requirements. The `conf/csv/nasdaq.csv` file used to prime the simulator.

#### Quote Event <a href="#quote-event" id="quote-event"></a>

The following fields are available on each quote event

```
- ingestTime
- eventTime
- symbol
- bid
- ask
- volume
- volatility
- date
```

The Kafka configuration can be found here `conf/simulator/kafkapublisher.yaml`.

#### Use case <a href="#use-case" id="use-case"></a>

The use case is defined using the Joule low-code approach.

```yaml
stream:
  name: standardQuoteAnalyticsStream
  enabled: true
  eventTimeType: EVENT_TIME
  sources: [ nasdaq_quotes_stream ]

  processingUnit:
    pipeline:

      - timeWindow:
          emittingEventType: coreQuoteAnalytics
          aggregateFunctions:
            MIN: [ ask ]
            MAX: [ bid ]
            SUM: [ volume ]
            MEAN: [ volatility ]
          policy:
            type: slidingTime
            slideSize: 500
            windowSize: 2500

  select:
    expression: "symbol, ask_MIN, bid_MAX, volume_SUM, volatility_MEAN"

  groupBy:
    - symbol
```

## Support <a href="#support" id="support"></a>

Creating examples and a platform takes a significant amount of work. Joule is independently developed, funded and maintained by [Fractalworks](https://docs.fractalworks.io/joule/use-case-examples/www.fractalworks.io) Ltd. If you would like support please contact [Fractalworks](mailto:undefined).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fractalworks.io/joule/use-case-examples/banking.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.