From 065d31252641e593792480a69cf4f35f66d36e31 Mon Sep 17 00:00:00 2001 From: Heiko Bernloehr Date: Tue, 20 May 2014 14:40:20 +0200 Subject: [PATCH] Generalization of names and some improvements. --- Makefile | 2 +- ...tus.schema.json => cc_member_status.schema.json | 6 +-- enrolment_status.tex => member_status.tex | 55 ++++++++++++++-------- 3 files changed, 40 insertions(+), 23 deletions(-) rename cc_enrolment_status.schema.json => cc_member_status.schema.json (72%) rename enrolment_status.tex => member_status.tex (81%) diff --git a/Makefile b/Makefile index ee23b0d..ec28290 100644 --- a/Makefile +++ b/Makefile @@ -60,7 +60,7 @@ $(addsuffix .eps, $(basename $(UXF_FILES))):%.eps:%.uxf gitHeadInfo.gin: ./generate_gitinfo.sh -$(DVI_FILES):%.dvi:%.tex $(addsuffix .eps, $(basename $(PIC_FILES))) $(addsuffix .eps, $(basename $(FIG_FILES))) $(addsuffix .eps, $(basename $(UXF_FILES))) gitHeadInfo.gin cc_enrolment_status.schema.json +$(DVI_FILES):%.dvi:%.tex $(addsuffix .eps, $(basename $(PIC_FILES))) $(addsuffix .eps, $(basename $(FIG_FILES))) $(addsuffix .eps, $(basename $(UXF_FILES))) gitHeadInfo.gin cc_member_status.schema.json echo $(VERSION) | latex $< echo $(VERSION) | latex $< diff --git a/cc_enrolment_status.schema.json b/cc_member_status.schema.json similarity index 72% rename from cc_enrolment_status.schema.json rename to cc_member_status.schema.json index af695e0..f107bea 100644 --- a/cc_enrolment_status.schema.json +++ b/cc_member_status.schema.json @@ -3,10 +3,10 @@ "description":"Data schema for JSON representation of CampusConnect enrolmnt_status resource", "type":"object", "properties": { - "courseURL": { "type":"string", "required":true, "format":"uri" }, - "externalCourseID": { "type":"string", "required":false }, + "url": { "type":"string", "required":true, "format":"uri" }, + "id": { "type":"string", "required":false }, "personID": { "type":"string", "required":true }, - "personIDtype": { "enum": [ "ecs_PersonalUniqueCode", "ecs_eppn", "ecs_login", "ecs_loginUID", "ecs_uid", "ecs_email", "generic1", "generic2", "generic3" ], "required":true }, + "personIDtype": { "enum": [ "ecs_PersonalUniqueCode", "ecs_ePPN", "ecs_login", "ecs_loginUID", "ecs_uid", "ecs_email", "generic1", "generic2", "generic3" ], "required":true }, "status": { "enum": [ "active", "pending", "denied", "rejected", "unsubscribed", "account_deactivated" ], "required":true } }, "additionalProperties" : false diff --git a/enrolment_status.tex b/member_status.tex similarity index 81% rename from enrolment_status.tex rename to member_status.tex index 41ff503..c0fafb5 100644 --- a/enrolment_status.tex +++ b/member_status.tex @@ -39,6 +39,7 @@ \newcommand{\ecs}{ECS} \newcommand{\ilias}{ILIAS} \newcommand{\cces}{\texttt{cc/enrolment\_status\ }} +\newcommand{\ccms}{\texttt{cc/member\_status\ }} \newcommand{\button}[1]{\fbox{\texttt{#1}}} \newcommand{\jsToAppletComUrlA}{\mbox{http://stackoverflow.com/questions/7278626/javascript-to-java-applet-communication}} \newcommand{\jsToAppletComUrlB}{\mbox{http://docs.oracle.com/javase/tutorial/deployment/applet/invokingAppletMethodsFromJavaScript.html}} @@ -57,7 +58,7 @@ \linenumbers \begin{document} -\title{Mahara/Moodle enrolment status} +\title{Mahara/Moodle member status} \author{David Boehringer\\Universit\"at Stuttgart \and Heiko Bernl\"ohr\\FreeIT.de} \maketitle \thispagestyle{empty} @@ -71,6 +72,15 @@ New ECS resource providing enrolment status for users enroled to external courses (via courselinks). The course providing participant (e.g. Moodle) informs the courselink providing participant of the subscribed user (e.g. Mahara) about every change of its enrolment status in the course. +This paper only concerns about informing a courselink providing system about +status changes of their users consuming a course on a course providing system. +As Stefan Meyer (ILIAS, Leifos) has noticed, this resource could also be used +to inform about status of some more resources, e.g. ILIAS groups. In order to +respect this we have generalized our naming of the resource name from \cces to +\ccms and also the used attribute names. But all other details, especially the +sequence diagrams and state chart only focus on courselinks and courses. +Further we use Mahara as a courselink and Moodle as a course providing system. +Of course these systems could be substituded by other system types. \end{abstract} %\vspace{\fill} @@ -81,9 +91,9 @@ Moodle) informs the courselink providing participant of the subscribed user % \newpage -\section{Enrolment status} +\section{Member status} -The \cces resource describes an enrolment status of a +The \ccms resource describes an enrolment status of a remotly subscribed user (via courselinks) to a course. This document supersedes the part \begin{quote} @@ -126,7 +136,7 @@ Moodle has to send the user enrolment status to Mahara on these events: \item[enable subscription] User is enabled by course or system administrator, i.e. he is to be allowed to access course again.\\ \rstat{active} - \item[delete user account] User account on remote system is deleted. \cces + \item[delete user account] User account on remote system is deleted. \ccms has to be sent for all of the user's course memberships.\\ \rstat{unsubscribed} \item[deactivate user account] User account on remote system is deactivated.\\ @@ -177,7 +187,7 @@ have to enhance our specs in \cite{specRedirectProcedure} and \cite{specHashCumputing}. This still needs to be done. \begin{figure}[p] - \includegraphics[scale=0.8]{enrolment_status_seq} + \vspace*{-1cm}\includegraphics[scale=0.8]{enrolment_status_seq} \caption{\label{seq:initialEnrolmentStatus}Sending enrolment status after consuming a courselink for the first time. For \textit{params} in the \textit{redirect} of the \textit{consume courselink} block see @@ -203,34 +213,39 @@ have to enhance our specs in \cite{specRedirectProcedure} and \subsection{Resource attributes} -For the json schema of \cces see page \pageref{schema:enrolment_status}. -Following description write on \cces resource attributes for which a user +For the json schema of \ccms see page \pageref{schema:member_status}. +Following description write on \ccms resource attributes for which a user status has changed or asked for: \begin{description} - \item[courseURL] It's a url transfering a courselink consuming user - directly to the course on the course providing system. It's also used as a + \item[url] It's a url transfering a courselink consuming user + directly to the course on the course providing system. It could be used as a unique id. - \item[courseID] It's a unique course id on the course providing system. It - references the same course as \texttt{courseURL}. + \item[id] It's a unique course id on the course providing system. It + references the same course as \texttt{url}. It could be used as a unique id. \item[personID] Unique id of the course consuming user. \item[personIDtype] Class/type of \texttt{personID}. It's a controlled - vocabulary (see page \pageref{schema:enrolment_status} for possible + vocabulary (see page \pageref{schema:member_status} for possible values). \item[status] Status of the user's course enrolment. It's a controlled vocabulary (for possible values see schema on page - \pageref{schema:enrolment_status} and values descriptions at + \pageref{schema:member_status} and values descriptions at \ref{statusValues}). \end{description} \subsection{PersonID types} \begin{description} - \item[ecs\_PersonalUniqueCode] SchacPersonalUniqueCode (matriculation number). - \item[ecs\_login] Login name on course providing system. - \item[ecs\_uid] Internal user id on course providing system. + \item[ecs\_ePPN] EduPersonPrincipalName as defined in \cite{eppn} \item[ecs\_loginUID] Organization wide user id (uid in university context). + Usually this would be the string in front of the `@' of the ePPN. + \item[ecs\_login] Login name on course providing system (e.g. LMS). Only unique only + in connection with the LMS. + \item[ecs\_uid] Internal user id on course providing system (e.g. LMS). Only unique only + in connection with the LMS. \item[ecs\_email] Email address. - \item[ecs\_eppn] EduPersonPrincipalName. + \item[ecs\_PersonalUniqueCode] SchacPersonalUniqueCode (matriculation number) + as defined in \cite{SchacPersonalUniqueCode}. Should be used as values in + order to be internationally compatible. \end{description} Across institutions a person identifying attribute should be used that is also @@ -247,15 +262,17 @@ needed for eduGAIN compatibility of an LMS it is recommended that this is included in the core of the system and not as part of a plugin. \begin{sidewaysfigure}[p] - \includecode{cc_enrolment_status.schema.json} + \includecode{cc_member_status.schema.json} \caption{JSON-Schema definition of enrolment\_status resource} - \label{schema:enrolment_status} + \label{schema:member_status} \end{sidewaysfigure} \begin{thebibliography}{99} \bibitem{specRedirectProcedure} \url{http://freeit.de/documents/ecsa/index.html#_redirect_procedure_protocol_when_consuming_courselinks} \bibitem{specHashCumputing} \url{http://freeit.de/documents/ecsa/index.html#_courselinks} \bibitem{specBoehMaharaMoodle} David Boehringer. \textit{Mahara and Moodle Specification Version 03} +\bibitem{eppn} \url{http://middleware.internet2.edu/eduperson/} +\bibitem{SchacPersonalUniqueCode} \url{http://www.terena.org/activities/tf-emc2/schacreleases.html} \end{thebibliography} \end{document} -- 2.11.4.GIT