Configure Automatically Email Reports

[WorldImpex]

As an editor, I want reports automatically sent to email addresses when an activity or activity flow was completed so that people can review a user's responses

Requirements

• Emails can be generated at an activity flow or activity level
  • Reports can have generate reports turned on and then admins can export the report from admin panel
  • By entering a valid email, 'turns on' this feature if "generate report" is also turned on in the report's tab
    • When an email is added to the applet level without an activity flow report or activity report then no report is generated.
    • When an email is added to the applet level with an activity flow report(you cannot configure emails at the activity flow level) then the activity flow report will be shown
    • When an email is added to the applet level with an activity report, then the activity's report is sent to the email address(es) ONLY when the user completes that activity that is not within an applet flow
    • When an email is added to the applet level with an activity flow report and an activity report, then a report is generated when the activity flow is completed and separately an activity report is generated when the activity that is not within the flow is completed
  • Each level of auto-generated reports email will be sent once the user/ admin has completed the activity or activity flow
  • The subject is not configurable other than the checkbox options available to the editor
  • The same subject layout should be used for the PDF name as well
  • The body text of the email is editable in markdown
  • Editor can send reports at each level to different email addresses (activity flow or activity level)
• The subject should be automatically configured by fields from the applet/ activity/ item

Applet Email

• Allow an editor to optionally include a user ID (same as secret ID) in the subject and file name
  • If a user has taken the activity or flow, show the user's SECRET ID. If it was an admin, then show the First and Last name of the admin
• The email(s), subject and body content are only editable at the applet level and are used on the activity flow and activity level.
  • There are additional options within activity flow and activity that an editor can configure

Activity Flow Email

• Allow an editor at the activity flow level to combine reports from each linked activity into one report.
  • If not combined, then there is one file for each activity in the flow in one email
  • If combined, then there is one file for every activity in the flow
    • The subject and file name are updated to applet and activity flow name
• If the Item value is turned on, then both activity and item need to be selected to save
  • Show error state and error text, "This is a required field" if an editor tries to save with one or both fields blank
  • Only show items that are supported by variable fill in are shown in the drop down
    • In the email subject and file name of the PDF, the answer the user selects will be shown

Activity Level Email

• If the Item value is turned on, then the item needs to be selected to save
  • Show error state and error text, "This is a required field" if an editor tries to save with the item field blank

Security

• We need to secure the data and creation of the PDF from end to end in a zero knowledge stance. 1 - owner prepare one master key for the applet on the owner's server 2 - public key and private key pair are generated from owner’s master key 3 - we send owner’s public key to frontend via the applet builder 4 - response data is encrypted using owner’s public key before sending to his server (data cannot be decrypted without private key) 5 - owner’s server decrypts the response data using private key and generates a pdf from it 6 - owner’s server encrypts the pdf file using master password or applet password depending on configuration 7 - owner's server sends the encrypted pdf file to our backend or s3 bucket 8 - we send email with encrypted pdf files
  • Setting up the server should be provided within a docker or something where the owner just installs onto their server. This process should be made as automated as possible.

Design

[WorldImpex]

Secruity increases the scope of this project by 14 days. This has not been added to the 5 days already required

[natalia-muzyka]

@WorldImpex Do we want to copy server configurations when duplicating applet?

[WorldImpex]

No that should be setup for each applet individually

[natalia-muzyka]

Issues:

Blocker Item Value does not function #1029

High: Admin's email is in the email subject and attachment if "User ID" is turned on in Email configurations #1297

Medium: The user can save settings of the modal with the "Item value" turned on and empty fields "Select activity", and "Select item" on the Activity Flow level Email editor #1078 (EK-Low Priority) Email configurations are copied from the library #195

Low: Email configurations are duplicated with the applet #1071 (EK-Low Priority)

EK Med-Priority: Fixed - PMHSA high + 5 emergency in priority doc - Report file has no extension if "User ID" is turned on in the Email configuration and activity is completed by admin #1302 Postponed - Admin and email PDF reports are missing if activity contains media items #1303

No Priority: The "-----BEGIN PUBLIC KEY-----" and "-----END PUBLIC KEY-----" are required to set up the public key #1032