Skip to content

Commit

Permalink
Feature/#607 (#26)
Browse files Browse the repository at this point in the history 
* Updates as per PR comments.

* Story #607 - Update to the README.md. Created the onboarding.md.

* Included Architecture and Technologies Overview as requested in the review.

* Included new images.

* Changed images to png since svg is not displaying correctly.

* Updated with additional suggestions as per review.
  • Loading branch information
@HenkKodde
HenkKodde committed Feb 19, 2019
1 parent 5124735 commit e8c8ca0
Show file tree
Hide file tree
Showing 4 changed files with 298 additions and 52 deletions.
139 changes: 87 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,76 +1,94 @@
# Notification service
# Central Event Processor Service
[![Git Commit](https://img.shields.io/github/last-commit/mojaloop/central-event-processor.svg?style=flat)](https://github.com/mojaloop/central-event-processor/commits/master)
[![Git Releases](https://img.shields.io/github/release/mojaloop/central-event-processor.svg?style=flat)](https://github.com/mojaloop/central-event-processor/releases)
[![Docker pulls](https://img.shields.io/docker/pulls/mojaloop/central-event-processor.svg?style=flat)](https://hub.docker.com/r/mojaloop/central-event-processor)
[![CircleCI](https://circleci.com/gh/mojaloop/central-event-processor.svg?style=svg)](https://circleci.com/gh/mojaloop/central-event-processor)

The Central Event Processor (CEP) service provides the capability to monitor for a pre-defined/configured set of business rules or patterns such as breaching the threshold set for a particular limit (or Net Debit Cap) or a Position Adjustment based on a Settlement.

In the current iteration, the rules are set to monitor for three criteria:

1. Breaching of a threshold on the Limit of Net Debit Cap (which may be set as part of on-boarding)
2. Adjustment of the limit - Net Debit Cap
3. Adjust of position based on a Settlement.

The CEP can then be integrated with a notifier service, to send out notifications or alerts. In this instance, it integrates with the email-notifier to send out alerts based on the aforementioned criteria.

## Contents
<!-- vscode-markdown-toc -->
* 1. [Stories](#Stories)
* 2. [Tasks](#Tasks)
* 3. [Reacts on](#Reactson)
* 4. [Used technologies](#Usedtechnologies)
* 5. [Local storage](#Localstorage)
* 6. [Architecture overview](#Architectureoverview)
* 7. [General process overview](#Generalprocessoverview)
* 7.1. [enums](#enums)
* 7.2. [Rules](#Rules)
* 7.3. [Config](#Config)
* 8. [Limit Adjustment Rules flow](#LimitAdjustmentRulesflow)
* 9. [Limit Position Threshold Breach flow](#LimitPositionThresholdBreachflow)
* 10. [Actions Agent flow](#ActionsAgentflow)
* 11. [Scheduler flow](#Schedulerflow)
* 12. [Notifier flow (separate service)](#Notifierflowseparateservice)

<!-- vscode-markdown-toc-config
numbering=true
autoSave=true
/vscode-markdown-toc-config -->
<!-- /vscode-markdown-toc -->

## 1. <a name='Stories'></a>Stories
Central Event Processor
=======================

stories
-------
* [Deployment](#1-deployment)
* [Notes](#2-notes)
* [Tasks](#3-tasks)
* [Reacts on](#4-reacts-on)
* [Used technologies](#5-used-technologies)
* [Local storage](#6-local-storage)
* [Architecture overview](#7-architecture-overview)
* [Architecture and Technologies Overview](#8-architecture-and-technologies-overview)
* [General process overview](#9-general-process-overview)
* [enums](#91-enums)
* [Rules](#92-rules)
* [Config](#93-config)
* [Limit Adjustment Rules flow](#10-limit-adjustment-rules-flow)
* [Limit Position Threshold Breach flow](#11-limit-position-threshold-breach-flow)
* [Actions Agent flow](#12-actions-agent-flow)
* [Scheduler flow](#13-scheduler-flow)
* [Notifier flow (separate service)](#14-notifier-flow-separate-service)

## 1. Deployment
See the [onboarding guide](onboarding.md) for running the service locally.

## 2. Notes

* [#517 - Notification for changes to NetDebitCap or Position adjustments](https://github.com/mojaloop/project/issues/517)
* [#518 - Notification for approaching Net Debit Cap Threshold](https://github.com/mojaloop/project/issues/518)

## 2. <a name='Tasks'></a>Tasks
## 3. Tasks
* send notifications when current position breaches the limit threshold value after a successful transfer was commited
* send notifications when the limit was adjusted
* make it extendable and flexible

## 3. <a name='Reactson'></a>Reacts on
## 4. Reacts on
* messages consumed from the notification topic
* data read from the central-ledger API

## 4. <a name='Usedtechnologies'></a>Used technologies
## 5. Used technologies
* [RxJS](https://github.com/ReactiveX/rxjs)
* [json-rule-engine](https://github.com/cachecontrol/json-rules-engine)
* [mongoose](https://github.com/Automattic/mongoose)

## 5. <a name='Localstorage'></a>Local storage
## 6. Local storage
* Mongo DB
* Mongoose is used for schema validations and ORM functions
* to set up connection the following environmental variables might be used: `CEP_DATABASE_URI` and `CEP_DATABASE_NAME`
* full database documentation can be found [here](docs/database/Mojaloop_central-notifications_Db_ver1.0.html)
* full database documentation can be found at [Mojaloop central notifications Database](docs/database/Mojaloop_central-notifications_Db_ver1.0.html)

## 7. Architecture overview

## 6. <a name='Architectureoverview'></a>Architecture overview
![architecture](docs/images/1.png)

[Architecture Overview](docs/images/1.png)

This is standalone service which is connected to Kafka Notification topic into the mojaloop environemnt and monitors the topic for messages which match certain rules and takes actions accordingly.

The service is developed using [RxJS](https://github.com/ReactiveX/rxjs) for observing the system and acting accordingly. The decissions for actions are taken by the [json-rule-engine](https://github.com/cachecontrol/json-rules-engine).
The service is developed using [RxJS](https://github.com/ReactiveX/rxjs) for observing the system and acting accordingly. The decisions for actions are taken by the [json-rule-engine](https://github.com/cachecontrol/json-rules-engine).

## 8. Architecture and Technologies Overview

![ArchTechOverview](docs/architechDiagrams/CEPArchTechOverview.png)

[Architecture and Technologies Overview](docs/architechDiagrams/CEPArchTechOverview.svg)

## 9. General process overview

## 7. <a name='Generalprocessoverview'></a>General process overview
![process](docs/images/2.png)

[Process Overview](docs/images/2.png)

The rules validations are triggered upon commited transfers. As soon as a commited transfer notification is produced from the central-ledger to the notification topic, the central-notifications service picks it up, gathers more information, runs few rules validations and acts based on rules engine outcome.

The data for performing rules validation is requested from the central-ledger admin API calls using observables, available [here](src/observables/centralLedgerAPI.js) some mapping and wiring is done through below [enums](src/lib/enum.js) properties:

### 7.1. <a name='enums'></a>enums
```
### 9.1. enums
```javascript
const notificationActionMap = {
NET_DEBIT_CAP_THRESHOLD_BREACH_EMAIL: {
enum: 'NET_DEBIT_CAP_THRESHOLD_BREACH_EMAIL',
Expand All @@ -95,41 +113,58 @@ const limitNotificationMap = {
}
```

### 7.2. <a name='Rules'></a>Rules
### 9.2. Rules
Currently two separate Rules are validated:
1. Limit Adjustment Rule [here](src/observables/rules/ndcAdjustment.js)
2. Limit Position Threshold Breach Rule [here](src/observables/rules/ndcBreach.js)
1. [Limit Adjustment Rule](src/observables/rules/ndcAdjustment.js)
2. [Limit Position Threshold Breach Rule](src/observables/rules/ndcBreach.js)

In the current implementation for each separate rule, an observable has to be created, like the couple above, and configured when and how to trigger it into the [setup](src/setup.js)
The Rules outputs should be chained to common Action Agent.

### 7.3. <a name='Config'></a>Config
### 9.3. Config

The default [config](config/config.json)

The default config is available [here](config/config.json)
To use Environmental Variables for MongoDB URI and database name use:
`CEP_MONGO_URI` and `CEP_MONGO_DATABASE`

## 8. <a name='LimitAdjustmentRulesflow'></a>Limit Adjustment Rules flow
## 10. Limit Adjustment Rules flow

![limitAdjustment](docs/sequenceDiagrams/seq-cep-10.2-adjustment-rule-validation.svg)

[Limit Adjustment Rules flow](docs/sequenceDiagrams/seq-cep-10.2-adjustment-rule-validation.svg)

This rule is triggered on each limit response from the central-ledger admin API.


## 9. <a name='LimitPositionThresholdBreachflow'></a>Limit Position Threshold Breach flow
## 11. Limit Position Threshold Breach flow

![limitPositionThresholdBreach](docs/sequenceDiagrams/seq-cep-10.3-breaching-threshold-percentage-limit.svg)

[Limit Position Threshold Breach flow](docs/sequenceDiagrams/seq-cep-10.3-breaching-threshold-percentage-limit.svg)

This rule is triggered when all data for the participants in the current transfer is received.

## 10. <a name='ActionsAgentflow'></a>Actions Agent flow
## 12. Actions Agent flow

![actionAgent](docs/sequenceDiagrams/seq-cep-10.4-action-flow.svg)

The Action Agent - [here](src/observables/actions) - takes care of action preparation regrding the data from central-ledger admin API and various settings.
[Actions Agent flow](docs/sequenceDiagrams/seq-cep-10.4-action-flow.svg)

The [Action Agent](src/observables/actions) - takes care of action preparation regrding the data from central-ledger admin API and various settings.

## 13. Scheduler flow

## 11. <a name='Schedulerflow'></a>Scheduler flow
![schedulerFlow](docs/sequenceDiagrams/seq-cep-10.5-scheduler-flow.svg)

[Scheduler flow](docs/sequenceDiagrams/seq-cep-10.5-scheduler-flow.svg)

The scheduler coordinates the Action Object that requires to be dispatched. It would typically action a scheduled event that qualifies by insure only the prescribed number of notifications are dispatched within the set time frame defined.

## 12. <a name='Notifierflowseparateservice'></a>Notifier flow (separate service)
## 14. Notifier flow (separate service)

![notifier](docs/images/6.png)

Email notifier service is a separate app, that observes the same topic for messages with field *from* = `SYSTEM`. Its code is available [here](https://github.com/mojaloop/email-notifier)
[Notifier flow](docs/images/6.png)

Email notifier service is a separate app, that observes the same topic for messages with field *from* = `SYSTEM`. Its code is available in the [email-notifier](https://github.com/mojaloop/email-notifier) repository.
Binary file added docs/architechDiagrams/CEPArchTechOverview.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e8c8ca0

Please sign in to comment.