7. External System Integration

LDAP Authentication

All authentication is initially conducted with an internal authentication data store held within Rogō. The main reasons for using an encyrpted local data source are:

Maximise resiliance - an exam can continue without interuption even if the connection is lost to the LDAP server.
Network traffic is minimised to the LDAP server especially in large summative exams.
The local authentication can be extended to include uses such as External Examiners who may not have LDAP details.

Every page is initially authenticated locally and only if the data does not match does it do a second LDAP lookup. If the LDAP lookup is successful then the password is stored locally (encrypted).

LDAP configuration settings can be found in /config/config.inc.

Importing Student Records

Generic XML web feed

Rogo can take an XML web feed from a student management system (SMS). The SMS should output a feed in the following format:

<?xml version="1.0" encoding="utf-8"?>
<ModuleEnrolments xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Module>
    <Campus>uk</Campus>
    <ModuleCode>TEST1</ModuleCode>
    <Year>2011</Year>
    <ModuleTitle>Test Module Title</ModuleTitle>
    <Membership>
      <Student>
        <StudentID>123456789</StudentID>
        <Title>Mr</Title>
        <Forename>Bilbo</Forename>
        <Surname>Baggins</Surname>
        <Username>bbaggins</Username>
        <Email>bbaggins@university.ac.uk</Email>
        <YearofStudy>1</YearofStudy>
        <Faculty>Faculty of Humanities</Faculty>
        <CourseCode>H001</CourseCode>
        <CourseTitle>BA Hobbit Studies</CourseTitle>
        <Gender>Male</Gender>
        <ReasonForLeaving>N/A</ReasonForLeaving>
      </Student>
    </Membership>
  </Module>
</ModuleEnrolments>

Campus Solutions

Pleae see the plugin page - plugin_cs_sms.

Rogo API

Old style User Account Creation

The above student enrolment feed will create Rogo accounts for students where necessary. However, there may be times when it is useful to create staff accounts automatically when making other accounts. For example, it could be useful to enrole a lecturer on Moodle and Rogo in one action.

https://<<your host name>>/webServices/createAccount

<?xml version="1.0" encoding="UTF-8"?>
  <user>
    <course>University Lecturer</course>
    <title>Mr</title>
    <firstnames>Gandalf</firstnames>
    <surname>Greyhame</surname>
    <username>ggreyhame</username>
    <password>shs89fhh3k27dj23</password>
    <email>gandalf.greyhame@university.ac.uk</email>
    <studentid></studentid>
    <roles>Staff</roles>
    <yearofstudy>1</yearofstudy>
    <gender>male</gender>
  </user>

Notes

Only users with SysAdmin rights can create accounts.
Staff accounts should have <course> set to 'University Lecturer'. Studentid can be left blank for staff.

Old style Exporting Paper List by Staff

When integrating with a VLE it can be useful to obtain a list of papers that the current member of staff is allowed to link to.

https://<<your host name>>/webServices/getOwnerPaperList/<<staff username>>
https://<<your host name>>/webServices/getOwnerPaperList/<<staff username>>/formative
https://<<your host name>>/webServices/getOwnerPaperList/<<staff username>>/progresstest
https://<<your host name>>/webServices/getOwnerPaperList/<<staff username>>/summative
https://<<your host name>>/webServices/getOwnerPaperList/<<staff username>>/osce
https://<<your host name>>/webServices/getOwnerPaperList/<<staff username>>/offline
https://<<your host name>>/webServices/getOwnerPaperList/<<staff username>>/notsummative

Old tyle Learning Objectives

Rogo uses a REST API to transfer learning objectives between systems and to advertise available feedback to other systems. All REST requests require authentication to be provided using HTTP Basic Authentication (this is possible from php using curl). You can export a students feedback reports with the following web service:

https://<<your host name>>/webServices/getAvailableFeedback

New API

Please see the API page - API, for detailed information on the new API methodology.