Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue

Abstract

This project is a new feature request for the Apache Fineract CN. The SMS/Email Notifications service would be a microservice developed on Apache Fineract CN to enable MFI members to get notified on events occurring on their accounts.

There are arrays of events occurring in other microservices, therefore, there is a need to streamline these events and notify MFI members of significant events. This will impact the KYC of the organisation and the user experience.

This problem has led to the need for a microservice such as this one to be developed to  enable enable MFI staff to select notifications which need to be sent or the member choose specific events during account creation.

Project Goals

  1. Develop a an SMS/Email notification mircroservice

  2. Incorporate the microservice into a demo-server

  3. Incorporate the Notification user interface into the fims-web-app

    1. Includes an interface for microservice configuration

    2. Includes an interface to select the frequency for members

    3. Includes an interface to subscribe members to specific events

...

The notification service will start by creating a  notification object for the event, the notification object will be persisted in to into the database and later added to a notification queue for processing.

The notifications are then mapped to the list of members who have to receive them (for instance a new client created event can send out a notification to the customer (customer), the manager of the office (staff) and anyone who needs to know of an a new client account) and at this stage notification which do not have to be sent are discarded based the subscriber’s priority declarations.

...

To personalise the message, a subscriber’s prefered language and communication stated during account creation is used to localize and choose the gateway to use. For instance, if a customer indicates only SMS is sent through to their mobile and not the email. If both are indicated both SMS and email is used

...

  • NotificationEventListener

    • Has microservice instance

    • Has a JmsListener to listen to the emitted event

    • Has an SMSGatewaySMS gateway / EmailGateway Object

    • Creates a NotificationMapper

    • Creates a recipient and their notification

    • Localize the message using subscriber preference

    • Sends the email or SMS

...

Use the Twilio SMS service and google SMTP Server

  • Has Senders number

  • Has reciepent recipient number

  • Retrieves organisation’s sms SMS API configuration

  • Message content

...

  • SMS templates

  • Email Templates


 

User Interface Mockup

Link to interactive wireframe

Configuration Section:

Image Added

Image Added

Image Added

Image Added

Image Added

Event Listeners

This tentative document identifies and shortlists events which will be considered for the notification service. Under each microservice, is a list of events and each event will have a corresponding email and SMS message. Likewise, each event will have a default message and recipient associated with it.

...