placementt-core 1.400.1196 → 1.400.1197

package/lib/constants.js

@@ -1162,13 +1162,77 @@ exports.defaultApplicantWorkflow = [
         },
     },
 ];
+// Params every placement email can use.
+const placementEmailParams = ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"];
+// Placement emails that list what the recipient still has to do.
+const placementActionParams = [...placementEmailParams, "outstandingActions"];
+// Placement emails sent while the placement waits on someone else.
+const placementWaitingParams = [...placementEmailParams, "waitingOn"];
+const placementRejectedParams = [...placementEmailParams, "reason"];
+// Emails to the cohort contact about the cohort as a whole.
+const staffCohortEmailParams = ["cohortName", "submissionDeadline", "daysUntilDeadline", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"];
+// Cohort emails sent before a student has a placement.
+const cohortEmailParams = ["studentForename", "studentSurname", "studentEmail", "parentEmail", "submissionDeadline", "daysUntilDeadline", "cohortName", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"];
 exports.emailTemplates = {
+    studentSubmissionReminder: {
+        product: "wex",
+        description: "Sent to students with no placement, counting down to the submission deadline (150, 120, 84, 63, 49, 35, 28, 21 and 14 days before). Not sent for continuous cohorts.",
+        params: cohortEmailParams,
+        button: { text: "Submit placement", link: "/institutes/home" },
+        type: "workflow",
+        name: "Please submit your placement",
+        recipient: "student",
+        group: "Before submission",
+    },
+    parentSubmissionReminder: {
+        product: "wex",
+        description: "Sent to the parent of a student with no placement, on the same days as the student reminder.",
+        params: cohortEmailParams,
+        type: "workflow",
+        name: "Please help submit",
+        recipient: "parent",
+        group: "Before submission",
+    },
+    staffSubmissionWindowClosing: {
+        product: "wex",
+        description: "Sent to the cohort contact a week before and on the day the submission window closes. Hard deadline cohorts only.",
+        params: staffCohortEmailParams,
+        button: { text: "Edit submission dates", link: "/institutes/cohorts/{{cohortId}}/settings" },
+        type: "workflow",
+        name: "Submissions closing soon",
+        recipient: "staff",
+        group: "Before submission",
+    },
     studentPlacementCreated: {
         product: "wex",
         description: "Sent to the student once a placement has been created.",
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
         button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
-        type: "workflow"
+        type: "workflow",
+        name: "Placement submitted",
+        recipient: "student",
+        group: "Submission",
+    },
+    staffLatePlacementSubmitted: {
+        product: "wex",
+        description: "Sent to the cohort contact when a placement is submitted after the submission deadline.",
+        params: placementEmailParams,
+        button: { text: "View placement", link: "/institutes/cohorts/placements/{{pId}}" },
+        type: "workflow",
+        name: "Late submission",
+        recipient: "staff",
+        group: "Submission",
+    },
+    providerActionRequired: {
+        product: "wex",
+        description: "Sent to the provider when they need to review the placement.",
+        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "outstandingActions", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "providerContactForename", "providerContactSurname", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
+        button: { text: "Review placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "Please review this placement",
+        recipient: "provider",
+        group: "Action required",
+        locked: true,
     },
     parentActionRequired: {
         product: "wex",
@@ -1176,15 +1240,111 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "outstandingActions", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
         button: { text: "Review placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
         type: "workflow",
-        group: "Action required"
+        name: "Please review this placement",
+        recipient: "parent",
+        group: "Action required",
+        locked: true,
     },
-    providerActionRequired: {
+    studentActionRequired: {
         product: "wex",
-        description: "Sent to the provider when they need to review the placement.",
-        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "outstandingActions", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "providerContactForename", "providerContactSurname", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
+        description: "Sent to the student when a stage needs something from them, such as changes, a form or a file.",
+        params: placementActionParams,
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "Action required",
+        recipient: "student",
+        group: "Action required",
+        locked: true,
+    },
+    providerSignOffReminder: {
+        product: "wex",
+        description: "Chases the employer 7 and 14 days after the placement reaches them, then weekly, and 7 days after they open the link without finishing.",
+        params: placementActionParams,
         button: { text: "Review placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
         type: "workflow",
-        group: "Action required"
+        name: "Reminder: please sign off",
+        recipient: "provider",
+        group: "Sign-off reminders",
+    },
+    parentSignOffReminder: {
+        product: "wex",
+        description: "Chases the parent 7 and 14 days after the placement reaches them, then weekly, and 7 days after they open the link without finishing.",
+        params: placementActionParams,
+        button: { text: "Review placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "Reminder: please sign off",
+        recipient: "parent",
+        group: "Sign-off reminders",
+    },
+    studentSignOffReminder: {
+        product: "wex",
+        description: "Chases the student 7 and 14 days after the placement reaches them, then weekly, and 7 days after they open it without finishing.",
+        params: placementActionParams,
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "Reminder: please complete this stage",
+        recipient: "student",
+        group: "Sign-off reminders",
+    },
+    studentStillWaiting: {
+        product: "wex",
+        description: "While the placement waits on someone else, tells the student who it is waiting on and asks them to follow up. Same days as the sign-off reminders.",
+        params: placementWaitingParams,
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "Still waiting on someone",
+        recipient: "student",
+        group: "Sign-off reminders",
+    },
+    parentStillWaiting: {
+        product: "wex",
+        description: "While the placement waits on someone else, tells the parent who it is waiting on and asks them to follow up. Same days as the sign-off reminders.",
+        params: placementWaitingParams,
+        button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "Still waiting on someone",
+        recipient: "parent",
+        group: "Sign-off reminders",
+    },
+    studentPlacementStatusChange: {
+        product: "wex",
+        description: "Sent to the student when their placement moves to a new stage.",
+        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "startDate", "endDate", "previousStage", "currentStage", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "Update: placement moved on",
+        recipient: "student",
+        group: "Status updates",
+    },
+    parentPlacementStatusChange: {
+        product: "wex",
+        description: "Sent to the parent when the placement moves to a new stage. Not sent when the parent is the one required to act.",
+        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "startDate", "endDate", "previousStage", "currentStage", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
+        button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "Update: placement moved on",
+        recipient: "parent",
+        group: "Status updates",
+    },
+    providerPlacementScheduled: {
+        product: "wex",
+        description: "Sent to the employer once all sign-off is complete and the placement is scheduled to go ahead.",
+        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
+        button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "Placement confirmed",
+        recipient: "provider",
+        group: "Status updates",
+    },
+    studentPlacementRejected: {
+        product: "wex",
+        description: "Sent to the student when staff reject their placement, with the reason.",
+        params: placementRejectedParams,
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "Placement rejected",
+        recipient: "student",
+        group: "Status updates",
     },
     studentPlacementStarting: {
         product: "wex",
@@ -1192,7 +1352,9 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "daysUntilPlacement", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
         button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
         type: "workflow",
-        group: "Placement starting"
+        name: "Placement starts soon",
+        recipient: "student",
+        group: "Placement starting",
     },
     providerPlacementStarting: {
         product: "wex",
@@ -1200,7 +1362,9 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
         button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
         type: "workflow",
-        group: "Placement starting"
+        name: "Placement starts soon",
+        recipient: "provider",
+        group: "Placement starting",
     },
     parentPlacementStarting: {
         product: "wex",
@@ -1208,28 +1372,39 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
         button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
         type: "workflow",
-        group: "Placement starting"
+        name: "Placement starts soon",
+        recipient: "parent",
+        group: "Placement starting",
     },
-    studentPlacementStatusChange: {
+    studentPlacementStartsToday: {
         product: "wex",
-        description: "Sent to the student when their placement moves to a new stage.",
-        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "startDate", "endDate", "previousStage", "currentStage", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
+        description: "Sent to the student on the first day of the placement.",
+        params: placementEmailParams,
         button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
-        type: "workflow"
+        type: "workflow",
+        name: "Starts today",
+        recipient: "student",
+        group: "Placement starting",
     },
-    parentPlacementStatusChange: {
+    providerPlacementStartsToday: {
         product: "wex",
-        description: "Sent to the parent when the placement moves to a new stage, if enabled in cohort settings. Not sent when the parent is the one required to act.",
-        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "startDate", "endDate", "previousStage", "currentStage", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
+        description: "Sent to the employer on the first day of the placement.",
+        params: placementEmailParams,
         button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
-        type: "workflow"
+        type: "workflow",
+        name: "Starts today",
+        recipient: "provider",
+        group: "Placement starting",
     },
-    providerPlacementScheduled: {
+    providerAttendanceCheck: {
         product: "wex",
-        description: "Sent to the employer once all sign-off is complete and the placement is scheduled to go ahead.",
-        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerPhone", "providerEmail", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail", "addressLineOne", "addressLineTwo", "city", "postalCode", "country"],
-        button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
-        type: "workflow"
+        description: "Asks the employer to confirm the student attended, once or every day if daily attendance is on. Only when attendance tracking is on.",
+        params: placementEmailParams,
+        button: { text: "Mark attendance", link: "{{attendancePath}}" },
+        type: "workflow",
+        name: "Was the student in today?",
+        recipient: "provider",
+        group: "During the placement",
     },
     studentPlacementEnded: {
         product: "wex",
@@ -1237,23 +1412,19 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "startDate", "endDate", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
         button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
         type: "workflow",
-        group: "Placement ended"
+        name: "Placement finished",
+        recipient: "student",
+        group: "Placement ended",
     },
     parentPlacementEnded: {
         product: "wex",
-        description: "Sent to the parent on the last day of the placement, if parent placement updates are enabled in cohort settings.",
+        description: "Sent to the parent on the last day of the placement.",
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
         button: { text: "View placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
         type: "workflow",
-        group: "Placement ended"
-    },
-    staffPlacementEnded: {
-        product: "wex",
-        description: "Sent to the cohort contact on the last day of each placement, if enabled in cohort settings.",
-        params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "providerEmail", "startDate", "endDate", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
-        button: { text: "View placement", link: "/institutes/cohorts/placements/{{pId}}" },
-        type: "workflow",
-        group: "Placement ended"
+        name: "Placement finished",
+        recipient: "parent",
+        group: "Placement ended",
     },
     studentFeedbackRequest: {
         product: "wex",
@@ -1261,7 +1432,9 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "startDate", "endDate", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
         button: { text: "Complete feedback", link: "/institutes/placements/{{pId}}" },
         type: "workflow",
-        group: "Feedback"
+        name: "Please give feedback",
+        recipient: "student",
+        group: "Feedback",
     },
     parentFeedbackRequest: {
         product: "wex",
@@ -1269,7 +1442,9 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "startDate", "endDate", "parentEmail", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
         button: { text: "Complete feedback", link: "/review/{{uid}}/{{pId}}/{{key}}" },
         type: "workflow",
-        group: "Feedback"
+        name: "Please give feedback",
+        recipient: "parent",
+        group: "Feedback",
     },
     providerFeedbackRequest: {
         product: "wex",
@@ -1277,7 +1452,84 @@ exports.emailTemplates = {
         params: ["studentForename", "studentSurname", "studentEmail", "providerName", "providerForename", "providerSurname", "startDate", "endDate", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
         button: { text: "Complete feedback", link: "/review/{{uid}}/{{pId}}/{{key}}" },
         type: "workflow",
-        group: "Feedback"
+        name: "Please give feedback",
+        recipient: "provider",
+        group: "Feedback",
+    },
+    studentAdditionalInformation: {
+        product: "wex",
+        description: "Sent when the workflow gains forms or files after the student's placement passed that stage.",
+        params: placementActionParams,
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "More information needed",
+        recipient: "student",
+        group: "Other",
+        locked: true,
+    },
+    parentAdditionalInformation: {
+        product: "wex",
+        description: "Sent when the workflow gains forms or files after the placement passed the parent's stage.",
+        params: placementActionParams,
+        button: { text: "Review placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "More information needed",
+        recipient: "parent",
+        group: "Other",
+        locked: true,
+    },
+    providerAdditionalInformation: {
+        product: "wex",
+        description: "Sent when the workflow gains forms or files after the placement passed the employer's stage.",
+        params: placementActionParams,
+        button: { text: "Review placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "More information needed",
+        recipient: "provider",
+        group: "Other",
+        locked: true,
+    },
+    studentOnboardingReminder: {
+        product: "wex",
+        description: "Sent to the student when the employer's onboarding deadline is today, or the employer asks for it to be resent.",
+        params: placementEmailParams,
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "Complete onboarding",
+        recipient: "student",
+        group: "Other",
+        locked: true,
+    },
+    providerReuploadDocument: {
+        product: "wex",
+        description: "Sent to the employer when staff reject an uploaded insurance, risk assessment or DBS check, with the reason.",
+        params: placementRejectedParams,
+        button: { text: "Review placement", link: "/review/{{uid}}/{{pId}}/{{key}}" },
+        type: "workflow",
+        name: "Please reupload a document",
+        recipient: "provider",
+        group: "Other",
+        locked: true,
+    },
+    studentReuploadDocument: {
+        product: "wex",
+        description: "Sent to the student when staff reject their onboarding, with the reason.",
+        params: placementRejectedParams,
+        button: { text: "View placement", link: "/institutes/placements/{{pId}}" },
+        type: "workflow",
+        name: "Please redo onboarding",
+        recipient: "student",
+        group: "Other",
+        locked: true,
+    },
+    providerStudentWithdrawn: {
+        product: "wex",
+        description: "Sent to the employer when the student withdraws from the placement.",
+        params: placementEmailParams,
+        type: "workflow",
+        name: "Student withdrawn",
+        recipient: "provider",
+        group: "Other",
     },
     studentActivation: {
         product: "wex",