This space is archived
For current information please use the current ExamSys documentation
plugin_cs_sms
Maintained by: University of Nottingham
Source: plugin_cs_sms
Latest Available Versions:
Rogo Version | Latest Plugin Version |
---|---|
7.0.0 | 1.3.1 [zip] 1.3.1 [gz] 1.3.1 [bz2] |
7.2.0 | 1.3.4 [zip] 1.3.4 [gz] 1.3.4 [bz2] |
7.3.0 | 1.3.5 [zip] 1.3.5 [gz] 1.3.5 [bz2] |
This plugin helps Rogo integrate with new Campus Solutions SMS. The following Rogo objects are synced with campus solutions either manually or by a scheduled cron job:
- Faculties & Schools
- Courses
- Modules
- Module Enrolments & Users (who are enrolled on modules)
- Summative Assessments
- Gradebook export
Configuration options
- Enable/Disable.
- URL: url of web service
- Username: http auth username for web service
- Password: http auth password for web service
- Timeout: time in seconds before timing out connection to web services
- Log Location: location where to log syncing process. Leave blank if no logging required
- SSL Verify: Yes/No
- Campus List: List of country codes available in campus i.e. U, C, M
- The assessment and enrolment feeds use this list to sync campuses specific data. All other feeds get all data.
- Validate Schema: Yes/No
- Enable Assessment syncing: Yes/No
- Enable Course syncing: Yes/No
- Enable Faculty syncing: Yes/No
- Enable Enrolment syncing: Yes/No
- Enable Module syncing: Yes/No
- Enable Gradebook: Yes/No
- Gradebook file location: shared file system location for external system to pick up
- Gradebook md5: Yes/No - write an md5 of the file contents in the file name to help external system verify files changes
- Active Modules Only: Yes/No. Only sync enrolments to modules active in Rogo. If enabeld the enrolment feed processing time will be reduced.
- Enable Delete Modules: Yes/No. Enabled/Disable deletion of modules during module sync.
- Lock File Lifespan: Lifespan of process lock files (in hours)
- Target module enrolments: Yes/No. Enable targeted enrolment sync rather than syncing all modules. At the cost of additional API calls to the SMS.
Changes to the UI
If enabled the following changes are applied to Rogo.
- A new sync button will appear on the courses list screen.
2. A new sync button will appear on the modules list screen. From Rogo 7.1 this will only be when a module is selected.
3. A new sync button will appear on the faculties list screen. This will sync both faculties and schools.
4. A new sync button will appear on the summative exam scheduling screen
Scheduled jobs
The scripts located in the cron directory of the plugin can be used as scheduled jobs. Scripts are provided for the following jobs:
- Publish Gradebook
- Sync All (all of the below)
- Sync Faculties and Schools
- Sync Courses
- Sync Modules
- Sync Enrolments
- Sync Assessments
Enrolment Mappings
Campus Solutions user status codes map to the following within Rogo:
Campus Code | Campus Description | Rogo Mapping |
---|---|---|
AC | Active in Program | Student |
AD | Admitted* | Suspended |
AP | Applicant* | Suspended |
CM | Completed Program | Left |
CN | Cancelled | Graduate |
DC | Discontinued | Left |
DE | Deceased | Left |
DM | Dismissed | Left |
LA | Leave of Absence | Suspended |
PM | Prematriculant* | Suspended |
SP | Suspended | Suspended |
WT | Waitlisted* | Suspended |
*should not be sent to rogo so deafults to suspended