Notification List

Overview

Within Application, you need to give notifications for different events at various stages. User can configure to trigger time based events as well as operation based event notification.

Depending on the package, user has subscribed for, number of notifications available to user varies.

Notifications List

  1. Listing
    • Notification Name : Name of the notification
    • Trigger Type : Can be either Time or Operation
    • Upload : If the subscription plan will be inclusive of these features then clicking on the option will upload it on server. If you have added any remote server details and marked it as “default” server (from project management → Remote Server List ) , then you will get option to upload code of all notifications directly on default remote server. If you don’t make any remote server as “default” server , then it will not show you this upload feature.
    • Download : If the subscription plan will be inclusive of these features then clicking on the option will download from server.
    • Update : Clicking on this will update the code related to Notification. It allows you to send notifications in your project.It allows 2 types of triggers.
      • Time based (CRON)
        1. For example : if you want to send reminder to your patients for reminding today appointment once in a Day then it’s time based.
      • Operation based
        1. For example : if you insert/add any coupon code , then it will send to your all customers by email / SMS , then it’s operation based.
    • Event Configuration : This is explained in detail at “Edit API : Configuration” in API Configuration document Below is the snapshot of the screen which you will see as soon as you will be redirected on Next page of configuration. Actions
      • Edit : This will open the notification in edit mode.
      • Delete : This will delete the particular notification.
  2. Add New : This will allow user to add new event notification.
  3. Delete : This will remove the selected notification.
  4. Show All : If filtered results are on the screen, this will show all the records at once.
  5. Copy Notifications : This will copy already configured notification from your existing project. A separate window will open where you need to select project and desired notification from the list of notifications.
  6. Update Code : This will update the code on the server after your confirmation.
  7. Documentation : This will redirect the user on documentation page for the Notification section, if available.
  8. Categories : It will redirect user on Event Categories window where default categories will be shown and new category can be added. Notifications can be switched from one category to another using this option.
  9. Searching : Any notification can be searched / filtered based on following criteria.
    • Notification Name
    • Trigger Type
    • Category
  10. Sorting : Single click on the column head will sort the records in ascending and again clicking will sort records in descending.

Add New Notification

Anytime if you want to notify user about anything which is based on time or operation, new notification can be added.

It provides same interface like API does. It imparts flowchart structure and allows you to send “SMS notification” and “Desktop Notification”. (Its additional controllers comparatively WS).

  1. SMS notification
  2. Desktop Notification
  3. SMS notification : It allows you to send SMS to specific selected group of customers.Just select contact field and set message over there. It allows you to set variable in message.
    Syntax : #variable#
  4. Desktop Notification : It allows you to send “desktop notification” to specific selected group of customers. You need to select entity , receiver email , subject , content message. Just select contact field and set message over there. It allows you to set variable in message. Syntax : #variable#.

Here is the list of fields explained for easy understanding of users:

  1. Notification Name : Enter name of the notification.
  2. Notification Function : Though this will be auto-generated, it's editable too.
  3. Notification Category : Select Event Category from default categories like Misc, Tools and User or you can add new category too.
  4. Trigger Type : Trigger type can be either Time or Operation
    • Time Based : If you want any event to happen at or between particular time, it's called Time based notification. E.g. If you want to run Anti-Virus Scanner at 1:00 PM (Lunch Time)
      • Start Date & Time : Enter event start Date & Time.
      • End Date & Time : Enter event End Date & Time
      • Common Settings : Commonly used time intervals are listed for your ease. Either you can select from the list or choose Other to add manual setting.
      • Manual Settings: To make manual/customized setting, you need to select Day, Month, Year, Hours and Minutes.
    • Operation Based : If you want to execute the event once an operation is finished, this option should be selected.
      • DB Table : Select the DB Table from the existing list
      • DB Operations : Select the DB Operation from Insert, Update and Delete.
  5. Description : Detailed description so new user/developer can understand why and in which condition it is to be used.
  6. Next : This will redirect user on Notification configuration page.
  7. Cancel : This cancel the add notification process and redirects user on previous page.
  8. Edit Notification Configuration : This is explained in detail at “Edit API : Configuration” in API Configuration document Below is the snapshot of the screen which you will see as soon as you will be redirected on Next page of configuration.

Settings for SMS Notification Controller

Configuring SMS Notification using Flow chart like screen, is shown in below screenshots:

Settings for Desktop Notification Controller

Add New Screen (OPERATION based)

It allows you to send “desktop notification” to specific selected group of customers. You need to select entity , receiver email , subject , content message. Just select contact field and set message over there. It allows you to set variable in message.

Syntax : #variable#.
It allows you to set redirection link from desktop notification.You can also apply condition if any. It shows you variable like OLD_variablename (before update) and NEW_variablelname (After Update)

Detail Page

Configuration Page

  1. How to configure Notification in Front End
  2. API Configuration
  1. How to integrate Push and Local Notification
  2. API Configuration - How to Configure Push Notification
  3. API Configuration - How to Configure Email Notification
  4. API Configuration - How to configure SMS Notification