User Story Description:
As a form designer, I want to be able to set a submission reminder at the form level for a specific date interval/timeframe (i.e. quarterly emails).
Once the date is set, reminders to submit would be emailed to appropriate submitters (i.e. to submitters who haven’t submitted the form for the given period).
The “Automated Notification” section should allow the following:
Check box to enable automated notifications. This will, by default, enable two notifications. One that will be sent on the first day of the submission period. And one that will be sent out on last day of the submission period.
Then another check should be available for the designer to “Allow additional notifications“. This will offer a drop down to select what type of interval reminders should be sent out. (e.g. If Submission period is set to every month, then the additional notifications can be sent out every “day“ or “week“. If the Submission period is set to every quarter, then the additional notifications can be sent out every “day“, “week“ or “month“, etc.)
Business Rationale:
Priority: Should Have
Dependencies:
[List potential dependencies with other User Stories or Tasks]
# | Task or User Story | Type of Dependency |
1 | Parent | |
2 | FORMS-289: (Form Designer) Setup Form Submission Period Setting | Parent |
Technical Details:
Open Shift can be responsible to handle Schedule/Cron Job (In order to send Bulk Emails).
Common Components - Digital Government - Province of British Columbia (Common Hosted Email Service) can be used to send bulk emails.
CHES Service file :
app\src\components\chesService.jsUse of chesService :
app\src\forms\email\emailService.js
API Documentation Common Hosted Email Service API - Documentation v1 (gov.bc.ca)
Need multiple Login accounts for testing
In order to create multiple accounts, We need to enable login by BCeID (Identity provider) module. Here is rocket chat help thread https://chat.developer.gov.bc.ca/channel/sso?msg=9vmQmEFjsw2RdiNMu for this.
In order to create (Bypass Identity providers) local users need some changes into KeyCloak admin console. (More info in the document attached)
Custom
Acceptance Criteria:
[List the Acceptance Criteria]
# | Description | Notes |
1 | As a Designer, I can see the option to set up reminders on the Form Settings page : Section called ”Automated Notifications” This option should only be available when submitters can be identified in the Team Management page. |
|
2 | As a Designer i can set Automated Notification (Reminder emails) in two ways
|
|
3 | Emails to be sent by CHES service as schedule job The cronjob will be managed by Openshift. | API Documentation Common Hosted Email Service API - Documentation v1 (gov.bc.ca) |
4 | As a submitter I should only receive notifications if I haven’t submitted the form for a given period | |
5 | Different scenarios for refreshsing the “Period/Interval” dropdown dinamically based on the submission period setup will need to be taken into account. E.g. Submission period is 1 day only, then the Additional notification shouldn’t even be allowed. There should be a minimum submission period defined before allowing “Additional Notifications“. Threshold for now should be 7 days. Emir will confirm this design decision. |
Prototype/Mockups
Provide high fidelity prototype or mockup
Out of Scope:
When submission period isn’t setup, then the Automated Notifications will not be available. We will have a separate story to work on manual notifications
Contact(s):
Table of Contents