This documentation instructs on how to integrate notification with a functionality.
For example: we want to notify a specific set of users about the creation of new savings account, so that those users can act upon those notifications and take specific actions like approve/activate the savings account.
First of all, let's configure notification for the above example and then we can take few more examples to make you comfortable with configuring notifications.
Note :- We all should agree on the fact that we need to send notifications only to those users who have some work related to that notification else, it is not useful to send a notification to any user who can't do anything with that notification.
Every user in an organization has some role associated with it. You can see which role is associated with a user by navigating to Admin >> Users and then click on the name of the user to view its details.
Now if you want a user to receive a notification whenever a new savings account is created so that it can activate or approve that account then, you need to make sure that the role of that user contains the permission to either approve or activate the savings account.
You can see what permissions a role contains by navigating to Admin>>System>>Manage Roles and Permission then click on the name of the role for which you want to see the permissions.
For our above example, we need the permissions "ACTIVATE SAVINGS ACCOUNT" or "APPROVE SAVINGS ACCOUNT" to be checked for the role of a user who will receive these notifications.Make sure that the user who will receive the notification should also have the permission to read the savings account because it has to activate or approve that savings account.
With this, our notification is configured and the user will be able receive a notification whenever a new savings account is created, and it can act upon that notification to perform the permitted actions like approve or disapprove.
Following is the list of notifications which you can configure and in the front of it are the permissions of a role which needs to be checked.
Just pick a notification which you think needs to be generated for a user then check the corresponding permissions in a role of that user.
| Events / Notification generated | Permissible actions / Permissions to be checked for the role of a user | Status |
|---|---|---|
| New client created | ACTIVATE CLIENT, READ CLIENT | Done |
| New loan created | READ LOAN, APPROVE LOAN | Done |
| New loan approved | READ LOAN, DISBURSE LOAN | Done |
| New share account created | APPROVE SHARE ACCOUNT | Done |
| New share account approved | ACTIVATE SHARE ACCOUNT | Done |
| New savings account created | READ SAVINGS ACCOUNT, APPROVE SAVINGS ACCOUNT | Done |
| New savings account approved | READ SAVINGS ACCOUNT, ACTIVATE SAVINGS ACCOUNT | Done |
| New fixed deposit account created | APPROVE FIXED DEPOSIT ACCOUNT | Done |
| New fixed deposit account approved | ACTIVATE FIXED DEPOSIT ACCOUNT | Done |
| New recurring deposit account created | APPROVE RECURRING DEPOSIT ACCOUNT | Done |
| New recurring deposit account approved | ACTIVATE RECURRING DEPOSIT ACCOUNT | Done |
| Dividend posted to account | READ DIVIDEND SHARE PRODUCT | Done |
| Interest posted to account | READ SAVINGS ACCOUNT | Done |
| Repayment made | READ SAVINGS ACCOUNT | Done |
| Deposit made | READ SAVINGS ACCOUNT | Done |
| Savings has gone into dormant | READ SAVINGS ACCOUNT | Done |
| Loan has been closed/paid off. | READ LOAN | Done |
| Loan has been rescheduled | READ LOAN | Done |
| New group created | ACTIVATE GROUP, READ GROUP | Done |
| New center created | ACTIVATE CENTER, READ CENTER | Done |
| New loan product created | READ PRODUCT MIX | Done |
Savings Account gets Overdrawn | ? | |
| Mobile Payment Received | ? | |
| Savings has gone into Inactive Status | ? | |
| Loan Is Overdue by XX days | ? | |
| New Survey taken | ? | |
| Collection sheet submitted | ? | |
| Cashier drawer settled | ? |
Summary
- For a user to get notification for an event, he/she will need a role containing the permission required to get that notification. For example, If a user wants to be notified when ever a new client is created, he/she will need a role containing "ACTIVATE CLIENT" or "READ CLIENT" permissions.
- To assign a permission to a role, navigate to Admin >> System >> Manage Roles and Permission and then click on the name of the role for which you want to assign the permission to.
- To assign a role to a user, navigate to Admin >> Users and then click on the name of the user to view his/her details, including roles.