Alert is one of the channels Verne uses to communicate with its users. The primary purpose of an alert communication is to remind the user to take an action for an entity, a user or an organisation. Alerts can be triggered by business services and generally will ask a user to take action by filing a business service. It can also inform a user about the state of a specific business process. If the required action is taken or the process is no longer relevant, then the alert removal is triggered by the business service that enables the action or that changes the status of the process.
| Example Alerts | Action to be taken |
|---|---|
| Please file annual return for ABC Limited prior to 30 Sep 2018. | File now |
| Name reservation for Blue Sky is expiring in 3 days please file reservation renewal if you wish to keep it. | Renew name reservation |
| Your user account has not been validated with an identity verification system that we have recently implemented. | Change user details |
| ABC Limited is going to be removed from the register on 30 Oct 2019. | No action required |
An alert can be click-able or have a link beside it if there is a specific action that needs to be taken, e.g. file annual return, update user account details. There might not be any actions associated with an alert.
Alert is agnostic of how it is handled in the UI. It is the responsibility of the layer between UI and alerts manager to implement the logic that selects appropriate alert types for display on the appropriate screens.
Example – alerts displayed on the user dashboard
Example – alerts display on the company view screen
Alerts manager
Alerts manager manages instructions from business services to display or remove a specific alert. Alerts manager does not trigger the display or removal of alerts, it simply listens for alert instructions from the business services and transforms those instructions into the alert records using the associated alert template. The UI or layer in between can then pick active alert records that it is designed to display. For example:
- the user dashboards will display alerts associated with all entities the user has authority over.
- the entity view details screen will pick up and display all alerts relevant to this entity.
Alert communication settings
Alert communication settings are captured in an alert communication template that must be predefined in Verne for each alert. Below is the description of the most important settings and how communication manager interprets them:
| Setting | Description | Example |
|---|---|---|
| Recipients | Who is the audience for this alert? Create and reference one or more recipients lists. | |
| Message – summary | The main content of the message that would always be displayed. Variables can be used in the message text. Any entity level variables will be dynamically looked up when displaying an alert, other variables values will be retried at the time alert record is created and won’t be dynamic. | The <AR Year> annual return for <Entity Name> (<Entity Number>) is now due. |
| Message – details | Details of the message that could be collapsed by default, does not have to be though. Variables can be used in the message text. Any entity level variables will be dynamically looked up when displaying an alert, other variables values will be retried at the time alert record is created and won’t be dynamic. | Please file annual return by <compliance due date>. |
| Action required | Yes = A business service will be associated with this alert and the user can initiate this service to action this reminder. A button or a link will be displayed in UI alongside the alert. A due date will be associated with an action to represent its urgency. No = Alert is information only, no button or a link will be displayed in UI alongside the alert. Urgency is determined by the date the alert was created. | |
| Action due date | (Mandatory if Action required = Yes) Date when this alert must be actioned, this will be used to order alerts by urgency and potentially dynamically calculate remaining days to complete an action. | <compliance due date> |
| Action name | (Mandatory if Action required = Yes) Alert action name to be displayed on the action button/link. | File now |
| Action business service | (Mandatory if Action required = Yes) Business service that needs to be triggered when action is selected. | File annual return business service depending on the entity type: privateCompanyFileAr, publicCompanyFileAr |
| Alert unique key definition | The unique key is a variable which can be used to avoid duplicate alert instructions. | <compliance cycle unique ID> |
