https://docs.moodle.org/32/en/api.php?action=feedcontributions&feedformat=atom&user=Moquist 2026-04-11T00:18:56Z User contributions MediaWiki 1.43.5 https://docs.moodle.org/32/en/index.php?title=TeX_notation_filter&diff=64725 2009-10-27T15:43:48Z

<p>Moquist: /* Installing the binaries */</p> <hr /> <div>Location: TeX Notation settings link in ''Administration &gt; Modules &gt; Filters &gt; Manage filters''<br /> <br /> <br /> The TeX Filter converts TeX code into GIF images. It uses a binary program(s) on the server to render the images (either the full LaTeX implementation, in Moodle 1.6 or later, or the [[MimeTeX]] binary that ships with Moodle for various platforms). Versions of MimeTex for Linux (glib2.3), Windows, Mac OS X and FreeBSD are included in the Moodle distribution. <br /> <br /> No additional software or plugins are required on the client computers to display the images.<br /> <br /> <br /> === Introduction - A Tale of Two Filters ===<br /> <br /> To avoid confusion you should note that on all newer versions of Moodle, the TeX filter has two separate methods for converting the TeX notation to images. The preferred method is a collection of three binaries that you are responsible for installing and configuring on your server. The filter settings page relates entirely to this method. If this fails for any reason the filter will fall back to a single binary - mimetex - that is included with Moodle. A number of different builds are included for popular operating systems. <br /> <br /> === Usage ===<br /> <br /> To use the filter the resource should include a TeX expression delimited by double-dollar signs. Example:<br /> <br /> $$ \sqrt{x + y} $$<br /> <br /> === Using MimeTeX ===<br /> <br /> MimeTeX is a number of pre-built binaries that are included in the Moodle standard distribution and are located in the filters/tex directory. There are a number of different versions for different operating systems. The TeX filter picks the appropriate binary for the detected host operating system (you will need to hack the script if your operating system is not included). Note that your web server needs to be set up with appropriate permissions for running binaries in that location. This appears to be particularly problematic on the Windows platform. See the [http://moodle.org/mod/forum/view.php?id=752 Mathematical Tools Forum] for more information.<br /> <br /> If you are using the '''windows installer package''', type something like this into the box called 'path of ''latex'' binary'<br /> &quot;C:\Moodle_webserver\moodle\filter\tex\mimetex.exe&quot; <br /> Where you replace 'Moodle_webserver' with the real path to your moodle install. Note that on windows, the red x to the right of the input box will never go away, even when the details are correct.<br /> <br /> If you use TeX in a GIFT question import file you must escape { } and = (even # and ~) with a \ before each symbol.<br /> <br /> === Improvements in 1.6 ===<br /> <br /> Moodle 1.6 adds the ability to use the full TeX formatting facilities (MimeTex only provides a subset). Three external binaries are used to render the images which may need setting up for your system. The filter will first check for a LaTeX renderer (Ghostscript is also required for this method, ImageMagick in the case of Linux) and failing that will use the simpler [[MimeTeX]] binary included in the Moodle distribution. LaTex permits the whole range of syntax, whereas [[MimeTeX]] only supports a mathematical subset.<br /> <br /> === Settings Page ===<br /> <br /> The TeX filter settings page are primarily intended to adjust the operation of the LaTeX renderer. The defaults for the three path settings are selected according to the detection of the operating system on which Moodle is running. These are simply suggested common values - Moodle does not check that the binaries actually exist at these locations. Later versions of Moodle show a green tick or a red cross next to the path setting - this shows that the binary exists at that location (only). The settings have no effect on the operation of the MimeTex binary (used if any of these binaries are not found).<br /> <br /> ==== Installing the binaries ====<br /> <br /> This depends on your platform, but for a typical Linux install you are going to need a latex implementation (e.g. tetex) and the convert binary (e.g, from ImageMagick). A typical command - in this case for Ubuntu - that installs everything you need would look something like:<br /> <br /> apt-get install tetex-base tetex-bin tetex-extra imagemagick ghostscript<br /> <br /> You may need to experiment a bit (for example, ImageMagick doesn't seem to work properly on Solaris gut Ghostscript does). If you find the combination that works for your system kindly add the info to this page!<br /> <br /> ==== LaTeX preamble ====<br /> <br /> Enables the LaTeX preamble to be specified. The default should work for most users, but you may need to change it to support non-latin character sets etc. Please see the LaTeX documentation for further details.<br /> <br /> ==== Transparent colour ====<br /> <br /> This should be set to your normal text background colour. The default setting is #FFFFFF (i.e., white). <br /> <br /> ==== Density ====<br /> <br /> This setting effects the size of the resulting image.<br /> <br /> ==== Path of ''latex'' binary ====<br /> <br /> Path to standard latex binary.<br /> <br /> On a MacOS X, the path is &quot;/usr/texbin/&quot;.<br /> <br /> ==== Path of ''dvips'' binary ====<br /> <br /> Path to standard dvips binary - generally distributed as part of a LaTeX system.<br /> <br /> On a MacOS X, the path is &quot;/usr/texbin/&quot;.<br /> <br /> ==== Path of ''convert'' binary ====<br /> <br /> Path to standard convert binary. This is distributed as part of the Ghostscript system, or ImageMagick in Linux.<br /> <br /> A simple check is made to establish if the binaries exist at the given paths. A tick or a cross is displayed alongside each as a result. Note that this does not check that the application actually works, just that it is there.<br /> <br /> On a MacOS X, the path is &quot;/usr/local/bin/&quot;.<br /> <br /> === Debugging TeX filter ===<br /> <br /> The TeX filter has a debugging script included that should help if you are having problems. The URL will be as follows...<br /> <br /> http://your.moodle.path/filter/tex/texdebug.php<br /> <br /> You can either enter this path explicitly or with appropriate role permissions the TeX images (or more likely incorrectly rendered text, if you need debugging) will link to this. There are a number of options and suggestions to facilitate debugging the filter. Note that options for the latex/ghostscript versions are only provided from Moodle version 1.8.3.<br /> <br /> <br /> === Mimetex on Debian based systems ===<br /> <br /> For some reason, the mimetex file that comes with Moodle doesn't work on Debian based systems (like Debian, Ubuntu, ...).<br /> What works is installing Mimetex and Ghostscript on your server as Debian package (needs to be executed as root):<br /> <br /> apt-get install tetex-extra mimetex gs<br /> <br /> Move your old mimetex file away<br /> <br /> mv /var/www/moodle/filter/tex/mimetex.linux /var/www/moodle/filter/tex/mimetex.linux.old <br /> <br /> Make a symbolic link to the mimetex file, installed by the debian installer<br /> <br /> ln -s /usr/bin/mimetex /var/www/moodle/filter/tex/mimetex.linux<br /> <br /> == See also ==<br /> <br /> * [[Filters]]<br /> * [http://moodle.org/mod/glossary/view.php?id=2739&amp;mode=letter&amp;hook=M&amp;sortkey=CREATION&amp;sortorder=asc TeX Filter Glossary] - a [[Glossary|glossary]] you can add to your course which details usage of the supported [[TeX notation]].<br /> * [http://www.latex-project.org/ LaTeX] - the LaTeX document preparation system.<br /> * [http://www.ghostscript.com/ ghostscript] - required to render the image<br /> * [http://www.forkosh.com/mimetex.html mimetex] - generates mathematical expressions<br /> * [http://www.miktex.org/ MikTeX] - LaTeX for Windows systems<br /> <br /> [[Category:Filter]]<br /> [[Category:Mathematics]]</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:Czech_Hackfest_2009&diff=63666 2009-09-30T05:26:47Z

<p>Moquist: /* Attendees and arrivals */</p> <hr /> <div>Work in progress here - do not rely on this yet.<br /> <br /> == Programme ==<br /> <br /> ; Saturday 5th December 2009 :<br /> <br /> * Meet each others in Prague (some arrive, some may be there already)<br /> * Settle down in a hotel - probably [http://www.andelshotel.com] or [http://www.angelohotel.com] (we are discussing with them to get some sale, do not book anything yet).<br /> * Explore Prague (Castle etc)<br /> * Social beer event<br /> <br /> ; Sunday 6th December 2009 :<br /> * Leaving Prague together by a rented micro-bus (about 120 mins)<br /> * Lunch at [http://www.jested.cz Jested, Liberec].<br /> * Moving to the mountains (by bus or car or foot ;-), according to snow conditions)<br /> * Accommodating at [http://www.dudovi.cz/jizerka/eng/ubytovani.htm Jizerka]<br /> <br /> ; Monday 7th December 2009<br /> * Moodle 2.0 release planning<br /> * Triage of remaining bugs (assign developers, priorities)<br /> * Bug sprint<br /> <br /> ; Tuesday 8th December 2009<br /> * Moodle 2.x planning<br /> * Creating detailed roadmap for all modules based on tracker<br /> <br /> ; Wednesday 9th December 2009<br /> * Moodle 3.0 brainstorming and planning<br /> * Moodle 2.0 bugs<br /> <br /> ; Thursday 10th December 2009<br /> * Moodle 2.0 bugs<br /> * Skiiing?<br /> <br /> ; Friday 11th December 2009 <br /> * moving back to Prague on Friday<br /> * more Prague sightseeing<br /> * Settle down in a hotel - probably again [http://www.andelshotel.com] or [http://www.angelohotel.com] (we are discussing with them to get some sale, do not book anything yet).<br /> * official end of hackfest<br /> <br /> == Attendees and arrivals ==<br /> <br /> Maximum of 16 places, so far we have (in chaotic order):<br /> <br /> # Martin Dougiamas<br /> # Eloy Lafuente<br /> # Petr Skoda<br /> # Tim Hunt<br /> # Helen Foster<br /> # Penny Leach<br /> # Dan Poltawski<br /> # David Mudrak<br /> # Shane Elliott<br /> # Chris Roy<br /> # Brian King<br /> # Daniele Cordella<br /> # Mike Churchward<br /> # Hubert Chathi<br /> # Matt Oquist<br /> # ?<br /> <br /> == Suggestions ==<br /> <br /> I wanted to add some ideas of things we could talk about, and for some reason I did not want to use the talk page so I am adding them here. These are just ideas. Take them or leave them.<br /> <br /> ===What is the balance between Yack and Hack?===<br /> <br /> That is, how much time will we be talking, and how much time writing code on our laptops?--[[User:Tim Hunt|Tim Hunt]] 09:41, 8 August 2009 (UTC)<br /> <br /> ===Planning specific bits of the post 2.0-roadmap===<br /> <br /> The main thing is that we keep talking about how recent released, especially 2.0, have had a lot of under the hood changes and that we really need to do some work on the actual activities themselves. I was wonder if if we should have a section of time allocated to what we consider the most important modules (or other things like the gradebook/filepicker/backup).<br /> <br /> In order to have meaningful discussion, I suggest that in advanced of the hackfest, each participant is assigned (or volunteers for) one of those bit. They are then expected to read every open bug and feature request for that component, and spend some time following the associated forum, and come up with a summary of what the most pressing issues there seem to be. Then at the hackfest they would lead that discussion section, kicking off by explaining to the rest of us what they learned during their research.<br /> <br /> Naturally, if we do this, I volunteer for the quiz and question bank. Of course, I already have a pretty good idea what is going on there. I guess this would probably be more work if people had to look at an area they had not thought about before, so that is not fair.--[[User:Tim Hunt|Tim Hunt]] ~10:00, 6 August 2009 (UTC)<br /> <br /> : +1. Naturally, I volunteer for Workshop, given that the Tim's last sentence applies for my case, too. --[[User:David Mudrak|David Mudrak]] 10:51, 7 August 2009 (UTC)<br /> <br /> ===How about a work-on-2.0 day===<br /> <br /> The aim would be that by the end of the day, we have fixed as many of the Fix-for 2.0 bugs as possible, and also have reviewed all the ones that we cannot fix immediately, so we end up with a really good, triaged bug-list of what is left to be done. By the end of the day, all the bugs should be assigned to someone who feels confident they will be able to fix it.--[[User:Tim Hunt|Tim Hunt]] 09:41, 8 August 2009 (UTC) and Dan Poltawski. We discussed this at the GBBF last night.<br /> <br /> ==='Prepared' Bug Squashing===<br /> <br /> Basically the same as the above suggestion, but I want to emphasise some preperation beforehand so that we can get to the real unsolved issues which would benefit with us all being in the same room and discussing solutions.<br /> <br /> <br /> With each bug we triage before the hackfest, we should try to:<br /> * a) Link or close issues which have been fixed, or will be fixed by 2.0 (etc)<br /> * b) Document unsolved issues which we need discussion or a plan to be fixed ('''this is most important for the hackfest itself''')<br /> * c) Document bugs which could be fixed with a little time (at the hackfest or later)<br /> * d) Document bugs to pester someone else about ;-)<br /> <br /> Depending on how much time you can devote, I suggest trying these triaging views in order:<br /> * 1) Reviewing all open bugs reported by yourself, starting oldest first.<br /> * 2) Reviewing your assigned issues, starting with oldest first <br /> * 3) Reviewing 'nobody' or 'imported' bugs starting with the oldest first.<br /> etc..<br /> <br /> There is a lot of old cruft in the tracker. Many of the issues have or will be fixed soon, so we could do a lot by just looking at our own issues and setting the status/links appropiately. For all the others, some are just without a decided solution - these would be great ones to at least think about discussing. --[[User:Dan Poltawski|Dan Poltawski]] 17:28, 15 August 2009 (UTC)</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:Czech_Hackfest_2009&diff=63036 2009-09-15T18:06:49Z

<p>Moquist: /* Attendees and arrivals */</p> <hr /> <div>Work in progress here - do not rely on this yet.<br /> <br /> == Programme ==<br /> <br /> ; Saturday 5th December 2009 :<br /> <br /> * Meet each others in Prague (some arrive, some may be there already)<br /> * Settle down in a hotel - probably [http://www.andelshotel.com] or [http://www.angelohotel.com] (we are discussing with them to get some sale, do not book anything yet).<br /> * Explore Prague (Castle etc)<br /> * Social beer event<br /> <br /> ; Sunday 6th December 2009 :<br /> * Leaving Prague together by a rented micro-bus (about 120 mins)<br /> * Lunch at [http://www.jested.cz Jested, Liberec].<br /> * Moving to the mountains (by bus or car or foot ;-), according to snow conditions)<br /> * Accommodating at [http://www.dudovi.cz/jizerka/eng/ubytovani.htm Jizerka]<br /> <br /> ; Monday 7th December 2009<br /> * Moodle 2.0 release planning<br /> * Triage of remaining bugs (assign developers, priorities)<br /> * Bug sprint<br /> <br /> ; Tuesday 8th December 2009<br /> * Moodle 2.x planning<br /> * Creating detailed roadmap for all modules based on tracker<br /> <br /> ; Wednesday 9th December 2009<br /> * Moodle 3.0 brainstorming and planning<br /> * Moodle 2.0 bugs<br /> <br /> ; Thursday 10th December 2009<br /> * Moodle 2.0 bugs<br /> * Skiiing?<br /> <br /> ; Friday 11th December 2009 <br /> * moving back to Prague on Friday<br /> * more Prague sightseeing<br /> * Settle down in a hotel - probably again [http://www.andelshotel.com] or [http://www.angelohotel.com] (we are discussing with them to get some sale, do not book anything yet).<br /> * official end of hackfest<br /> <br /> == Attendees and arrivals ==<br /> <br /> Maximum of 16 places, so far we have (in chaotic order):<br /> <br /> # Martin Dougiamas<br /> # Eloy Lafuente<br /> # Petr Skoda<br /> # Tim Hunt<br /> # Helen Foster<br /> # Penny Leach<br /> # Dan Poltawski<br /> # David Mudrak<br /> # Shane Elliott<br /> # Chris Roy<br /> # Brian King (TBC)<br /> # Daniele Cordella (TBC)<br /> # Mike Churchward (TBC)<br /> # Hubert Chathi or Justin Filip (TBC)<br /> # Iñaki Arenaza (TBC)<br /> # Matt Oquist (TBC)<br /> <br /> == Suggestions ==<br /> <br /> I wanted to add some ideas of things we could talk about, and for some reason I did not want to use the talk page so I am adding them here. These are just ideas. Take them or leave them.<br /> <br /> ===What is the balance between Yack and Hack?===<br /> <br /> That is, how much time will we be talking, and how much time writing code on our laptops?--[[User:Tim Hunt|Tim Hunt]] 09:41, 8 August 2009 (UTC)<br /> <br /> ===Planning specific bits of the post 2.0-roadmap===<br /> <br /> The main thing is that we keep talking about how recent released, especially 2.0, have had a lot of under the hood changes and that we really need to do some work on the actual activities themselves. I was wonder if if we should have a section of time allocated to what we consider the most important modules (or other things like the gradebook/filepicker/backup).<br /> <br /> In order to have meaningful discussion, I suggest that in advanced of the hackfest, each participant is assigned (or volunteers for) one of those bit. They are then expected to read every open bug and feature request for that component, and spend some time following the associated forum, and come up with a summary of what the most pressing issues there seem to be. Then at the hackfest they would lead that discussion section, kicking off by explaining to the rest of us what they learned during their research.<br /> <br /> Naturally, if we do this, I volunteer for the quiz and question bank. Of course, I already have a pretty good idea what is going on there. I guess this would probably be more work if people had to look at an area they had not thought about before, so that is not fair.--[[User:Tim Hunt|Tim Hunt]] ~10:00, 6 August 2009 (UTC)<br /> <br /> : +1. Naturally, I volunteer for Workshop, given that the Tim's last sentence applies for my case, too. --[[User:David Mudrak|David Mudrak]] 10:51, 7 August 2009 (UTC)<br /> <br /> ===How about a work-on-2.0 day===<br /> <br /> The aim would be that by the end of the day, we have fixed as many of the Fix-for 2.0 bugs as possible, and also have reviewed all the ones that we cannot fix immediately, so we end up with a really good, triaged bug-list of what is left to be done. By the end of the day, all the bugs should be assigned to someone who feels confident they will be able to fix it.--[[User:Tim Hunt|Tim Hunt]] 09:41, 8 August 2009 (UTC) and Dan Poltawski. We discussed this at the GBBF last night.<br /> <br /> ==='Prepared' Bug Squashing===<br /> <br /> Basically the same as the above suggestion, but I want to emphasise some preperation beforehand so that we can get to the real unsolved issues which would benefit with us all being in the same room and discussing solutions.<br /> <br /> <br /> With each bug we triage before the hackfest, we should try to:<br /> * a) Link or close issues which have been fixed, or will be fixed by 2.0 (etc)<br /> * b) Document unsolved issues which we need discussion or a plan to be fixed ('''this is most important for the hackfest itself''')<br /> * c) Document bugs which could be fixed with a little time (at the hackfest or later)<br /> * d) Document bugs to pester someone else about ;-)<br /> <br /> Depending on how much time you can devote, I suggest trying these triaging views in order:<br /> * 1) Reviewing all open bugs reported by yourself, starting oldest first.<br /> * 2) Reviewing your assigned issues, starting with oldest first <br /> * 3) Reviewing 'nobody' or 'imported' bugs starting with the oldest first.<br /> etc..<br /> <br /> There is a lot of old cruft in the tracker. Many of the issues have or will be fixed soon, so we could do a lot by just looking at our own issues and setting the status/links appropiately. For all the others, some are just without a decided solution - these would be great ones to at least think about discussing. --[[User:Dan Poltawski|Dan Poltawski]] 17:28, 15 August 2009 (UTC)</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=62959 2009-09-12T21:12:27Z

<p>Moquist: /* Tasks */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]] [[Image:Patricia-checks-Susies-courses-in-SchoolTool.png|100px]] <br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]] [[Image:Scenario2.png|200px]] <br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. These assignments become integrated with SchoolTool, and grades begin transferring automatically from Moodle to SchoolTool. Grades previously entered manually into SchoolTool are unaffected.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]<br /> ## Phase 2 Part 1: Users<br /> ##:[[Image:Country-mouse1.png|300px]]<br /> ## Phase 2 Part 2: Enrollments<br /> ##:[[Image:Country-mouse2.png|300px]]<br /> ## Phase 2 Part 3: Grades<br /> ##:[[Image:Country-mouse3.png|300px]]<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Userdata.dia]]<br /> :[[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Enrollment.dia]]<br /> :[[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Grades.dia]]<br /> :[[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> When this is done, we should have much of the functionality that Moodle+Mahara currently offers. In particular, there should be a completely Web-based configuration to integrate Moodle with SchoolTool, and the result should be that all Moodle users suddenly have SchoolTool accounts as well.<br /> ====Tasks====<br /> * Moodle MNet linkage (Matt)<br /> ** UI: Make Moodle aware of SchoolTool as a potential SSO peer.<br /> ** Add new auth plugin to send info to SchoolTool and to accept SSO back from SchoolTool.<br /> ** Create spec for Brett to implement inward and outward portion of SSO in SchoolTool. Needs to answer the following questions:<br /> *** What URL will Moodle call when attempting to initiate outbound SSO?<br /> *** How will Moodle provide the authentication token to the remote system?<br /> *** What URL does Moodle expect to be called with to accept incoming SSO?<br /> *** How does Moodle expect to be given the authentication token?<br /> * Fully implemented MNet linkage and SSO between Moodle and SchoolTool (Brett)<br /> ** Ability to configure one or more Moodle systems as MNet peers within SchoolTool<br /> *** Add new peer<br /> *** View / verify peer status<br /> *** Delete peer<br /> ** After configuration, ability to perform SSO login from SchoolTool to Moodle<br /> ** After configuration, ability to accept SSO login from Moodle to SchoolTool<br /> *** Authorization to log in will be determined by SchoolTool. To prevent unwanted student logins, the default is that imported user accounts will not have login rights unless changed manually in SchoolTool<br /> ** Unit tests to cover each of the above features<br /> * SchoolTool back-end (Douglas)<br /> ** Accept new user info from any integrated Moodle that calls.<br /> *** Handle username collisions. (See Mahara &amp; Moodle.)<br /> *** Consider how user profile fields are handled.<br /> *** Remember that the client does not want Students to be able to log in. How will these logins be prevented? (See related note above in UI section.)<br /> ** Periodically ask for a full-sync with each integrated Moodle.<br /> <br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=62511 2009-09-04T16:34:09Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]] [[Image:Patricia-checks-Susies-courses-in-SchoolTool.png|100px]] <br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]] [[Image:Scenario2.png|200px]] <br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. These assignments become integrated with SchoolTool, and grades begin transferring automatically from Moodle to SchoolTool. Grades previously entered manually into SchoolTool are unaffected.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]<br /> ## Phase 2 Part 1: Users<br /> ##:[[Image:Country-mouse1.png|300px]]<br /> ## Phase 2 Part 2: Enrollments<br /> ##:[[Image:Country-mouse2.png|300px]]<br /> ## Phase 2 Part 3: Grades<br /> ##:[[Image:Country-mouse3.png|300px]]<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Userdata.dia]]<br /> :[[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Enrollment.dia]]<br /> :[[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Grades.dia]]<br /> :[[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> When this is done, we should have much of the functionality that Moodle+Mahara currently offers. In particular, there should be a completely Web-based configuration to integrate Moodle with SchoolTool, and the result should be that all Moodle users suddenly have SchoolTool accounts as well.<br /> ====Tasks====<br /> * Moodle (Matt)<br /> ** UI: Make Moodle aware of SchoolTool as a potential SSO peer.<br /> ** Add new auth plugin to send info to SchoolTool and to accept SSO back from SchoolTool.<br /> ** Create spec for Brett to implement inward and outward portion of SSO in SchoolTool. Needs to answer the following questions:<br /> *** What URL will Moodle call when attempting to initiate outbound SSO?<br /> *** How will Moodle provide the authentication token to the remote system?<br /> *** What URL does Moodle expect to be called with to accept incoming SSO?<br /> *** How does Moodle expect to be given the authentication token?<br /> * Fully implemented MNet linkage and SSO between Moodle and SchoolTool (Brett)<br /> ** Ability to configure one or more Moodle systems as MNet peers within SchoolTool<br /> *** Add new peer<br /> *** View / verify peer status<br /> *** Delete peer<br /> ** After configuration, ability to perform SSO login from SchoolTool to Moodle<br /> ** After configuration, ability to accept SSO login from Moodle to SchoolTool<br /> *** Authorization to log in will be determined by SchoolTool. To prevent unwanted student logins, the default is that imported user accounts will not have login rights unless changed manually in SchoolTool<br /> ** Unit tests to cover each of the above features<br /> * SchoolTool back-end (Douglas)<br /> ** Accept new user info from any integrated Moodle that calls.<br /> *** Handle username collisions. (See Mahara &amp; Moodle.)<br /> *** Consider how user profile fields are handled.<br /> *** Remember that the client does not want Students to be able to log in. How will these logins be prevented? (See related note above in UI section.)<br /> ** Periodically ask for a full-sync with each integrated Moodle.<br /> <br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=62173 2009-08-28T03:54:05Z

<p>Moquist: /* Tasks */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]<br /> ## Phase 2 Part 1: Users<br /> ##:[[Image:Country-mouse1.png|300px]]<br /> ## Phase 2 Part 2: Enrollments<br /> ##:[[Image:Country-mouse2.png|300px]]<br /> ## Phase 2 Part 3: Grades<br /> ##:[[Image:Country-mouse3.png|300px]]<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Userdata.dia]]<br /> :[[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Enrollment.dia]]<br /> :[[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Grades.dia]]<br /> :[[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> When this is done, we should have much of the functionality that Moodle+Mahara currently offers. In particular, there should be a completely Web-based configuration to integrate Moodle with SchoolTool, and the result should be that all Moodle users suddenly have SchoolTool accounts as well.<br /> ====Tasks====<br /> * Moodle (Matt)<br /> ** UI: Make Moodle aware of SchoolTool as a potential SSO peer.<br /> ** Add new auth plugin to send info to SchoolTool and to accept SSO back from SchoolTool.<br /> ** Create spec for Brett to implement outward portion of SSO in SchoolTool.<br /> * SchoolTool UI+Mnet (Brett)<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration (with one or more Moodles)<br /> *** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.<br /> *** Remember that the client does not want Students to be able to log in. How will this be a configurable option? (This may not be doable until we're passing enrollments to SchoolTool, since Moodle doesn't actually distinguish between types of users (student/teacher), but merely roles in contexts.)<br /> * SchoolTool back-end (Douglas)<br /> ** Accept new user info from any integrated Moodle that calls.<br /> *** Handle username collisions. (See Mahara &amp; Moodle.)<br /> *** Consider how user profile fields are handled.<br /> *** Remember that the client does not want Students to be able to log in. How will these logins be prevented? (See related note above in UI section.)<br /> ** Periodically ask for a full-sync with each integrated Moodle.<br /> <br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=62073 2009-08-25T20:58:38Z

<p>Moquist: /* Part 1: SSO */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]<br /> ## Phase 2 Part 1: Users<br /> ##:[[Image:Country-mouse1.png|300px]]<br /> ## Phase 2 Part 2: Enrollments<br /> ##:[[Image:Country-mouse2.png|300px]]<br /> ## Phase 2 Part 3: Grades<br /> ##:[[Image:Country-mouse3.png|300px]]<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Userdata.dia]]<br /> :[[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Enrollment.dia]]<br /> :[[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> :[[Image:SchoolTool_Integration_Grades.dia]]<br /> :[[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> When this is done, we should have much of the functionality that Moodle+Mahara currently offers. In particular, there should be a completely Web-based configuration to integrate Moodle with SchoolTool, and the result should be that all Moodle users suddenly have SchoolTool accounts as well.<br /> ====Tasks====<br /> * Moodle (Matt)<br /> ** Make Moodle aware of SchoolTool as a potential SSO peer.<br /> ** Add new auth plugin to send info to SchoolTool.<br /> * SchoolTool UI+Mnet (Brett)<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration (with one or more Moodles)<br /> *** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.<br /> *** Remember that the client does not want Students to be able to log in. How will this be a configurable option? (This may not be doable until we're passing enrollments to SchoolTool, since Moodle doesn't actually distinguish between types of users (student/teacher), but merely roles in contexts.)<br /> * SchoolTool back-end (Douglas)<br /> ** Accept new user info from any integrated Moodle that calls.<br /> *** Handle username collisions. (See Mahara &amp; Moodle.)<br /> *** Consider how user profile fields are handled.<br /> *** Remember that the client does not want Students to be able to log in. How will these logins be prevented? (See related note above in UI section.)<br /> ** Periodically ask for a full-sync with each integrated Moodle.<br /> <br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=62013 2009-08-24T01:07:19Z

<p>Moquist: /* Tasks */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]<br /> ## Phase 2 Part 1: Users<br /> ##:[[Image:Country-mouse1.png|300px]]<br /> ## Phase 2 Part 2: Enrollments<br /> ##:[[Image:Country-mouse2.png|300px]]<br /> ## Phase 2 Part 3: Grades<br /> ##:[[Image:Country-mouse3.png|300px]]<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Moodle (Matt)<br /> ** Make Moodle aware of SchoolTool as a potential SSO peer.<br /> ** Add new auth plugin to send info to SchoolTool.<br /> * SchoolTool UI+Mnet (Brett)<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration (with one or more Moodles)<br /> *** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.<br /> * SchoolTool back-end (Douglas)<br /> ** Accept new user info from any integrated Moodle that calls.<br /> *** Handle username collisions. (See Mahara &amp; Moodle.)<br /> *** Consider how user profile fields are handled.<br /> ** Periodically ask for a full-sync with each integrated Moodle.<br /> <br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=62012 2009-08-24T01:05:05Z

<p>Moquist: /* Tasks */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]<br /> ## Phase 2 Part 1: Users<br /> ##:[[Image:Country-mouse1.png|300px]]<br /> ## Phase 2 Part 2: Enrollments<br /> ##:[[Image:Country-mouse2.png|300px]]<br /> ## Phase 2 Part 3: Grades<br /> ##:[[Image:Country-mouse3.png|300px]]<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Moodle (Matt)<br /> ** Make Moodle aware of SchoolTool as a potential SSO peer<br /> * SchoolTool UI+Mnet (Brett)<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration (with one or more Moodles)<br /> *** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.<br /> * SchoolTool back-end (Douglas)<br /> ** Accept new user info from any integrated Moodle that calls.<br /> ** Handle username collisions. (See Mahara &amp; Moodle.)<br /> ** Consider how user profile fields are handled.<br /> ** Periodically ask for a full-sync with each integrated Moodle.<br /> <br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=62011 2009-08-24T00:35:38Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]<br /> ## Phase 2 Part 1: Users<br /> ##:[[Image:Country-mouse1.png|300px]]<br /> ## Phase 2 Part 2: Enrollments<br /> ##:[[Image:Country-mouse2.png|300px]]<br /> ## Phase 2 Part 3: Grades<br /> ##:[[Image:Country-mouse3.png|300px]]<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse1.png&diff=62010 2009-08-24T00:34:07Z

<p>Moquist: uploaded a new version of &quot;Image:Country-mouse1.png&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse2.png&diff=62009 2009-08-24T00:33:51Z

<p>Moquist: uploaded a new version of &quot;Image:Country-mouse2.png&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse3.png&diff=62008 2009-08-24T00:33:08Z

<p>Moquist: uploaded a new version of &quot;Image:Country-mouse3.png&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse3.png&diff=62007 2009-08-23T23:56:56Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse3.dia&diff=62006 2009-08-23T23:56:41Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse2.png&diff=62005 2009-08-23T23:56:27Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse2.dia&diff=62004 2009-08-23T23:56:12Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse1.png&diff=62003 2009-08-23T23:56:02Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Country-mouse1.dia&diff=62002 2009-08-23T23:55:51Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61999 2009-08-23T23:00:28Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> ## Phase 2 Part 1: Users<br /> ## Phase 2 Part 2: Enrollments<br /> ## Phase 2 Part 3: Grades<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61998 2009-08-23T22:39:06Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]<br /> #:[[Image:Vera.png|300px]]<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Enrollment.png|200px]]<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Grades.png|200px]]<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Vera.png&diff=61997 2009-08-23T22:38:31Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Vera.dia&diff=61996 2009-08-23T22:38:16Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Samantha1.png&diff=61995 2009-08-23T22:37:56Z

<p>Moquist: uploaded a new version of &quot;Image:Samantha1.png&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Samantha1.dia&diff=61994 2009-08-23T22:37:30Z

<p>Moquist: uploaded a new version of &quot;Image:Samantha1.dia&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Samantha1.dia&diff=61845 2009-08-20T20:57:47Z

<p>Moquist: uploaded a new version of &quot;Image:Samantha1.dia&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Samantha1.png&diff=61844 2009-08-20T20:56:55Z

<p>Moquist: uploaded a new version of &quot;Image:Samantha1.png&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61636 2009-08-16T19:01:50Z

<p>Moquist: /* Terminology Disambiguation */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61632 2009-08-15T22:06:10Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> #:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> #:[[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> #:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> #:[[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> #:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> #:[[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61631 2009-08-15T22:05:32Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> #:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> #:[[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> [https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> [[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> [https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> [[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61630 2009-08-15T22:05:01Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> #:<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> [https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> [[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> [https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> [[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Samantha1.png&diff=61629 2009-08-15T22:04:34Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61628 2009-08-15T22:03:30Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> [https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> [[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> [https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]<br /> [[Image:Samantha1.png|500px]]<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Samantha1.dia&diff=61627 2009-08-15T22:02:48Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61626 2009-08-15T22:01:27Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> # Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> # Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|500px]]<br /> # Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> [https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> [[Image:Tommy-and-guinevere2.png|500px]]<br /> # Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> # Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> # Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> # Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61625 2009-08-15T21:30:49Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab, logs into Moodle, and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|500px]]<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> [https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> [[Image:Tommy-and-guinevere2.png|500px]]<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61624 2009-08-15T21:22:18Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|500px]]<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> [https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]<br /> [[Image:Tommy-and-guinevere2.png|500px]]<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Tommy-and-guinevere2.png&diff=61623 2009-08-15T21:21:43Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Tommy-and-guinevere2.dia&diff=61622 2009-08-15T21:21:01Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Tommy-and-guinevere1.dia&diff=61620 2009-08-15T17:16:49Z

<p>Moquist: uploaded a new version of &quot;Image:Tommy-and-guinevere1.dia&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61619 2009-08-15T17:15:26Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|500px]]<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Tommy-and-guinevere1.png&diff=61618 2009-08-15T17:14:55Z

<p>Moquist: uploaded a new version of &quot;Image:Tommy-and-guinevere1.png&quot;</p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61617 2009-08-15T17:12:29Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:Tommy-and-guinevere1.png|300px]]<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61616 2009-08-15T17:11:47Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> [[Image:https://docs.moodle.org/en/images_en/f/f0/Tommy-and-guinevere1.png|300px]]<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Tommy-and-guinevere1.png&diff=61615 2009-08-15T17:11:20Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61614 2009-08-15T17:10:51Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> [https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Tommy-and-guinevere1.dia&diff=61613 2009-08-15T17:10:17Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61590 2009-08-15T00:53:02Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> [[Image:Susie-and-patricia.png|300px]]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist https://docs.moodle.org/32/en/index.php?title=File:Susie-and-patricia.png&diff=61589 2009-08-15T00:51:21Z

<p>Moquist: </p> <hr /> <div></div>

Moquist https://docs.moodle.org/32/en/index.php?title=Development:SchoolTool_Integration&diff=61588 2009-08-15T00:50:59Z

<p>Moquist: /* Scenarios */</p> <hr /> <div>The [http://schooltool.org SchoolTool] SIS project recently released version 1.0, and lots of people could benefit from a solid integration between Moodle and SchoolTool. This page is a work-in-progress specification for the first version of this integration.<br /> <br /> ==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==<br /> * SchoolTool-Mahara integration should require very little extra effort when this project is complete.<br /> * SchoolTool+Moodle+Mahara will provide a complete, integrated school administration/learning/portfolio suite that will be easily installable and supportable by time-crunched education systems administrators.<br /> <br /> ==Requirements==<br /> * Completely web-based integration configuration (similar to Moodle-Mahara configuration)<br /> * SSO between SchoolTool and Moodle<br /> * User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool<br /> * Automatic grade transfer from Moodle to SchoolTool<br /> <br /> ==Integration v1.0 NON-Requirements==<br /> * Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.<br /> ** This will be the goal of the next version of the integration.<br /> <br /> ==Assumptions==<br /> * SchoolTool is the authoritative reporting application.<br /> * Moodle drives all data creation and management.<br /> <br /> ==Supported versions==<br /> * SchoolTool 1.0<br /> * Moodle 1.9.5+<br /> <br /> ==Terminology Disambiguation==<br /> * course: A SchoolTool course.<br /> ** SchoolTool &quot;course&quot; has no Moodle analogue. (&quot;Algebra 1&quot;) can have multiple &quot;sections&quot; (&quot;Algebra * 1 @ 9:15 taught by Mr. Smith&quot;).<br /> * section: A SchoolTool section, a Moodle course.<br /> <br /> ==Background info and references==<br /> * [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]<br /> * [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]<br /> <br /> ==Implementation notes/ideas==<br /> * The [http://git.catalyst.net.nz/mnet.git/ PHP mnet library] has been [https://code.edge.launchpad.net/~mnet-maintainers/mnet-wsgi/main ported to python.]<br /> ** SchoolTool will need to use this library.<br /> * Moodle will need some awareness of SchoolTool in the mnet auth plugin. Not sure yet what this entails. (i.e., Mahara shows up in the list. We need SchoolTool in there, too.)<br /> * Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.<br /> * Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.<br /> * integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.<br /> <br /> ==Use Cases==<br /> * integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.<br /> ** Accounts manually created in SchoolTool may or may not be integratable with Moodle. (Matt recommends this as a feature, but it should not be required for v1.0.)<br /> ** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.<br /> ** Enrollment can be student-driven.<br /> ** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.<br /> * future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle-&gt;SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.<br /> ** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?<br /> * Start fresh with both.<br /> * future integration version only: Drop Moodle into SchoolTool site.<br /> ** maybe not important for v1.0, might basically come for free<br /> * future integration version only: Drop SchoolTool into Mahara site (and vice-versa)<br /> '''In summary, integration v1.0 will be a Moodle-&gt;SchoolTool integration. We are laying a foundation for a future bidirectional integration in which sections are created and teachers and enrollments are managed in SchoolTool, while Moodle regularly reports grades back to SchoolTool.'''<br /> <br /> ==User Interfaces==<br /> * The integration configuration interfaces will be modeled on the existing interfaces for integrating Moodle and Mahara. See this document for a characterization of the type of admin user experience we want: [http://eduforge.org/docman/view.php/176/3200/Mahoodle.pdf Mahoodle.pdf]<br /> * Moodle UIs<br /> ** Auth plugin config<br /> ** Enrolment plugin config<br /> ** Grade export config<br /> * SchoolTool UIs<br /> ** similar division of config screens<br /> ** equivalent of Moodle's &quot;Network Servers&quot; block with links to SSO peers<br /> ** equivalent of &quot;You have logged in from &lt;somelink&gt;&quot; to go back after SSO<br /> <br /> ==Mnet==<br /> * What, in summary, does MNET provide?<br /> ** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).<br /> ** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).<br /> ** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.<br /> <br /> ===Moodle mnet Interfaces===<br /> * existing: SSO IDP interfaces<br /> ** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider<br /> ** returns user data sufficient to create account<br /> * list_user_enrolments(user)<br /> ** returns a list of all enrolments for a given user<br /> ** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()<br /> <br /> ===SchoolTool mnet Interfaces===<br /> * fetch_user(userdata)<br /> ** tell SchoolTool to ask Moodle for one user's data<br /> ** userdata: associative array such as:<br /> *** username=&gt;moquist<br /> *** firstname=&gt;Matt<br /> *** lastname=&gt;Oquist<br /> *** idnumber=&gt;1234457 # unique ID shared by Moodle &amp; SchoolTool<br /> *** email=&gt;moquist@majen.net<br /> *** password_hash=&gt;234lih23rlh2asldfjas<br /> *** password_hash_algorithm=&gt;md5<br /> *** ircnick=&gt;moquist<br /> *** arbitrary_field=&gt;arbitrary_data_string...<br /> **** SchoolTool only cares about enough to create a login account.<br /> **** SchoolTool does not care about student-editable profile fields.<br /> * new_section(sectiondata)<br /> ** sectiondata: associative array such as:<br /> *** name=&gt;&quot;Algebra 1 V1 Mrs. Smith: Cats and their Affectations&quot;<br /> *** idnumber=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** teacheridnumber=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** segment=&gt;1 # a section may have more than one semester/segment/term(?)<br /> * new_enrolment(enrolmentdata)<br /> ** create new association between user &amp; section<br /> ** enrolmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** userid=&gt;987234 # unique ID shared by Moodle &amp; SchoolTool<br /> *** role=&gt;'teacher' # only 'student' and 'teacher' supported in integration v1.0<br /> * new_assessment(assessmentdata)<br /> ** create new assessment to be displayed in grade reports<br /> ** assessmentdata: associative array such as:<br /> *** sectionid=&gt;197423 # unique ID shared by Moodle &amp; SchoolTool<br /> *** name=&gt;&quot;How to grill a logarithmic sandwich&quot;<br /> *** idnumber=&gt;73743734 # unique ID shared by Moodle &amp; SchoolTool<br /> *** chapternum=&gt;3<br /> *** honors_required=&gt;false<br /> *** nonhonors_required=&gt;true<br /> *** extra_credit=&gt;false<br /> *** pointval=&gt;68<br /> * new_grade(gradedata)<br /> ** make entry in gradebook<br /> ** gradedata: associative array such as:<br /> *** assessmentid=&gt;73743734<br /> *** userid=&gt;2347234 # unique shared ID of student<br /> *** points_earned=&gt;62<br /> *** excepted=&gt;false<br /> *** attempt_num=&gt;1 # if multiple attempts are allowed<br /> <br /> ==Phase 2==<br /> * Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].<br /> ===Scenarios===<br /> * Susie Sunglasses will return to Town High School for her senior year. During the last week of school in her junior year, she sits down in the computer lab and enrolls herself in each of the 5 courses she wishes to take during the fall semester. Moodle sends information about these enrollments to SchoolTool, and when THS principal Patricia Participle logs in to SchoolTool in July she is able to see which courses Susie will be taking in the fall.<br /> [https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]<br /> * Tommy Trackstar is a new student at Town High School. He consults immediately with guidance counselor Guinevere, who logs into Moodle and enrolls him in all his chosen courses. As Tommy completes his work and grades are given (some automatically and some manually by the teacher) in Moodle, each grade is also transferred to SchoolTool, which is thereby able to generate an up-to-date progress report for Tommy at any desired point in time (past or present).<br /> * Track season comes around, and Tommy gets too busy with practice. After careful consideration of all his available options, Tommy decides to drop Mathematics of Whistling to have an extra hour to run each day. Either he or guidance counselor Guinevere unenrolls him in Moodle from Mathematics of Whistling. The unenrollment is transferred directly to SchoolTool, and Guinevere is able to enter a note and a withdrawal code to explain what happened. This withdrawal is then included on Tommy's transcript.<br /> * Samantha Stupenda, widely rumored to be the most demanding science teacher at THS, has developed assignments for the newest chapter of the textbook she's writing (&quot;Earth Science Internalized: No Escape&quot;). Samantha adds each of these assignments to her course in Moodle. As she adds each assignment, it is transferred to SchoolTool as a grade item for the section, and SchoolTool will be prepared to accept grade data for each student enrolled in Samantha's course.<br /> * Vera Vestibule is taking Bubble Blowing 101, which has no Moodle component at all. Guidance counselor Guinevere logs into SchoolTool and 1) creates a course (&quot;Bubble Blowing 101&quot;), 2) creates a section of the course (&quot;Bubble Blowing 101 taught by Chewie Chomper&quot;), and 3) enrolls Vera in the section. Chewie uploads in SchoolTool a spreadsheet specifying the gradeable assignments in the course. As his students complete the assignments, Chewie enters their grades in SchoolTool, which is then able to include this course and these grades in student progress reports and transcripts.<br /> * Country Mouse High School has been using Moodle for the past 3 years, and many but not all of the teachers have enthusiastically created Moodle courses that they use extensively in their classrooms. However, some teachers do not have a Moodle presence at all. The principal of CMHS, Betsy Balustrade, keeps a collection of spreadsheets and other documents which she uses to plan and manage the class schedule each year. The technology director of CMHS, Cathy Colever, decides to adopt SchoolTool as the Student Information System (SIS) of CMHS. She installs SchoolTool and integrates it with their existing Moodle, and all the information in Moodle about the teachers, students, courses, enrollments, and grades is transferred to SchoolTool. Cathy provides a series of training sessions for Betsy and her administrative assistant Astra Lodge. Since not every course in the school is in Moodle, Astra enters information about some courses, teachers, and student enrollments into SchoolTool manually. After that, Betsy is able to use SchoolTool to create the schedule for each upcoming semester.<br /> * Samantha Stupenda also teaches Chemistry. All her class assignments are graded in Moodle, and those grades transfer automatically to SchoolTool. But her lab assignments are not in Moodle, and Samantha creates grade items and enters those grades manually into her Chemistry sections in SchoolTool. Halfway through the school year, Samantha decides to represent those lab assignments in Moodle, and she is careful to use *exactly* the same names that she entered into SchoolTool previously. What happens?<br /> <br /> ===Flowcharts Because We Like Them===<br /> * address each of the above scenarios...<br /> * show technical detail for transfer of user account(s) from Moodle to SchoolTool<br /> [[Image:SchoolTool_Integration_Userdata.png|200px]]<br /> * show technical detail for transfer of enrollment(s) from Moodle to SchoolTool<br /> * show technical detail for transfer of grades(s) from Moodle to SchoolTool<br /> <br /> ===Part 1: SSO===<br /> ====Tasks====<br /> * Make Moodle aware of SchoolTool as a potential SSO peer<br /> * Implement Moodle cron job to ensure all users are always maintained in SchoolTool<br /> ** UI: gracefully add this to existing Mnet SSO config screen if possible<br /> * Implement SchoolTool SSO interfaces<br /> ** new_user() Mnet interface<br /> ** update_user() Mnet interface<br /> ** UI: link to configured Moodle peers<br /> ** UI: link back to Moodle after Moodle-&gt;SchoolTool SSO login<br /> ** UI: Mnet SSO configuration<br /> ===Part 2: Enrollments===<br /> ====Tasks====<br /> ===Part 3: Grades===<br /> ====Tasks====<br /> <br /> ==Misc. TODO==<br /> * Matt/Tom: Find out what reports ECHS will want from SchoolTool<br /> <br /> * SchoolTool TODO list<br /> ** Create an &quot;ongoing section&quot; container that will contain (otherwise normal) sections that do not fit into the year/term schema.<br /> *** integration v1.0 will place all Moodle-driven sections in the &quot;ongoing&quot; container<br /> ** Add enumerated status field to enrollment (e.g., Active, Withdrawn No Grade, Withdrawn Failing, Passed) This will not initially include a workflow, but simply a current state and a history of states.<br /> ** Add support for section history<br /> *** grading history<br /> *** enrollment history (including all enrollment status changes)<br /> *** teacher history</div>

Moquist