dave created page: Requirements authored by Dave Lane's avatar Dave Lane
# WPMS-Mautic Integration
Integrating WPMS and Mautic to achieve seamless integration for both "Independent Study" (IS) and cohort-based (CB) learners.
Initial course targets (for January): LiDA, IP
## Principles
1. by default any learner enrolled in a course is tagged as an IS learner.
1. a learner's status in a course (IS v CB) is determined by their Mautic Contact's tags (WPMS needs to be able to determine tag status) that the learner can manage in the Preference Centre (Wayne building for Mautic).
1. absolute-time-critical submissions are frowned upon (because it's difficult to achieve relative timezone times in Mautic emails)
1. a learner can "register" for a course via Mautic (they'll be instructed to create an account *with the same email address* on course site)
1. when a learner views their WP profile information, it automatically informs them of their Mautic preferences.
1. when a learner changes their WP profile information, it automatically updates their Mautic preferences.
## Mautic Plugins
* integrate timezone awareness for learners, with regard to email timings, e.g. assignment due times, etc.
## Requirements
### Course-Site
Linkage between a Course Site and Mautic should require Course Admin control (on/off).
* 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
* Full name: the course code + (Independent Study|Cohort) + "Course for " + Partner Code (OERu|...) + date (YYYYMMDD) + " via " + source (WP|Mautic) , e.g. "LiDA101 Independent Study Course for OERu 20181205 via WP "
* alias: course code +"-"+ is|cohort + "-course-" + partner code (oeru|...) +"-"+ date +"-"+ source (wp|mautic), e.g. "lida101-is-course-oeru-20181205-mautic"
### Mautic Campaigns
Naming convention for a Course-announcement Campaign 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
### Cohort
* start date + end date
* system can determine:
* next cohort (or "no cohort scheduled"),
* current cohort (if any),
* past cohort (with dates, if any)
* system logic:
* offer independent study
* offer next cohort (if any)
* offer future cohort (beyond "next", if any are specified)
* offer current cohort (if within "cut-off" time, e.g. 2 days past cohort start)
### Cohort Calendar
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