Requirements.md

@@ -26,7 +26,6 @@ Linkage between a Course Site and Mautic should require Course Admin control (on
 * when on, any learner who enrols is automatically signed up to the appropriate Mautic Segment, 
 * when off, a learner is not signed-up, but their status must be pending in case the course is turned on.
 
-
 ### Mautic Segments
 
 Naming convention for a Course-enrolment Segment is 
@@ -35,15 +34,18 @@ Naming convention for a Course-enrolment Segment is
 
 * alias:  course code +"-"+ is|cohort + "-course-" + partner code (oeru|...) +"-"+ date +"-"+ source (wp|mautic), e.g. "lida101-is-course-oeru-20181205-mautic"
 
+Note: we only have one "Independent Study" Segment per year, which will have the date it was created in the year (or YYYY0101 if created in a different year)
 
 ### Mautic Campaigns
 
-Naming convention for a Course-announcement Campaign is 
+Naming convention for a Course-announcement Campaign - which are driven by Segments - is 
 
 * Full name: the course code + (Independent Study|Cohort) + "Announcements for" + Partner Code (OERu|...)  + date (YYYYMMDD), e.g. "IPM101 Independent Study Announcements for OERu 20181205"
 * Category for a campaign: course code (need to research this in case there's a more useful option)
 * ability rename course-related segments
 
+Note: we only have one "Independent Study" Campaign per year, which will have the date it was created in the year (or YYYY0101 if created in a different year)
+
 ### Cohort
 
 * start date + end date
@@ -62,4 +64,28 @@ Create a reference "single source" calendar, e.g. on docs.oeru.org
 
 1. for each course + partner combination set up rules for cohort start times
 
+## Code logic
+
+## User Profile
+
+* If a new User is created on WP, a corresponding Contact is created in Mautic (same email, First, Surname). The email is the key.
+* If a User updates their Profile, update any relevant changed fields in the corresponding Contact (based on original email)
+* If a User is removed, ''do not'' remove the corresponding Contact
+
+## User Enrolment
+
+While enrolled in at least one Course, a User becomes a Learner.
+
+* If a User enrols in a Course, add them to the appropriate Independent Study Segment (by default)
+** If no default (one-per-year) IS Segment exists, first create it (and an associated Campaign) according to the naming conventions.
+* If a User unenrols from a Course, automatically remove them from whatever Course-associated Segment they're enrolled in (there should only be one).
+
+Note: future plan is to allow the Learner to select a future Cohort as an alternative to the current default of IS.
+
+## Site Admin 
+
+* When reviewing the Mautic status of Learners enrolled in a Course, display the current IS Title (with a link to the Segment and corresponding Campaign).
+* Allow the Admin to modify the enrolment status of groups of Learners (a selection list of Segments including IS and Cohort-based) and an "enrol in Course" or "unenrol from Course" options. 
+** If a Learner is added to a Segment for a Course, remove that Learner from other Segments for the same Course.
+* Allow the Admin to specify a new Cohort date, and create the Segment (and Campaign) according to the naming conventions.