MoodleDocs - User contributions [en]

User talk:Helen Foster

2010-01-05T05:25:04Z

Moquist:

== Deleting some attached files in JIRA ==

Hi Helen,

I made a bit of a mess at [http://tracker.moodle.org/browse/MDL-21110 http://tracker.moodle.org/browse/MDL-21110]. Would it be possible to delete all the attached files there so Penny or I can upload the current one and let Jira handle the versioning more sanely?

Thanks,
Matt

== Creating new FAQ pages ==

Hi Helen,

I have successfully created a stub for a XML FAQ page (https://docs.moodle.org/en/XML_FAQ) but how do I get it promoted on https://docs.moodle.org/en/Category:FAQ ?

I also would like to create an Import/Export FAQ for collecting all the information regarding Moodle import and export which is scattered in different forums.

Regards,
[[User:Frank Ralf|Frank Ralf]]

:Hi Helen will have to answer the Import/Export question. I jumped in and added <nowiki>[[Category:FAQ]]</nowiki> to the bottom of the page, which anyone can do. And took your hint and added a <nowiki>{{stub}}</nowiki> template at the top. Thanks for the XML work. Best --[[User:chris collman|chris collman]] 14:16, 3 December 2008 (CST)

::Hi Frank, thanks for your offer - an [[Import and export FAQ]] page would be great, thanks! --[[User:Helen Foster|Helen Foster]] 04:12, 4 December 2008 (CST)
:::Thanks to both of you! Helen, how did you get that nice Contents menu on your Import and export FAQ page? I couldn't figure that out from the source. --[[User:Frank Ralf|Frank Ralf]] 05:30, 4 December 2008 (CST) Problem solved, just found the documentation ;-) --[[User:Frank Ralf|Frank Ralf]] 05:43, 4 December 2008 (CST)

== Suggestion that is probably total overkill ==
<onlyinclude>
# Create a new FAQ namespace.
# In this namespace, create one page for each frequent question, where the contents of the page is the answer.
# Use our new knowledge of transclusions to build the FAQ lists by just pulling in pages from the FAQ namespace.

The benefits of doing this are
* The same FAQ can appear in more than one list without copying-and-pasting.
* Each question gets a unique URL that so in the forums, we can point people to a page that just answers their specific question.

Disadvantages
* Editing FAQ lists becomes incomprehensible to anyone who is not a MediaWiki geek.

If we went this way, I would like to use B to build a new FAQ page: "Troubleshooting FAQ". Might be a good idea anyway.
</onlyinclude>
I hasten to say that I am not recommending this approach. The disadvantages could easily outweigh the advantages. I am simply pointing out a technical possibility that may be worth considering either now, or in the future.<onlyinclude>--[[User:Tim Hunt|Tim Hunt]] 07:11, 4 December 2008 (CST)</onlyinclude>

:Just added [[MoodleDocs:Transclusion]]. Good thing I had my first cup of coffee, Tim's thoughtful post got me rubbing the sleep out of my eyes. I wonder if I can get the partial transclusion of this section to work in Sandbox then in [[MoodleDocs_talk:Transclusion]]. Definitely a tool to be used with care. But Wowie Zowie ! --[[User:chris collman|chris collman]] 06:49, 5 December 2008 (CST)

:: Hello Tim, I think your suggested solution would indeed be overkill and would make maintaining FAQ too difficult. I see FAQ as an intermediary step between the unorganised kind of "documentation" which is provided in the forums towards "real" documentation. Therefore the ease of editing is crucial in my opinion. What about using Moodle's '''autolinking mechanism''' to automatically link to FAQ pages, e.g. if there is a mention of grades in the forums that would create an automatic link to Grades FAQ. I am quite new to Moodle, but couldn't that be done with setting up a kind of FAQ Glossary? --[[User:Frank Ralf|Frank Ralf]] 02:44, 16 December 2008 (CST)

::: Hi Tim, thanks for your suggestion, though I think it's overkill too! The current FAQ pages have nice short titles which are easy to find and to include in forum posts. Having a page for each FAQ would result in really long URLs. Also, I think that when we point people to an FAQ page, and they have to look through it to find the answer to their question, they may well find answers to other questions they have. As other people have suggested, I think FAQ pages work well as start pages with links to lots of other pages i.e. they're kept fairly short, for example [[Contributed code FAQ]]. --[[User:Helen Foster|Helen Foster]] 04:49, 18 December 2008 (CST)

::: Frank, regarding autolinking to FAQ pages, have you come across the Moodle Docs filter on moodle.org? Please see the [[Moodle.org FAQ]] for more details. --[[User:Helen Foster|Helen Foster]] 04:49, 18 December 2008 (CST)
::::Helen, thanks for the hint. But isn't that the usual ''manual'' way of wiki linking? But on second thought that might really be the best way of linking to FAQ pages as it keeps getting the forums cluttered with too many (automatic) links. In fact, it just might be a matter of good practice to put advice of lasting value from the forums into a more structured form of documentation and nothing which could or should be done in an automatic and technical way... --[[User:Frank Ralf|Frank Ralf]] 05:11, 19 December 2008 (CST)

== Security Notification registration ==

Hi Helen,

It was suggested to me through the #moodle channel on freenode that I raise this concern with you.

I'm developing a moodle installation behind a firewall on a non-public URL and am interested in subscribing to security updates (prompted to check this after seeing a moodle vulnerability mentioned on Bugtraq). I had previously attempted to subscribe by registering our installation through the admin pages, however that registration was rejected as the site was located behind a firewall and not accessible.

Due to that rejection, I wasn't subscribed to security updates.

I now find myself in the unfortunate position where I cannot subscribe to security updates without having a public facing site (which I can't reasonably know is secure as I'm not receiving security updates through your mailing list).

The burden for those of us who have an internal site they're developing (or perhaps is in production) is that we must now create a public facing site to register for the sole purpose of receiving security updates. If the thought is that only parties interested in maintaining a moodle site should have access to those messages, perhaps a different measure could be put into place (a code that appears once moodle is installed, for example).

I've tried subscribing through sympa@lists.moodle.org, however that method does not work either.

Could you please provide a process for folks like me to get on the security updates list without having to install moodle on a public web server first?

Thanks!

- P.

:Hi Paul, how about subscribing to the [http://moodle.org/mod/forum/view.php?f=996 security announcements forum], where all important security issues are published. --[[User:Helen Foster|Helen Foster]] 04:34, 18 December 2008 (CST)
== Unseen (not hidden) activities==
Hi Helen (This is partly my attempt at practising here by the way!) I've posted several times recently about the concept of 'unseen' topics with resources that can be linked to on the course page where hidden ones wouldn't work. is there documentation about that somewhere here ? If so, where? Then I can point Moodlers to it next time.If not, shall I write it? Thanks - [[User: Mary Cooch|Mary Cooch]]

:Hi Mary, I've just had a quick look and can't find any documentation about unseen topics, so it would be helpful if you could write some, perhaps here: [[Course homepage]]. Thanks in advance :-) --[[User:Helen Foster|Helen Foster]] 17:20, 19 December 2008 (CST)
:Helen - please can you check what I have done as you know I'm still a novice and don't want to put the wrong thing in the wrong place! Also, if you look on my usertalk Chris Colman said it might be useful on the html linking page? [[User: Mary Cooch|Mary Cooch]]

== Downloading Moodle Core ==

Hi Helen,
I came across Moodle just this morning, and read a little about its design, and loved it, it is perfect for the project Im starting.

Ive gone to the download page, to download the Moodle core zip package, but when I click on the link to download I get the following message;

'A server error that affects your login session was detected. Please login again or restart your browser.'

( Continue )

I had a look around the FAQ pages, to see if there was anything on there, but it only mentions about people who already have moodle and are having this difficulty,

Please could you send me an alternative link,

Kind Regards
Andrew
:Hi Andrew, I left a comment on your [[User_talk:Andrew_Abel|user comment page]], just in case you were in a hurry to play with Moodle. --[[User:chris collman|chris collman]] 07:40, 1 January 2009 (CST)

::Hi Andrew, I hope you've been successful in downloading Moodle by now. Chris, thanks for your helpful comments :-) --[[User:Helen Foster|Helen Foster]] 01:21, 2 January 2009 (CST)

== "experimental:" prefix ==

[[User:Marc Grober|Marc Grober]] 12:00, 12 January 2009 (CST)

We started using experimental: as a prefix because there was some confusion about the use of Development: as a prefix.....

In the Moodle docs, Development: appears to cover Moodle developer documentation, not docs under development, so we wanted to use a prefix that connote that the docs were, as we suggest, "experimental" (i.e. not ready for prime time). I had not come across [[Experimental|Experimental]] as the search is a bit temperamental and searching for the root, experiment, produced no result.....

Perhaps we need a different topic name?

I have encouraged AT to ask you to move these pages out of the experimental: topic but I think she feels they are not quite ready and I want to respect hre wishes on this.

We also have some experimental pages under development with respect to gradebook "cases".

I would encourage you to discuss the progress on all these pages with AT.

Thanks

----

:Marc, thanks for your comments. The use of experimental: as a prefix is fine by me. Alternatively you could use a [[MoodleDocs:Templates|Moodle Docs template]] to add a message saying that the page is experimental. --[[User:Helen Foster|Helen Foster]] 02:41, 13 January 2009 (CST)
::Marc and Helen, something new to me. I found 7 pages when I searched on "experimental:" and found 7 Article title matches. 6 started with "experimental:" and of course "Experimental". Wondering if an alternative draft to Main Page should be done that way with the Experimental template. :)--[[User:chris collman|chris collman]] 06:00, 13 January 2009 (CST)
:::Helen, thanks for moving some of the experimental: pages. The page here, however, has yet to be moved: [https://docs.moodle.org/en/experimental:Getting_Help_Installing_and_Managing_Moodle]. Vis-a-vis topics/categories, I think it makes sense to have a category that is not searched by default so that users do not find materials that is not ready for prime time. By the same token, I think, as I mentioned above, that Development: is problematic because it confuses as far as whether it is a topic for Developers or addresses material under development, which are really two different areas. Likewise, as long as there is an Experimental page the use of experimental: could cause confusion. I would argue for three distinct categories.... [[User:Marc Grober|Marc Grober]] 12:16, 24 January 2009 (CST)

::As I understood your (Helen's) comment (posted I don't recall where) you (Helen) were I think suggesting that what I was really suggesting was a new name space such that folks could develop documents that were not included in a default search..... which I think is exactly what I was looking for.... So the question becomes can and should we do such a thing..... --[[User:Marc Grober|Marc Grober]] 23:44, 9 March 2009 (UTC)

:::Marc, I guess you're referring to my forum post [http://moodle.org/mod/forum/discuss.php?d=115736#p509590 Re: Not including pages in the Moodle Docs search]. How about using a Moodle Docs template for now to indicate docs under development and add them to an appropriate category, then when there are sufficient pages to warrant it, we can create a new namespace and move all the pages into it. --[[User:Helen Foster|Helen Foster]] 11:46, 10 March 2009 (UTC)

==Talk:Helen's page is over 32k==
FYI: I got that warning. Maybe a subpage for the older stuff and a link, so we don't loose some stuff. Of course alternatively, if I deleted all my comments/questions, that would shorted it a lot :) --[[User:chris collman|chris collman]] 06:04, 13 January 2009 (CST)
::Seriously, I would be happy to edit my posts here down to a nub or nothingness. I think some of the language requests for help could be put in one heading and shortened, without losing anything. --[[User:chris collman|chris collman]] 06:13, 13 January 2009 (CST)

:Chris, thanks for creating [[User talk:Helen Foster/1]]. I think it's a good solution :-) --[[User:Helen Foster|Helen Foster]] 02:51, 14 January 2009 (CST)

==See also==

*[[User talk:Helen Foster/1]] for older comments

== Registered Users Bug with Mediawiki ==

Hi, [[User_talk:David_Scotson#Moodle_Docs_stats|Way back in 2006 you mentioned]] a work-around for a bug resulting in registered users stats on [[Special:Statistics]] not updating properly. I think I am encountering this same bug on my internal wiki now. I know that was a long time ago, but do you remember what you did to fix it/what the work-around mentioned was?
Thanks,
--[[User:Adrian Archer|Adrian Archer]] 11:02, 4 March 2009 (CST)

:Hi Adrian, here are Eloy's workarounds (easy to do with phpMyAdmin):

:# To refresh the count of pages, if it's not working: table: site_stats, field: ss_total_pages, setting it to -1 should force recalculation of pages
:# To refresh the count of registered users, delete the contents of the "cached statistics" table

:Thanks to Eloy for recalling them :-) I hope you are able to upgrade to a newer MediaWiki version soon. --[[User:Helen Foster|Helen Foster]] 09:01, 5 March 2009 (CST)

::Thanks so much for the quick response, that sounds like it should work. I'm actually using Version 1.13.3, so I guess the bug still exists. --[[User:Adrian Archer|Adrian Archer]] 09:17, 5 March 2009 (CST)

:::Hmm, Moodle Docs is actually using version 1.11.2, though we're hoping to upgrade very soon (MDLSITE-657). --[[User:Helen Foster|Helen Foster]] 09:35, 5 March 2009 (CST)

== Function if in grade calculations? ==

Hi Helen

Thanks for your jobs.

Sorry for my lousy english.

I am trying to use the "if" function in "Grade calculations" in a similar way as is done in "opencalc"

do you know if this is possible?

How to introduce a note of recovery, only for a few students, without changing the original calification?

My email is trujillo@unex.es

Thanks

== Using Moodle for Teachers ==

Hi Helen,

I teach math at Woodland Middle School in Woodland, WA. I'm also just beginning work with the Ubuntu Learning Project (name?). Is your book (Using Moodle - Teaching with the Popular Open Source Course Management System) available for download on Moodle Docs free to teachers? If so, is there some type of creative commons license? Or should we just link to Moodle Docs? I found your book extremely useful when I taught a 3-day Moodle Bootcamp to teachers this summer.

Thanks, Mark Knudson

:Hi Mark, glad to hear you found my book useful :-) It's available for download under the Creative Commons Attribution-Noncommercial-Share Alike licence here: [[Using Moodle book]]. --[[User:Helen Foster|Helen Foster]] 19:11, 21 September 2009 (UTC)

== PHP Settings by Moodle version ==

Hi Helen,

I'm new to this community (and to Moodle) and am not sure how I should request an update to the documentation relating to a Moodle PHP extension requirement - specifically zlib.
I noticed that this page:
https://docs.moodle.org/no/Installering_av_Moodle has a section stating that "The zlib extension is required for zip/unzip functionality." under the PHP Extensions and Libraries, but it doesn't exist here:
https://docs.moodle.org/en/PHP_settings_by_Moodle_version

The PHP_settings_by_Moodle_version is a Stub and is waiting for review - I was thinking about updating it with the text from the https://docs.moodle.org/no/Installering_av_Moodle page.

Looking for a little direction.

Thanks!
Andy

:Hi Andy,

:Thanks for your kind offer to update the documentation [[PHP settings by Moodle version]]. Please feel free to go ahead and do so :-) (I asked in our developer chat and was informed that zlib is required for versions of Moodle up to 1.9 and Moodle 2.0 onwards will come with native PHP zip support so it needs the "zip" extension instead.)

:For future reference, you're always welcome to edit pages in Moodle Docs and help improve our documentation. If you're not quite sure of something, you can leave a note in the page comments. Thanks again! --[[User:Helen Foster|Helen Foster]] 11:45, 20 November 2009 (UTC)

Czech Hackfest 2009

2009-09-30T05:26:47Z

Moquist: /* Attendees and arrivals */

Work in progress here - do not rely on this yet.

== Programme ==

; Saturday 5th December 2009 :

* Meet each others in Prague (some arrive, some may be there already)
* 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).
* Explore Prague (Castle etc)
* Social beer event

; Sunday 6th December 2009 :
* Leaving Prague together by a rented micro-bus (about 120 mins)
* Lunch at [http://www.jested.cz Jested, Liberec].
* Moving to the mountains (by bus or car or foot ;-), according to snow conditions)
* Accommodating at [http://www.dudovi.cz/jizerka/eng/ubytovani.htm Jizerka]

; Monday 7th December 2009
* Moodle 2.0 release planning
* Triage of remaining bugs (assign developers, priorities)
* Bug sprint

; Tuesday 8th December 2009
* Moodle 2.x planning
* Creating detailed roadmap for all modules based on tracker

; Wednesday 9th December 2009
* Moodle 3.0 brainstorming and planning
* Moodle 2.0 bugs

; Thursday 10th December 2009
* Moodle 2.0 bugs
* Skiiing?

; Friday 11th December 2009
* moving back to Prague on Friday
* more Prague sightseeing
* 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).
* official end of hackfest

== Attendees and arrivals ==

Maximum of 16 places, so far we have (in chaotic order):

# Martin Dougiamas
# Eloy Lafuente
# Petr Skoda
# Tim Hunt
# Helen Foster
# Penny Leach
# Dan Poltawski
# David Mudrak
# Shane Elliott
# Chris Roy
# Brian King
# Daniele Cordella
# Mike Churchward
# Hubert Chathi
# Matt Oquist
# ?

== Suggestions ==

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.

===What is the balance between Yack and Hack?===

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)

===Planning specific bits of the post 2.0-roadmap===

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).

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.

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)

: +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)

===How about a work-on-2.0 day===

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.

==='Prepared' Bug Squashing===

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.

With each bug we triage before the hackfest, we should try to:
* a) Link or close issues which have been fixed, or will be fixed by 2.0 (etc)
* b) Document unsolved issues which we need discussion or a plan to be fixed ('''this is most important for the hackfest itself''')
* c) Document bugs which could be fixed with a little time (at the hackfest or later)
* d) Document bugs to pester someone else about ;-)

Depending on how much time you can devote, I suggest trying these triaging views in order:
* 1) Reviewing all open bugs reported by yourself, starting oldest first.
* 2) Reviewing your assigned issues, starting with oldest first
* 3) Reviewing 'nobody' or 'imported' bugs starting with the oldest first.
etc..

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)

Czech Hackfest 2009

2009-09-15T18:06:49Z

Moquist: /* Attendees and arrivals */

Work in progress here - do not rely on this yet.

== Programme ==

; Saturday 5th December 2009 :

* Meet each others in Prague (some arrive, some may be there already)
* 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).
* Explore Prague (Castle etc)
* Social beer event

; Sunday 6th December 2009 :
* Leaving Prague together by a rented micro-bus (about 120 mins)
* Lunch at [http://www.jested.cz Jested, Liberec].
* Moving to the mountains (by bus or car or foot ;-), according to snow conditions)
* Accommodating at [http://www.dudovi.cz/jizerka/eng/ubytovani.htm Jizerka]

; Monday 7th December 2009
* Moodle 2.0 release planning
* Triage of remaining bugs (assign developers, priorities)
* Bug sprint

; Tuesday 8th December 2009
* Moodle 2.x planning
* Creating detailed roadmap for all modules based on tracker

; Wednesday 9th December 2009
* Moodle 3.0 brainstorming and planning
* Moodle 2.0 bugs

; Thursday 10th December 2009
* Moodle 2.0 bugs
* Skiiing?

; Friday 11th December 2009
* moving back to Prague on Friday
* more Prague sightseeing
* 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).
* official end of hackfest

== Attendees and arrivals ==

Maximum of 16 places, so far we have (in chaotic order):

# Martin Dougiamas
# Eloy Lafuente
# Petr Skoda
# Tim Hunt
# Helen Foster
# Penny Leach
# Dan Poltawski
# David Mudrak
# Shane Elliott
# Chris Roy
# Brian King (TBC)
# Daniele Cordella (TBC)
# Mike Churchward (TBC)
# Hubert Chathi or Justin Filip (TBC)
# Iñaki Arenaza (TBC)
# Matt Oquist (TBC)

== Suggestions ==

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.

===What is the balance between Yack and Hack?===

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)

===Planning specific bits of the post 2.0-roadmap===

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).

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.

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)

: +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)

===How about a work-on-2.0 day===

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.

==='Prepared' Bug Squashing===

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.

With each bug we triage before the hackfest, we should try to:
* a) Link or close issues which have been fixed, or will be fixed by 2.0 (etc)
* b) Document unsolved issues which we need discussion or a plan to be fixed ('''this is most important for the hackfest itself''')
* c) Document bugs which could be fixed with a little time (at the hackfest or later)
* d) Document bugs to pester someone else about ;-)

Depending on how much time you can devote, I suggest trying these triaging views in order:
* 1) Reviewing all open bugs reported by yourself, starting oldest first.
* 2) Reviewing your assigned issues, starting with oldest first
* 3) Reviewing 'nobody' or 'imported' bugs starting with the oldest first.
etc..

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)

SchoolTool Integration

2009-09-12T21:12:27Z

Moquist: /* Tasks */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]] [[Image:Patricia-checks-Susies-courses-in-SchoolTool.png|100px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]] [[Image:Scenario2.png|200px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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.
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]
## Phase 2 Part 1: Users
##:[[Image:Country-mouse1.png|300px]]
## Phase 2 Part 2: Enrollments
##:[[Image:Country-mouse2.png|300px]]
## Phase 2 Part 3: Grades
##:[[Image:Country-mouse3.png|300px]]

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Userdata.dia]]
:[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Enrollment.dia]]
:[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Grades.dia]]
:[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
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.
====Tasks====
* Moodle MNet linkage (Matt)
** UI: Make Moodle aware of SchoolTool as a potential SSO peer.
** Add new auth plugin to send info to SchoolTool and to accept SSO back from SchoolTool.
** Create spec for Brett to implement inward and outward portion of SSO in SchoolTool. Needs to answer the following questions:
*** What URL will Moodle call when attempting to initiate outbound SSO?
*** How will Moodle provide the authentication token to the remote system?
*** What URL does Moodle expect to be called with to accept incoming SSO?
*** How does Moodle expect to be given the authentication token?
* Fully implemented MNet linkage and SSO between Moodle and SchoolTool (Brett)
** Ability to configure one or more Moodle systems as MNet peers within SchoolTool
*** Add new peer
*** View / verify peer status
*** Delete peer
** After configuration, ability to perform SSO login from SchoolTool to Moodle
** After configuration, ability to accept SSO login from Moodle to SchoolTool
*** 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
** Unit tests to cover each of the above features
* SchoolTool back-end (Douglas)
** Accept new user info from any integrated Moodle that calls.
*** Handle username collisions. (See Mahara & Moodle.)
*** Consider how user profile fields are handled.
*** 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.)
** Periodically ask for a full-sync with each integrated Moodle.

===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-09-04T16:34:09Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]] [[Image:Patricia-checks-Susies-courses-in-SchoolTool.png|100px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]] [[Image:Scenario2.png|200px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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.
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]
## Phase 2 Part 1: Users
##:[[Image:Country-mouse1.png|300px]]
## Phase 2 Part 2: Enrollments
##:[[Image:Country-mouse2.png|300px]]
## Phase 2 Part 3: Grades
##:[[Image:Country-mouse3.png|300px]]

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Userdata.dia]]
:[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Enrollment.dia]]
:[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Grades.dia]]
:[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
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.
====Tasks====
* Moodle (Matt)
** UI: Make Moodle aware of SchoolTool as a potential SSO peer.
** Add new auth plugin to send info to SchoolTool and to accept SSO back from SchoolTool.
** Create spec for Brett to implement inward and outward portion of SSO in SchoolTool. Needs to answer the following questions:
*** What URL will Moodle call when attempting to initiate outbound SSO?
*** How will Moodle provide the authentication token to the remote system?
*** What URL does Moodle expect to be called with to accept incoming SSO?
*** How does Moodle expect to be given the authentication token?
* Fully implemented MNet linkage and SSO between Moodle and SchoolTool (Brett)
** Ability to configure one or more Moodle systems as MNet peers within SchoolTool
*** Add new peer
*** View / verify peer status
*** Delete peer
** After configuration, ability to perform SSO login from SchoolTool to Moodle
** After configuration, ability to accept SSO login from Moodle to SchoolTool
*** 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
** Unit tests to cover each of the above features
* SchoolTool back-end (Douglas)
** Accept new user info from any integrated Moodle that calls.
*** Handle username collisions. (See Mahara & Moodle.)
*** Consider how user profile fields are handled.
*** 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.)
** Periodically ask for a full-sync with each integrated Moodle.

===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-28T03:54:05Z

Moquist: /* Tasks */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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?
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]
## Phase 2 Part 1: Users
##:[[Image:Country-mouse1.png|300px]]
## Phase 2 Part 2: Enrollments
##:[[Image:Country-mouse2.png|300px]]
## Phase 2 Part 3: Grades
##:[[Image:Country-mouse3.png|300px]]

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Userdata.dia]]
:[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Enrollment.dia]]
:[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Grades.dia]]
:[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
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.
====Tasks====
* Moodle (Matt)
** UI: Make Moodle aware of SchoolTool as a potential SSO peer.
** Add new auth plugin to send info to SchoolTool and to accept SSO back from SchoolTool.
** Create spec for Brett to implement outward portion of SSO in SchoolTool.
* SchoolTool UI+Mnet (Brett)
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration (with one or more Moodles)
*** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.
*** 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.)
* SchoolTool back-end (Douglas)
** Accept new user info from any integrated Moodle that calls.
*** Handle username collisions. (See Mahara & Moodle.)
*** Consider how user profile fields are handled.
*** 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.)
** Periodically ask for a full-sync with each integrated Moodle.

===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-25T20:58:38Z

Moquist: /* Part 1: SSO */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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?
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]
## Phase 2 Part 1: Users
##:[[Image:Country-mouse1.png|300px]]
## Phase 2 Part 2: Enrollments
##:[[Image:Country-mouse2.png|300px]]
## Phase 2 Part 3: Grades
##:[[Image:Country-mouse3.png|300px]]

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Userdata.dia]]
:[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Enrollment.dia]]
:[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
:[[Image:SchoolTool_Integration_Grades.dia]]
:[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
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.
====Tasks====
* Moodle (Matt)
** Make Moodle aware of SchoolTool as a potential SSO peer.
** Add new auth plugin to send info to SchoolTool.
* SchoolTool UI+Mnet (Brett)
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration (with one or more Moodles)
*** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.
*** 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.)
* SchoolTool back-end (Douglas)
** Accept new user info from any integrated Moodle that calls.
*** Handle username collisions. (See Mahara & Moodle.)
*** Consider how user profile fields are handled.
*** 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.)
** Periodically ask for a full-sync with each integrated Moodle.

===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-24T01:07:19Z

Moquist: /* Tasks */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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?
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]
## Phase 2 Part 1: Users
##:[[Image:Country-mouse1.png|300px]]
## Phase 2 Part 2: Enrollments
##:[[Image:Country-mouse2.png|300px]]
## Phase 2 Part 3: Grades
##:[[Image:Country-mouse3.png|300px]]

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
====Tasks====
* Moodle (Matt)
** Make Moodle aware of SchoolTool as a potential SSO peer.
** Add new auth plugin to send info to SchoolTool.
* SchoolTool UI+Mnet (Brett)
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration (with one or more Moodles)
*** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.
* SchoolTool back-end (Douglas)
** Accept new user info from any integrated Moodle that calls.
*** Handle username collisions. (See Mahara & Moodle.)
*** Consider how user profile fields are handled.
** Periodically ask for a full-sync with each integrated Moodle.

===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-24T01:05:05Z

Moquist: /* Tasks */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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?
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]
## Phase 2 Part 1: Users
##:[[Image:Country-mouse1.png|300px]]
## Phase 2 Part 2: Enrollments
##:[[Image:Country-mouse2.png|300px]]
## Phase 2 Part 3: Grades
##:[[Image:Country-mouse3.png|300px]]

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
====Tasks====
* Moodle (Matt)
** Make Moodle aware of SchoolTool as a potential SSO peer
* SchoolTool UI+Mnet (Brett)
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration (with one or more Moodles)
*** Consider any configuration of the SSO. Choose sensible defaults, make helpful options modifiable.
* SchoolTool back-end (Douglas)
** Accept new user info from any integrated Moodle that calls.
** Handle username collisions. (See Mahara & Moodle.)
** Consider how user profile fields are handled.
** Periodically ask for a full-sync with each integrated Moodle.

===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-24T00:35:38Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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?
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Country-mouse.dia Country-mouse.dia source file]
## Phase 2 Part 1: Users
##:[[Image:Country-mouse1.png|300px]]
## Phase 2 Part 2: Enrollments
##:[[Image:Country-mouse2.png|300px]]
## Phase 2 Part 3: Grades
##:[[Image:Country-mouse3.png|300px]]

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-23T23:00:28Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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?
# 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.
## Phase 2 Part 1: Users
## Phase 2 Part 2: Enrollments
## Phase 2 Part 3: Grades

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-23T22:39:06Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Vera.dia Vera.dia source file]
#:[[Image:Vera.png|300px]]
# 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.
# 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Enrollment.png|200px]]
* show technical detail for transfer of grades(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Grades.png|200px]]

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-16T19:01:50Z

Moquist: /* Terminology Disambiguation */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
# 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.
# 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T22:06:10Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
#:[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
#:[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
#:[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
#:[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
#:[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
#:[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
# 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.
# 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T22:05:32Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
#:[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
#:[[Image:Susie-and-patricia.png|300px]]
# 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
# 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.
# 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T22:05:01Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
#:
# 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
# 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.
# 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T22:03:30Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
# 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
[https://docs.moodle.org/en/images_en/5/56/Samantha1.dia Samantha1.dia source file]
[[Image:Samantha1.png|500px]]
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
# 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.
# 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T22:01:27Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
# 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
# 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|500px]]
# 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.
[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
[[Image:Tommy-and-guinevere2.png|500px]]
# 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 ("Earth Science Internalized: No Escape"). 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.
# 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
# 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.
# 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T21:30:49Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
* 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|500px]]
* 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.
[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
[[Image:Tommy-and-guinevere2.png|500px]]
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T21:22:18Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
* 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|500px]]
* 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.
[https://docs.moodle.org/en/images_en/2/2b/Tommy-and-guinevere2.dia Tommy-and-guinevere2.dia source file]
[[Image:Tommy-and-guinevere2.png|500px]]
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T17:15:26Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
* 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|500px]]
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T17:12:29Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
* 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:Tommy-and-guinevere1.png|300px]]
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T17:11:47Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
* 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
[[Image:https://docs.moodle.org/en/images_en/f/f0/Tommy-and-guinevere1.png|300px]]
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T17:10:51Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
* 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).
[https://docs.moodle.org/en/images_en/a/af/Tommy-and-guinevere1.dia Tommy-and-guinevere1.dia source file]
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T00:53:02Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
[[Image:Susie-and-patricia.png|300px]]
* 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).
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-15T00:50:59Z

Moquist: /* Scenarios */

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
[https://docs.moodle.org/en/images_en/d/d1/Susie-and-patricia.dia Susie-and-patricia.dia source file]
* 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).
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?

===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
[[Image:SchoolTool_Integration_Userdata.png|200px]]
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-02T20:26:25Z

Moquist:

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)
'''In summary, integration v1.0 will be a Moodle->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.'''

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
* 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).
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?
===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-08-02T04:52:36Z

Moquist:

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.

==Goal: Moodle-SchoolTool integration modeled on Moodle-Mahara integration.==
* SchoolTool-Mahara integration should require very little extra effort when this project is complete.
* 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.

==Requirements==
* Completely web-based integration configuration (similar to Moodle-Mahara configuration)
* SSO between SchoolTool and Moodle
* User accounts, courses, enrolments, assignments, and grades auto-update in SchoolTool
* Automatic grade transfer from Moodle to SchoolTool

==Integration v1.0 NON-Requirements==
* Users, courses, enrolments can originate in and be managed within SchoolTool, with Moodle updating from SchoolTool.
** This will be the goal of the next version of the integration.

==Assumptions==
* SchoolTool is the authoritative reporting application.
* Moodle drives all data creation and management.

==Supported versions==
* SchoolTool 1.0
* Moodle 1.9.5+

==Terminology Disambiguation==
* course: A SchoolTool course.
** SchoolTool "course" has no Moodle analogue. ("Algebra 1") can have multiple "sections" ("Algebra * 1 @ 9:15 taught by Mr. Smith").
* section: A SchoolTool section, a Moodle course.

==Background info and references==
* [https://docs.moodle.org/en/Grades Moodle 1.9+ gradebook]
* [https://docs.moodle.org/en/External_database Moodle external DB enrolment plugin ]

==Implementation notes/ideas==
* 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.]
** SchoolTool will need to use this library.
* 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.)
* Moodle will need an enrolment plugin that gets data from mnet but is otherwise modeled on the external DB enrolment plugin.
* Moodle will need a gradebook plugin that can pass grades to SchoolTool via mnet.
* integration v1.0 will not batch updates from Moodle to SchoolTool. Updates will be small and frequent.

==Use Cases==
* integration v1.0: Drop SchoolTool into existing Moodle site, leave Moodle as driver of user directory and enrollment management.
** 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.)
** All course creation and enrollment updates must happen first in Moodle and be transferred from there to SchoolTool.
** Enrollment can be student-driven.
** An interactive enrollment in Moodle kicks off an immediate transaction to record the enrollment in schooltool.
* future integration version only: Drop SchoolTool into existing Moodle site, after bulk data transfer from Moodle->SchoolTool, flip configuration and use SchoolTool as the authoritative user directory and/or enrollment management system.
** Could this be used to migrate to SchoolTool from another SIS (integrated somehow with Moodle) by way of Moodle?
* Start fresh with both.
* future integration version only: Drop Moodle into SchoolTool site.
** maybe not important for v1.0, might basically come for free
* future integration version only: Drop SchoolTool into Mahara site (and vice-versa)

==User Interfaces==
* 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]
* Moodle UIs
** Auth plugin config
** Enrolment plugin config
** Grade export config
* SchoolTool UIs
** similar division of config screens
** equivalent of Moodle's "Network Servers" block with links to SSO peers
** equivalent of "You have logged in from <somelink>" to go back after SSO

==Mnet==
* What, in summary, does MNET provide?
** MNET is an XMLRPC implementation that dispatches messages to applications on either side (with a convention for function naming).
** MNET has a security layer that enforces that every message is encrypted and signed (with regular key rotation).
** MNET provides a core set of modules to provide common functionality such as SSO, key discovery, ping, and course enrollment.

===Moodle mnet Interfaces===
* existing: SSO IDP interfaces
** in integration v1.0, SchoolTool will only be a Service Provider and Moodle will always be the IDentity Provider
** returns user data sufficient to create account
* list_user_enrolments(user)
** returns a list of all enrolments for a given user
** SchoolTool may call this to get enrolment data ASAP when an unknown user authenticates and an account is created using user_authorise()

===SchoolTool mnet Interfaces===
* fetch_user(userdata)
** tell SchoolTool to ask Moodle for one user's data
** userdata: associative array such as:
*** username=>moquist
*** firstname=>Matt
*** lastname=>Oquist
*** idnumber=>1234457 # unique ID shared by Moodle & SchoolTool
*** email=>moquist@majen.net
*** password_hash=>234lih23rlh2asldfjas
*** password_hash_algorithm=>md5
*** ircnick=>moquist
*** arbitrary_field=>arbitrary_data_string...
**** SchoolTool only cares about enough to create a login account.
**** SchoolTool does not care about student-editable profile fields.
* new_section(sectiondata)
** sectiondata: associative array such as:
*** name=>"Algebra 1 V1 Mrs. Smith: Cats and their Affectations"
*** idnumber=>197423 # unique ID shared by Moodle & SchoolTool
*** teacheridnumber=>987234 # unique ID shared by Moodle & SchoolTool
*** segment=>1 # a section may have more than one semester/segment/term(?)
* new_enrolment(enrolmentdata)
** create new association between user & section
** enrolmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** userid=>987234 # unique ID shared by Moodle & SchoolTool
*** role=>'teacher' # only 'student' and 'teacher' supported in integration v1.0
* new_assessment(assessmentdata)
** create new assessment to be displayed in grade reports
** assessmentdata: associative array such as:
*** sectionid=>197423 # unique ID shared by Moodle & SchoolTool
*** name=>"How to grill a logarithmic sandwich"
*** idnumber=>73743734 # unique ID shared by Moodle & SchoolTool
*** chapternum=>3
*** honors_required=>false
*** nonhonors_required=>true
*** extra_credit=>false
*** pointval=>68
* new_grade(gradedata)
** make entry in gradebook
** gradedata: associative array such as:
*** assessmentid=>73743734
*** userid=>2347234 # unique shared ID of student
*** points_earned=>62
*** excepted=>false
*** attempt_num=>1 # if multiple attempts are allowed

==Phase 2==
* Some discussion is taking place [http://moodle.org/mod/forum/discuss.php?d=129267 here].
===Scenarios===
* 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.
* 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).
* 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.
* 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 ("Earth Science Internalized: No Escape"). 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.
* 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 ("Bubble Blowing 101"), 2) creates a section of the course ("Bubble Blowing 101 taught by Chewie Chomper"), 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.
* 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.
* 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?
===Flowcharts Because We Like Them===
* address each of the above scenarios...
* show technical detail for transfer of user account(s) from Moodle to SchoolTool
* show technical detail for transfer of enrollment(s) from Moodle to SchoolTool
* show technical detail for transfer of grades(s) from Moodle to SchoolTool

===Part 1: SSO===
====Tasks====
* Make Moodle aware of SchoolTool as a potential SSO peer
* Implement Moodle cron job to ensure all users are always maintained in SchoolTool
** UI: gracefully add this to existing Mnet SSO config screen if possible
* Implement SchoolTool SSO interfaces
** new_user() Mnet interface
** update_user() Mnet interface
** UI: link to configured Moodle peers
** UI: link back to Moodle after Moodle->SchoolTool SSO login
** UI: Mnet SSO configuration
===Part 2: Enrollments===
====Tasks====
===Part 3: Grades===
====Tasks====

==Misc. TODO==
* Matt/Tom: Find out what reports ECHS will want from SchoolTool

* SchoolTool TODO list
** Create an "ongoing section" container that will contain (otherwise normal) sections that do not fit into the year/term schema.
*** integration v1.0 will place all Moodle-driven sections in the "ongoing" container
** 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.
** Add support for section history
*** grading history
*** enrollment history (including all enrollment status changes)
*** teacher history

SchoolTool Integration

2009-07-31T03:56:26Z

Moquist: /* Phase 2 */

SchoolTool Integration

2009-07-31T03:55:59Z

Moquist: /* Phase 2 */

SchoolTool Integration

2009-07-31T03:53:54Z

Moquist: /* Scenarios */

SchoolTool Integration

2009-07-31T03:52:35Z

Moquist: /* Phase 2 */

SchoolTool Integration

2009-07-30T15:46:48Z

Moquist:

SchoolTool Integration

2009-07-30T04:43:46Z

Moquist:

SchoolTool Integration

2009-07-30T03:26:30Z

Moquist:

SchoolTool Integration

2009-07-29T20:01:28Z

Moquist:

SchoolTool Integration

2009-07-23T04:49:45Z

Moquist:

SchoolTool Integration

2009-07-01T15:00:52Z

Moquist: /* Use Cases */

SchoolTool Integration

2009-07-01T14:59:09Z

Moquist: /* Use Cases */

SchoolTool Integration

2009-07-01T14:42:19Z

Moquist: /* Implementation notes/ideas */

SchoolTool Integration

2009-07-01T14:41:57Z

Moquist: /* Implementation notes/ideas */

SchoolTool Integration

2009-06-30T22:10:56Z

Moquist: /* Mnet */

SchoolTool Integration

2009-06-30T22:10:33Z

Moquist:

SchoolTool Integration

2009-06-30T22:01:00Z

Moquist:

SchoolTool Integration

2009-06-30T21:42:01Z