MoodleDocs - User contributions [en]

Talk:Plugin documentation

2014-10-30T09:47:44Z

Simoncoggins: Sorry, it seems to work fine!

Talk:Plugin documentation

2014-10-30T09:42:52Z

Simoncoggins: Created page with "This page suggests plugin documentation should make use of the Infobox template, however it appears to have been deleted: https://docs.moodle.org/27/en/Template:Infobox Was..."

This page suggests plugin documentation should make use of the Infobox template, however it appears to have been deleted:

https://docs.moodle.org/27/en/Template:Infobox

Was it deleted in error, or should this page be updated with different instructions?

reportbuilder/Work outline

2014-06-06T01:33:48Z

Simoncoggins: /* To do list */

==Introduction==
This page is a list of work required for the porting of the [[reportbuilder | Report Builder]] into Moodle.

==Reasons for incorporating the report builder==
Different options were considered for custom reports in Moodle and it was decided that integrating Totara's report builder into Moodle was the best option. Some of the reasons for this decision are as follows:
*A lot of the community is already familiar with Totara's system.
*Work on porting Totara's system to Moodle has been attempted by external developers.
*The report builder interface is the most user friendly, with no need to create (or understand) SQL.
*Users do not need to understand the database structure of Moodle to create appropriate reports.
*General opinion is that Totara's report builder has a more Moodle feel compared to other solutions. (See MDL-30193 for comments)

==To do list==
This list has been arranged into roughly the order that they should be started / completed.
These issues are all part of the "Integrate report builder into core" epic (MDL-30193).

'''Create and update reportbuilder unit and behat tests (MDL-45700)'''
*Update Unit tests (Then keep them updated and passing throughout development)
*Add behat tests

'''Structural changes to reportbuilder (MDL-45702)'''
*Change namespace & Frankenstyle name
*Use automatic class loading.
*Fix existing classes
*Work out what is commented out and why (git diff ~/git/totara/mod/scorm/rb_sources/rb_source_scorm.php mod/scorm/rb_sources/rb_source_scorm.php)
*Fix warnings
*Remove irrelevant totara data from:
**main plugin
**child classes
*Totara_report_manager block needs to be included (or some other way for students and teachers needs to be found to access the reports).
*Move language strings to plugin files
*Fix navigation tree for viewing reports.
*Change ‘Global settings’ to a more intuitive name

'''Replace calls to custom totara functions.(MDL-45703)'''
*totara_set_notification()
*file_postupdate_standard_editor() needs to be replaced (reportbuilder/general.php)
*totara_feature_visable()
*totara_get_manager()
*Other yet undiscovered functions…

'''Update and create "sources" for the report builder. (MDL-45704)'''
*Port over sources from Totara
*Remove totara specific fields (diff between the database schemas in Totara and Moodle to see what fields to remove)
*Remove totara specific functions
*Add more classes to useful areas of Moodle (More than just SCORM).
**Assign (submissions, summary, final grades)
**Site log (exists in Totara, but need to upgrade to new log system)
**Quiz
**Forum
*Make sure theses sources are indexed for performance

'''Formatting issues in the reportbuilder (MDL-45705)'''
*Clean up formatting.
**Fix capitalisations.
**Doc blocks.
**Comments.
**multiple parameters on one line.
*Possibly split up report forms - Not sure that they will get through all in one file.
*Make a separate page for viewing the list of reports from creating reports
*Move add button to the next row so that it’s clear that you already are adding a field

'''Update javascript for the reportbuilder (MDL-45706)'''
*Disable javascript calls (currently jquery).
*Create YUI/Moodle Table (Talk to Frontend)
*reportbuilder/filters/ remove jquery from hierarchy.php if not the whole file.
*reportbuilder/showhide.php remove jquery and replace with yui.

'''Create / update embedded reports (MDL-45707)'''
*reportbuilder/embedded/ all files need to be reviewed to determine if they are useful / relevant.

'''Replace add_to_log calls to event classes. (MDL-45708)'''
*update report
*view report
*dailyreport
*delete
*$type . ‘ report’ - reportbuilder/index.php line 56 (deletion of report)
*new report
*export report

'''Update cron functions to use the new cron system.(MDL-45709)'''

'''Other miscellaneous jobs.'''
*accessibility check.
*Review all code 50+ files, thousands of lines of code.
*Finish Report Builder documentation
*Investigate in detail the file totara/reportbuilder/db/install.php. This changes the database structure which I am sure that integrators would have some hard questions about.
* Review [[reportbuilder/Totara_thoughts_on_integration]]

reportbuilder/Totara thoughts on integration

2014-06-06T01:32:11Z

Simoncoggins: Totara thoughts on integration of report builder into core

Having previously given some thought to merging reportbuilder into Moodle, and as the original author I thought I'd put down some thoughts ideas that might help with the process.

===Areas that may need some work===

1. Group Concat

Report builder has some code to provide a cross-platform version of the mysql only aggregate function group_concat (which lets you aggregate text data by concatenation). As you spotted there is postgres specific code in totara/reportbuilder/db/install.php which creates a new aggregate function. In 2.6 (seedlings code) we added support for MSSQL which proved to be quite difficult. See here for how that is done:

https://github.com/totara/seedlings/blob/totara-seedlings-2.6/totara/mssql/db/install.php

Both the postgres and mssql solutions might be considered a bit "custom" for core moodle.

Also Totara doesn't support Oracle at all so currently there is no Oracle compatibility. There is certainly some work there if you decide that group concat support is wanted. If not you would just need to remove any existing uses of it (activity and tag lists in course source, cohort filters, multiselect custom field type). A search for sql_group_concat should find them all.

2. Embedded reports

Currently all embedded report classes are stored in totara/reportbuilder/embedded/. That's fine for us but in Moodle you will want plugins to be able to define their own embedded reports which they make use of. That will probably mean using autoloading but you will also need a way for the system to discover which embedded reports exist (so you can provide a list on totara/reportbuilder/index.php).

3. Extending sources

This is something that would help us since once report builder is in core we'll need to be able to put back our totara-specific additions. It would be helpful if it was doable without us having to make too many core changes. One thing we will be able to do is extend the existing sources like this:

https://github.com/totara/seedlings/blob/totara-seedlings-2.6/totara/cohort/rb_sources/rb_source_cohort_orphaned_users.php

But it would be great if this could be kept in mind as I'm sure lots of organisations would appreciate an easy way to add their own functionality into existing report sources.

===Potential changes to consider===

The following are all things we've intended to do but not got around to yet. I thought I'd mention them here as they involve API changes, and so if you consider any of them important it would be better to get them in from the start rather than having to make breaking changes later (requiring plugin authors to update their sources).

1. Update filters to use GET instead of POST

This would allow people to use a URL instead of having to create a saved search to point to a particular results set. At the same time I would refactor saved searches to use a table with key/value pairs rather than how it is done right now (serializing filter data in session/database).

2. Modify filter UI

Currently the report creator defines which filters are available and they are all displayed every time (with some set to advanced). We would like to change it so the user can see a list of all filters and then chooses which ones to add (more like JIRA basic search). The main advantages are a cleaner UI and it would make it possible to add extra features such as AND/OR logic and reusing the same filter multiple times in a single report.

3. Refactor Content restrictions by merging with filters.

For historical reasons content restrictions have completely separate code from filters. However they have ended up converging and I think the system would be more flexible if they were combined. All existing content restrictions could be converted to filters fairly easily (they are a bit more dynamic but basically the same). If item 1 above was done then the content tab could just list all available filters and the report creator would add them as a kind of pre-filter. The only difference would be that report users couldn't remove filters that the admin had setup. This would instantly make all the current filters available as content restrictions which would be great!

4. More fine-grained management of reports.

Currently there is one capability that controls the ability to manage all reports. As they get used more its becoming evident that this needs to be more fine-grained. Perhaps reports should use contexts to control who can manage them, or maybe each report should be "owned" by the creator and only them and site admins can edit them. I'm not sure of the best approach but it is clear that the current system is a bit limited.

Related is the list of embedded reports on totara/reportbuilder/index.php. This is already getting quite long for us as it is a site-wide list of all embedded reports. It seems like it will soon need to be split out in some way, either with categories, or separate per-component management areas.

5. Improved support for reusing predefined "groups" of reporting functionality

As you know report sources are quite prescriptive in that the developer must specify exactly what is available. Early on we found the need to reuse some common fields (such as user profile fields) across multiple reports and ended up with helper functions like add_user_fields_to_columns() in rb_base_source.php to achieve that. While predefined sources have got us a long way, we are starting to see requests for more flexibility - people wanting to pull in data from multiple existing sources.

I've been considering how it might be possible to define a group of fields/filters along with any foreign keys that they can join against to make it easier to reuse common code.

===Other potential future features===

Here are a few ideas that we are looking at adding to future versions of report builder.

1. Graphical reporting

It's long been on our roadmap to add support for graphical reports using a front-end javascript graphing library. This is a high priority for us this year so may be something we tackle soon. With report builder going into core we would most likely do this as a contribution to Moodle so would need to go through the normal process for code contributions. Just wanted to give you a heads up that it's on the cards.

2. Separate reporting database connection

Particularly on large sites, big reports can take a while to generate if there's huge amounts of data and multiple complex joins. In 2.5 we added report caching which provides a way to get faster reporting at the expense of real-time results. Another approach we investigated was supported a separate database connection to a read-only slave database specifically for reporting. This has the advantage of reducing load on the main database server. We have some code that does this but haven't integrated it yet. Happy to share what we have if it sounds of interest.

reportbuilder/Totara thoughts on integration

2014-06-06T01:31:37Z

Simoncoggins: Totara thoughts on integration of report builder into core

Having previously given some thought to merging reportbuilder into Moodle, and as the original author I thought I'd put down some thoughts ideas that might help with the process.

===Areas that may need some work===

1. Group Concat

Report builder has some code to provide a cross-platform version of the mysql only aggregate function group_concat (which lets you aggregate text data by concatenation). As you spotted there is postgres specific code in totara/reportbuilder/db/install.php which creates a new aggregate function. In 2.6 (seedlings code) we added support for MSSQL which proved to be quite difficult. See here for how that is done:

https://github.com/totara/seedlings/blob/totara-seedlings-2.6/totara/mssql/db/install.php

Both the postgres and mssql solutions might be considered a bit "custom" for core moodle.

Also Totara doesn't support Oracle at all so currently there is no Oracle compatibility. There is certainly some work there if you decide that group concat support is wanted. If not you would just need to remove any existing uses of it (activity and tag lists in course source, cohort filters, multiselect custom field type). A search for sql_group_concat should find them all.

2. Embedded reports

Currently all embedded report classes are stored in totara/reportbuilder/embedded/. That's fine for us but in Moodle you will want plugins to be able to define their own embedded reports which they make use of. That will probably mean using autoloading but you will also need a way for the system to discover which embedded reports exist (so you can provide a list on totara/reportbuilder/index.php).

3. Extending sources

This is something that would help us since once report builder is in core we'll need to be able to put back our totara-specific additions. It would be helpful if it was doable without us having to make too many core changes. One thing we will be able to do is extend the existing sources like this:

https://github.com/totara/seedlings/blob/totara-seedlings-2.6/totara/cohort/rb_sources/rb_source_cohort_orphaned_users.php

But it would be great if this could be kept in mind as I'm sure lots of organisations would appreciate an easy way to add their own functionality into existing report sources.

===Potential changes to consider===

The following are all things we've intended to do but not got around to yet. I thought I'd mention them here as they involve API changes, and so if you consider any of them important it would be better to get them in from the start rather than having to make breaking changes later (requiring plugin authors to update their sources).

1. Update filters to use GET instead of POST

This would allow people to use a URL instead of having to create a saved search to point to a particular results set. At the same time I would refactor saved searches to use a table with key/value pairs rather than how it is done right now (serializing filter data in session/database).

2. Modify filter UI

Currently the report creator defines which filters are available and they are all displayed every time (with some set to advanced). We would like to change it so the user can see a list of all filters and then chooses which ones to add (more like JIRA basic search). The main advantages are a cleaner UI and it would make it possible to add extra features such as AND/OR logic and reusing the same filter multiple times in a single report.

3. Refactor Content restrictions by merging with filters.

For historical reasons content restrictions have completely separate code from filters. However they have ended up converging and I think the system would be more flexible if they were combined. All existing content restrictions could be converted to filters fairly easily (they are a bit more dynamic but basically the same). If item 1 above was done then the content tab could just list all available filters and the report creator would add them as a kind of pre-filter. The only difference would be that report users couldn't remove filters that the admin had setup. This would instantly make all the current filters available as content restrictions which would be great!

4. More fine-grained management of reports.

Currently there is one capability that controls the ability to manage all reports. As they get used more its becoming evident that this needs to be more fine-grained. Perhaps reports should use contexts to control who can manage them, or maybe each report should be "owned" by the creator and only them and site admins can edit them. I'm not sure of the best approach but it is clear that the current system is a bit limited.

Related is the list of embedded reports on totara/reportbuilder/index.php. This is already getting quite long for us as it is a site-wide list of all embedded reports. It seems like it will soon need to be split out in some way, either with categories, or separate per-component management areas.

5. Improved support for reusing predefined "groups" of reporting functionality

As you know report sources are quite prescriptive in that the developer must specify exactly what is available. Early on we found the need to reuse some common fields (such as user profile fields) across multiple reports and ended up with helper functions like add_user_fields_to_columns() in rb_base_source.php to achieve that. While predefined sources have got us a long way, we are starting to see requests for more flexibility - people wanting to pull in data from multiple existing sources.

I've been considering how it might be possible to define a group of fields/filters along with any foreign keys that they can join against to make it easier to reuse common code.

===Other potential future features==

Here are a few ideas that we are looking at adding to future versions of report builder.

1. Graphical reporting

It's long been on our roadmap to add support for graphical reports using a front-end javascript graphing library. This is a high priority for us this year so may be something we tackle soon. With report builder going into core we would most likely do this as a contribution to Moodle so would need to go through the normal process for code contributions. Just wanted to give you a heads up that it's on the cards.

2. Separate reporting database connection

Particularly on large sites, big reports can take a while to generate if there's huge amounts of data and multiple complex joins. In 2.5 we added report caching which provides a way to get faster reporting at the expense of real-time results. Another approach we investigated was supported a separate database connection to a read-only slave database specifically for reporting. This has the advantage of reducing load on the main database server. We have some code that does this but haven't integrated it yet. Happy to share what we have if it sounds of interest.

Developer meeting April 2013

2013-07-08T01:18:14Z

Simoncoggins: /* Open Badges (Simon Coggins and Yuliya Bozhko) */

[[Developer meetings]] > April 2013 meeting notes

{| class="nicetable"
|-
| Time
| [http://timeanddate.com/worldclock/fixedtime.html?year=2013&month=4&day=23&hour=13&min=0&sec=0 13:00 UTC on Tuesday, 23 April 2013]
|-
| Meeting room
| [http://www.youtube.com/channel/UCIVdgclkXbw47PSGqqsLccw Moodle Meetings YouTube channel]
|-
| Chat
| [https://moodle.org/local/chatlogs/info.php Regular Dev chat]
|-
| Twitter
| [https://twitter.com/search?q=%23moodledev #moodledev]
|}

In this meeting we focused on the impending Major release.

== Meeting video ==

<mediaplayer>http://www.youtube.com/watch?v=DTuaUjdJQZc</mediaplayer>

== Meeting notes ==

===[https://docs.moodle.org/dev/images_dev/d/d3/hq-teams.pdf News from Moodle HQ] (Martin Dougiamas)===
* New HQ teams are being formed: Front-end, back-end, sites
* New focus and priorities in teams

===[[Moodle_2.5_release_notes|Moodle 2.5]]===
====[https://docs.moodle.org/25/en/New_features New features page]====
* Complements release notes
* Updated for every release
* Screenshots and quick overview
* The page to link to when sharing upcoming features

====[[OpenBadges_User_Documentation|Open Badges]] (Simon Coggins and Yuliya Bozhko)====
* Initiative from Mozilla for achievements across the Web
* Awards a badge that is an image but also a verifiable certificate
* Moodle can award badges and show badges from other sites
* Test site at <s>[http://openbadgestotara.elearning.catalyst.net.nz openbadgestotara.elearning.catalyst.net.nz]</s> Now decommissioned, use demo.moodle.net instead.
* Badges can be awarded at site-wide or course levels
* Create a badge in a course from the Admin menu and provide an image
* Awarded based on completion of course or activity
* Awards can be shared and connected to the Mozilla Backpack
* Mahara may become a Backpack provider in future

====[http://tracker.moodle.org/browse/MDL-38016 Bootstrap themes] (Martin Dougiamas)====
* Framework for responsive sites
* Now a new base theme for a new family of themes
* Will replace current base themes in future
* Not be the default theme in Moodle yet

====[http://tracker.moodle.org/browse/MDL-38509 Installation of new plugins from moodle.org] (David Mudrak)====
* Admin tool in Moodle
* Plugins found in the Directory can be downloaded, validated and installed
* Downloaded zip files can be installed and uninstalled from within Moodle without file access

====[http://tracker.moodle.org/browse/MDL-30637 Short forms] (Ruslan Kabalin and Frédéric Massart)====
* Forms are broken into sections that can collapse
* Fieldsets with required fields, non-validating fields and forced open
* Developers should review all their forms to see that they still make sense
* Editor can be simplified to hide editor toolbars

====[http://tracker.moodle.org/browse/MDL-37009 Consistent course listing display] (Marina Glancy)====
* Course listings are now rendered consistently
* Themes will be affected by this, but theming should be more consistent in the future

====[http://tracker.moodle.org/browse/MDL-15727 jQuery and jQuery UI supported in add-ons] (Petr Škoda)====
* JQuery library now available for plugins
* Not use by core

====[https://tracker.moodle.org/browse/MDL-37127 Shifting our YUI] (Andrew Nicols)====
* [[Javascript/Shifter]]
** Should help to improve documentation and allow unit tests
** JS can be linted for possible errors

====[http://tracker.moodle.org/browse/MDL-35611 Behat tests] (David Monllaó)====
* [[Acceptance testing]]
* Human readable test instructions
* Tests can be run automatically in a browser
* About 100 QA tests have been now automated (more to come) https://tracker.moodle.org/browse/MDLQA-5249
* Some assistance for test writers is provided by a Developer tool in Moodle 2.5
* [https://github.com/marinaglancy/moodle-tool_behatui Behat screenshotting tool]

====[https://tracker.moodle.org/issues/?jql=fixVersion%20in%20(%222.5%22)%20and%20component%20in%20(Assignment)%20and%20type%20%3D%20Improvement Assignment changes in 2.5] (Damyon Wiese)====
* Assignment code now validates with code checker
* More unit tests have been added
* Docs have been updated
* New feature: submission history
** Reattempts (manual or automatic)

===[[Moodle_Mobile_Release_Notes | Mobile app]] (Juan Leyva)===
* New version released with a more versions planned every two months
* App can be styled
* Push notifications to come

===[[GSOC|GSoC]] (Michael de Raadt)===
* Moodle has been accepted as a participating organisation
* Students are starting to submit applications to participate with Moodle
* Students may be found in forums now and in the future

==Attendees==
Adrian Greeve, Amy Groshek, Andrew Nicols, Ankit Agarwal, Anthony Borrow, Aparup Banerjee, Barbara Ramiro, Bas Brands, Damyon Wiese, Dan Poltawski, Daniele Cordella, Darryl Pogue, David Monllaó, David Mudrak, Davo Smith, Eloy Lafuente, Frédéric Massart, Gareth J Barnard, Helen Foster, Howard Miller, Jason Fowler, Jason Hardin, Jenny Gray, Jérôme Mouneyrac, Juan Leyva, Justin Filip, Marina Glancy, Mark Nelson, Martin Dougiamas, Mary Cooch, Mary Evans, Michael Blake, Michael de Raadt, Mike Churchward, Peter Bulmer, Petr Skoda, Rajesh Taneja, Rex Lorenzo, Sam Hemelryk, Sam Marshall, Tim Hunt, Watermark Neilsen, Yuliya Bozhko... (plus many more via YouTube and Twitter)

==Meeting chat log==
<div style="height:300px;overflow:auto;">
{| class="nicetable"
|-
| Moodle HQ
| ok we are going live
| 9:01:28 PM
|-
| Moodle HQ
| can you see us ok?
| 9:01:32 PM
|-
| mary
| yes
| 9:01:47 PM
|-
| Gareth J Barnard
| Yup
| 9:01:47 PM
|-
| Aparup Banerjee
| roger that
| 9:01:49 PM
|-
| Rajesh Taneja
| yes
| 9:01:49 PM
|-
| Juan Leyva
| yes
| 9:01:59 PM
|-
| Davo Smith
| yes
| 9:02:04 PM
|-
| Gareth J Barnard
| Hello all
| 9:02:14 PM
|-
| David Mudrák
| I'm lost
| 9:02:17 PM
|-
| David Mudrák
| shouldn't get an invatation to the hangout?
| 9:02:31 PM
|-
| Jason Fowler
| its working here
| 9:02:38 PM
|-
| Juan Leyva
| juanleyvadelgado@gmail.com
| 9:02:56 PM
|-
| Aparup Banerjee
| the youtube stream is really good here
| 9:03:36 PM
|-
| Ankit Agarwal
| yeah no lag and clear
| 9:03:55 PM
|-
| Dan Poltawski
| anyone get youtube on ipad?
| 9:04:09 PM
|-
| Jason Fowler
| and it.crashed...
| 9:04:17 PM
|-
| Helen Foster
| is michaeld writing notes?
| 9:04:29 PM
|-
| Jason Fowler
| trying on android
| 9:04:29 PM
|-
| Andrew Nicols
| hello
| 9:05:13 PM
|-
| Tim Hunt
| Hi
| 9:05:14 PM
|-
| Mark Nielsen
| Hello all
| 9:05:14 PM
|-
| Rajesh Taneja
| Hello
| 9:05:14 PM
|-
| Sam Hemelryk
| Hiya
| 9:05:15 PM
|-
| Davo Smith
| Hello
| 9:05:15 PM
|-
| Gareth J Barnard
| Hi
| 9:05:16 PM
|-
| Dan Poltawski
| lo
| 9:05:17 PM
|-
| Anthony Borrow
| hi
| 9:05:18 PM
|-
| bmbrands
| hi there
| 9:05:18 PM
|-
| Juan Leyva
| hello
| 9:05:19 PM
|-
| Ankit Agarwal
| hi
| 9:05:20 PM
|-
| Aparup Banerjee
| bye
| 9:05:23 PM
|-
| David Mudrák
| hi
| 9:05:26 PM
|-
| Jenny Gray
| hello
| 9:05:29 PM
|-
| Mark Nielsen
| We have some other folks from Moodlerooms watching as well
| 9:05:46 PM
|-
| Mark Nelson
| hi
| 9:05:48 PM
|-
| mary
| hello!
| 9:05:49 PM
|-
| bmbrands
| hi
| 9:05:56 PM
|-
| Jason Fowler
| can't get it working again
| 9:06:34 PM
|-
| Tim Hunt
| Moodle HQ is a jelly-fish. Suddeny it all makes sense.
| 9:07:16 PM
|-
| Aparup Banerjee
| lol
| 9:08:44 PM
|-
| Andrew Nicols
| heh
| 9:08:47 PM
|-
| bmbrands
|
| 9:08:48 PM
|-
| Gareth J Barnard
| :D
| 9:08:51 PM
|-
| Andrew Nicols
| Nice bit of recursion in the bottom right there
| 9:08:53 PM
|-
| Mary Evans
| is there no Hangout?
| 9:09:23 PM
|-
| Tim Hunt
|
| 9:09:29 PM
|-
| Sam Hemelryk
| Sorry about that not getting there in the end
| 9:12:05 PM
|-
| Andrew Nicols
| Martin: A couple of people asking in comments about how to get invites to the hangout. May be worth re-mentioning #moodledev and here again
| 9:12:28 PM
|-
| Aparup Banerjee
| David, hope you got your google hangout email
| 9:14:00 PM
|-
| David Mudrák
| no
| 9:14:17 PM
|-
| David Mudrák
| that's why I asked for it. I expect MD will add/remove people as needed to keep traffic low
| 9:15:04 PM
|-
| Aparup Banerjee
| clearly
| 9:15:07 PM
|-
| bmbrands
| yes
| 9:15:09 PM
|-
| Gareth J Barnard
| Yes
| 9:15:12 PM
|-
| Rajesh Taneja
| yes
| 9:15:12 PM
|-
| mary
| yes
| 9:15:14 PM
|-
| Yuliya Bozhko
| here
| 9:15:25 PM
|-
| Dan Poltawski
| (wow i'm seemingly lagging behind by quite a way)
| 9:15:28 PM
|-
| Moodle HQ
| waves
| 9:15:36 PM
|-
| Ankit Agarwal
| yeah me too as well
| 9:15:39 PM
|-
| Aparup Banerjee
| Hi Yuliya
| 9:15:49 PM
|-
| Andrew Nicols
| Moodle Meetings: Few people asking about where chat is
| 9:16:01 PM
|-
| Marina Glancy
| ÐŸÑ€Ð¸Ð²ÐµÑ‚ Ð®Ð»Ñ
| 9:16:02 PM
|-
| Dan Poltawski
| yep
| 9:16:32 PM
|-
| Dan Poltawski
| (hehe I am responding to stuff which seemingly happened ages ago)
| 9:16:44 PM
|-
| Tim Hunt
| Dan, reload the you-tube page?
| 9:17:03 PM
|-
| Dan Poltawski
| then i'll miss some!
| 9:17:12 PM
|-
| Moodle HQ
| David, invited you again
| 9:17:14 PM
|-
| David Mudrák
| what email did you use? Got nothing
| 9:17:36 PM
|-
| Mark Nelson
| Have you tried to click on the 'Live' wording on the video?
| 9:17:38 PM
|-
| Dan Poltawski
| just tried it
| 9:17:45 PM
|-
| Moodle HQ
| what would you like David?
| 9:17:50 PM
|-
| Tim Hunt
| open2study, the Australian MOOC platform, has crazy numbers of badges for really trivial things.
| 9:18:32 PM
|-
| Tim Hunt
| LOL
| 9:19:24 PM
|-
| Dan Poltawski
| i'm just seeing simon doing the demo now. How far behind am I?
| 9:19:27 PM
|-
| Tim Hunt
| How long was that URL?
| 9:19:28 PM
|-
| Aparup Banerjee
| can't wait for openbadges on moodle.org
| 9:19:44 PM
|-
| Moodle HQ
| Yes, helen you should start plannig some
| 9:19:58 PM
|-
| Aparup Banerjee
| it just switched to the moodlesite for me 10 secs ago
| 9:20:00 PM
|-
| Ankit Agarwal
| Dan P: a few seconds assuming am not lagging myself
| 9:20:05 PM
|-
| Dan Poltawski
| thanks
| 9:20:20 PM
|-
| Rex Lorenzo
| this is the url: http://openbadgestotara.elearning.catalyst.net.nz/
| 9:20:21 PM
|-
| Moodle HQ
| for us simon just started talking about site/course badges
| 9:20:28 PM
|-
| Anthony Borrow
| I wonder if MoodleRooms is working on a Common Core -> OpenBadges ecosystem
| 9:20:33 PM
|-
| Dan Poltawski
| Rex" looks like it
| 9:20:45 PM
|-
| Yuliya Bozhko
| https://docs.moodle.org/dev/OpenBadges_User_Documentation - documentation that has links to our test site with accounts you can use to try out badges
| 9:21:35 PM
|-
| Mark Nielsen
| @aborrow We are not working on that atm
| 9:21:38 PM
|-
| Moodle HQ
| 66 viewers on Youtube
| 9:21:57 PM
|-
| Jason Fowler
| @@
| 9:22:02 PM
|-
| Aparup Banerjee
| 41 in here
| 9:22:14 PM
|-
| Dan Poltawski
| 10 of those are mine
| 9:22:17 PM
|-
| Ankit Agarwal
| lol
| 9:22:40 PM
|-
| Rex Lorenzo
| Is there a login we can use to access the demo site?
| 9:24:37 PM
|-
| Dan Poltawski
| Rex: pretty sure it was posted on the forums
| 9:25:00 PM
|-
| Yuliya Bozhko
| it's in the docs
| 9:25:00 PM
|-
| Dan Poltawski
| looking
| 9:25:01 PM
|-
| Rex Lorenzo
| Got it
| 9:25:12 PM
|-
| Dan Poltawski
| Rex: you can also download and install 2.5
| 9:25:27 PM
|-
| Rex Lorenzo
| But you need to setup an open badge API
| 9:26:23 PM
|-
| Andrew Nicols
| Just seen the time at the top of Simon's laptop
| 9:26:26 PM
|-
| Rex Lorenzo
| Oh.. I can just use the default settings I guess
| 9:26:43 PM
|-
| mary
| wow yes Wed 1.25 am
| 9:26:57 PM
|-
| Yuliya Bozhko
| yeah, 1am here
| 9:26:59 PM
|-
| mary
| UK/Europe has the best time
| 9:27:12 PM
|-
| Moodle HQ
| Thanks Kiwis
| 9:27:15 PM
|-
| Aparup Banerjee
| youtube live streams can be played back again right
| 9:28:21 PM
|-
| Mark Nelson
| Rex: You can create badges without syncing them with Mozilla.
| 9:28:22 PM
|-
| Dan Poltawski
| hope you didn't have to come home from moodle moot party early
| 9:28:36 PM
|-
| Yuliya Bozhko
| nope, we have another person from out team presenting there
| 9:29:05 PM
|-
| Andrew Nicols
| FYI Stacey Walker @ Catalyst Europe is working on a Persona auth integration for moodle
| 9:30:39 PM
|-
| Aparup Banerjee
| does this integrate with oauth for moodle?
| 9:30:52 PM
|-
| Yuliya Bozhko
| I don't think so
| 9:31:41 PM
|-
| Dan Poltawski
| its not really the same
| 9:31:55 PM
|-
| bmbrands
| would be cool to have users compete for a badge
| 9:31:57 PM
|-
| Andrew Nicols
| bmbrands, like employee of the month stype thing?
| 9:32:26 PM
|-
| Aparup Banerjee
| Dan P: what do you mean?
| 9:32:44 PM
|-
| bmbrands
| @a.nicols: yes why not
| 9:33:02 PM
|-
| Andrew Nicols
| And "Top five contributors" type stuff
| 9:33:31 PM
|-
| Jenny Gray
| could be useful for reputation management stuff - a bit like our useful moodlers group too
| 9:34:06 PM
|-
| Dan Poltawski
| great work!
| 9:34:16 PM
|-
| Yuliya Bozhko
| thanks
| 9:34:32 PM
|-
| mary
| thanks Yuliya
| 9:34:44 PM
|-
| Mark Nielsen
| Do you loose course badges if a course is deleted?
| 9:35:15 PM
|-
| Ankit Agarwal
| isnt the badges like a permanent thing? can they be taken away?
| 9:35:43 PM
|-
| Yuliya Bozhko
| no, you don't, all issued badges belong to users
| 9:35:48 PM
|-
| Aparup Banerjee
| does it have to be synced/sent to external site?
| 9:36:06 PM
|-
| Aparup Banerjee
| (regularly)
| 9:36:14 PM
|-
| Yuliya Bozhko
| no, you don't have to use anything if you don't want them in Mozilla backpack
| 9:36:40 PM
|-
| bmbrands
| suddenly I feel like having a pizza
| 9:36:51 PM
|-
| Andrew Nicols
| Funny that
| 9:37:06 PM
|-
| Aparup Banerjee
| thanks yuliya
| 9:37:20 PM
|-
| Rex Lorenzo
| How difficult is it to maintain 2 core themes now? Is the goal to eventually move to bootstrap as the single core theme?
| 9:37:27 PM
|-
| Tim Hunt
| Yes
| 9:37:36 PM
|-
| Yuliya Bozhko
| Someone asking on Twitter: If a course disappears is the badge revoked? Answer: No, there is no such thing as revocation of badges at the moment. I think Mozilla team is working on it, but currently an issued badge cannot be revoked.
| 9:40:20 PM
|-
| Mark Nielsen
| Is bootstrap being used for the layouts as well? EG: the columns for blocks, etc
| 9:40:22 PM
|-
| bmbrands
| watermark: yes using bootstrap grids
| 9:40:46 PM
|-
| Rex Lorenzo
| Yuliya, will the badge still be verified as being valid?
| 9:41:03 PM
|-
| bmbrands
| Bootstrap can be used for plugin development too.
| 9:41:26 PM
|-
| Amy Groshek
| Thanks everyone for your hard work on bootstrap!
| 9:41:34 PM
|-
| bmbrands
| Not in the hangout
| 9:41:40 PM
|-
| Gareth J Barnard
| When will the folder name 'bootstrap' be changed to 'bootstrapbase'?
| 9:41:49 PM
|-
| Mark Nielsen
| @bmbrands what do you mean in regards to plugin dev?
| 9:41:57 PM
|-
| Rex Lorenzo
| Should we bring up the less/sass issue?
| 9:41:58 PM
|-
| Jason Hardin
| will the core renderers be rewritten to match bootstrap?
| 9:42:02 PM
|-
| Jason Hardin
| or will they continue to be overridden by bootstrap?
| 9:42:11 PM
|-
| Gareth J Barnard
| Thanks Martin
| 9:42:16 PM
|-
| Rex Lorenzo
| https://tracker.moodle.org/browse/MDL-38160
| 9:42:25 PM
|-
| bmbrands
| I'll be presenting about "beyond bootstrap" on the iMoot
| 9:42:38 PM
|-
| Rex Lorenzo
| Very much like YUI shifter in terms of the new dev workflow
| 9:43:03 PM
|-
| Tim Hunt
| JAson, the way it was summarised to me: where there are sensible changes, like adding a consistent class name to all cancel buttons, they will be done in core. WHere it is a bit bootstrap-specific then it will not be done in core.
| 9:43:13 PM
|-
| Amy Groshek
| @Rex has a good point; there is a less vs sass discussion going on there
| 9:43:21 PM
|-
| Andrew Nicols
| cue questions about what Shifter is ;)
| 9:43:28 PM
|-
| Gareth J Barnard
| There is a FireBug addon called FireLess that can be used for debugging Less.
| 9:43:42 PM
|-
| Jason Hardin
| will the be used for icons?
| 9:44:01 PM
|-
| mary
| who are just out of the picture in the Moodle meeting room?
| 9:44:06 PM
|-
| Tim Hunt
| Jason, that one is insane, I think.
| 9:44:12 PM
|-
| Jason Hardin
| meaning moving towards the use of css icons?
| 9:44:19 PM
|-
| bmbrands
| Bootswatches are worth mentioning too
| 9:44:31 PM
|-
| Amy Groshek
| Yes, what is the timeline for bootswatch import?
| 9:44:50 PM
|-
| Aparup Banerjee
| can a plugin that uses bootstrap+less be used with a theme that isn't based on bootstrap?
| 9:44:57 PM
|-
| bmbrands
| variables and css
| 9:45:07 PM
|-
| bmbrands
| very easy to us
| 9:45:20 PM
|-
| mary
| ah thanks
| 9:45:31 PM
|-
| marxjohnson00
| Aparup Yes, but it wouldn't get the bootstrap styling
| 9:45:38 PM
|-
| bmbrands
| aparup: depends, if you want to use javascript elements no.
| 9:45:55 PM
|-
| Marina Glancy
| afaik less has to be compiled anyway
| 9:46:06 PM
|-
| Gareth J Barnard
| I think you can used Less to generate any css either pre-compiled or client side with JS on the fly.
| 9:46:26 PM
|-
| Aparup Banerjee
| ie: new plugin with styles.css using less + moodle site with old theme that isn't based on bootstrap.
| 9:46:58 PM
|-
| Aparup Banerjee
| ah thanks Bas
| 9:47:03 PM
|-
| Andrew Nicols
| Will the new moodle.org (theme) be based on the new bootstrap theme?
| 9:47:06 PM
|-
| Amy Groshek
| Yes, .less files are not loaded live by the theme. It's more a matter of the development workflow.
| 9:47:08 PM
|-
| Anatai
| both less and scss need to be compiled to css, but less can also be interpreted client side (slower) for testing
| 9:47:09 PM
|-
| Amy Groshek
| You can do it client side but that's not a good idea for a live site.
| 9:47:22 PM
|-
| Andrew Nicols
| not yet
| 9:48:05 PM
|-
| bmbrands
| No only pizaa
| 9:48:06 PM
|-
| Aparup Banerjee
| no screen
| 9:48:06 PM
|-
| Andrew Nicols
| yup
| 9:48:07 PM
|-
| Tim Hunt
| I can see Martin eating Pizza
| 9:48:10 PM
|-
| Aparup Banerjee
| got it
| 9:48:10 PM
|-
| Gareth J Barnard
| But you can tinker client side with FireLess and then use 'recess' when happy for production.
| 9:48:12 PM
|-
| Tim Hunt
| Git it now.
| 9:48:13 PM
|-
| bmbrands
| ah yes
| 9:48:13 PM
|-
| Dan Poltawski
| yep
| 9:48:20 PM
|-
| Rajesh Taneja
| yes
| 9:48:21 PM
|-
| Gareth J Barnard
| @Bas Is there still more testing to do on Bootstrap in 2.5?
| 9:48:56 PM
|-
| mary
| yes
| 9:48:58 PM
|-
| Amy Groshek
| I'm not sure that tinkering is necessary when you can set recess to watch all of your less files for changes and automatically recompile your css.
| 9:49:06 PM
|-
| Justin Filip
| Again, similar to Shifter, as Andrew mentioned earlier. =)
| 9:49:21 PM
|-
| Gareth J Barnard
| @Amy but with FireLess you can debug client side to understand where to make the changes.
| 9:49:50 PM
|-
| bmbrands
| gjbarnard: not too much, but testing with addon plugins would be interesting
| 9:50:11 PM
|-
| Aparup Banerjee
| just notices G+ watermark on video
| 9:50:12 PM
|-
| Gareth J Barnard
| @Bas Ta, I can make a start with the course format's I'm responsible for,
| 9:50:42 PM
|-
| Dan Poltawski
| :D
| 9:51:26 PM
|-
| Dan Poltawski
| this is awesome
| 9:51:32 PM
|-
| bmbrands
| That would be very helpful, I think bootstrap would be very interesting for creating new courseformat too using bootstrap javascript
| 9:51:49 PM
|-
| Gareth J Barnard
| @Bas Interesting concept - what sort of layout do you have in mind?
| 9:52:30 PM
|-
| Amy Groshek
| Just discovered the "Large player" button on the youtube stream (hides youtube chat and makes video larger)
| 9:52:31 PM
|-
| marxjohnson00
| What sever setup is required for this plugin installation to work over and above what's already required by Moodle?
| 9:52:34 PM
|-
| Tim Hunt
| If malicious functions are used, I hope this woudl not get into teh plugins DB!
| 9:52:38 PM
|-
| Jenny Gray
| install adins: does it warn or could you set it to fail if the plugin isn't MATURITY_STABLE?
| 9:52:52 PM
|-
| Dan Poltawski
| marxjohnson00: shouldn't be anything unusual
| 9:52:59 PM
|-
| Dan Poltawski
| (same as repsoitory plugins etc)
| 9:53:06 PM
|-
| Rex Lorenzo
| If you delete a plugin, does it now delete the files? Before Moodle would tell you that you need to delete the files yourself
| 9:53:11 PM
|-
| Anthony Borrow
| @timhunt - yes I would like to see some type of warning/notice about installing plugins
| 9:53:11 PM
|-
| Mark Nielsen
| Would this installer find dependencies?
| 9:53:21 PM
|-
| Gareth J Barnard
| @Bas PMme with idea's and I'd be glad to help with a new course format.
| 9:53:22 PM
|-
| Rex Lorenzo
| It should, plugins can define dependancies
| 9:53:37 PM
|-
| marxjohnson00
| Dan P: Does it store them in moodledata dir then?
| 9:53:39 PM
|-
| bmbrands
| @gareth: sure, lets focus on this stuff by David
| 9:53:54 PM
|-
| Anthony Borrow
| @jennygray - we do this with core, it seems consistent to provide a similar warning of beta quality or less for plugins
| 9:53:54 PM
|-
| Justin Filip
| Does this support pulling in packages from a source other than moodle.org ?
| 9:53:56 PM
|-
| Dan Poltawski
| marxjohnson00: ah, no. You need to allow the webserver to write the plugin directories
| 9:53:58 PM
|-
| marxjohnson00
| right
| 9:54:02 PM
|-
| marxjohnson00
| cheers
| 9:54:04 PM
|-
| Aparup Banerjee
| its the same process of a normal download and unzip + upgrade moodle
| 9:54:16 PM
|-
| Dan Poltawski
| watermark.nielsen: good question
| 9:54:19 PM
|-
| Anthony Borrow
| excellent - glad to see the acknowledgement notice, well done!
| 9:54:22 PM
|-
| Gareth J Barnard
| Cool
| 9:55:08 PM
|-
| Anatai
| I really like the pre-check before install, great touch.
| 9:55:13 PM
|-
| Aparup Banerjee
| dependencies show up as little red requirements in upgrade screen
| 9:55:15 PM
|-
| Rex Lorenzo
| Uninstall also deletes files, right?
| 9:55:19 PM
|-
| Anthony Borrow
| great explanation David
| 9:55:20 PM
|-
| Dan Poltawski
| Marks question^ does it auto get the the dependencies?
| 9:55:28 PM
|-
| bmbrands
| Since almost all plugins are on Github it would be great to see some update method or standards when publishing new plugin versions
| 9:55:31 PM
|-
| Rex Lorenzo
| You can download github as zip
| 9:55:49 PM
|-
| Davo Smith
| Moodle.org can pull in from github already
| 9:55:58 PM
|-
| bmbrands
| Yes but the developer needs to create a zip, upload to the plugin database etc.
| 9:56:13 PM
|-
| Justin Filip
| Okay, thanks.
| 9:56:13 PM
|-
| Davo Smith
| Go to 'add new version' and click on 'add'
| 9:56:14 PM
|-
| Aparup Banerjee
| oh nope doesn't auto get dependent plugins afaik.
| 9:56:47 PM
|-
| Davo Smith
| bmbrands - no pull in directly from github, by using the 'github' repo when adding a new version
| 9:56:48 PM
|-
| Dan Poltawski
| bmbrands: https://moodle.org/mod/forum/discuss.php?d=222164
| 9:56:48 PM
|-
| Rex Lorenzo
| Validator functions? Such as?
| 9:57:06 PM
|-
| Gareth J Barnard
| Is it easy to write an uninstall script in the plugin to remove custom DB tables?
| 9:57:42 PM
|-
| bmbrands
| @dan: Cool
| 9:57:43 PM
|-
| Jason Hardin
| is there a roll back function?
| 9:58:05 PM
|-
| Rex Lorenzo
| Very good. Easier to try out new plugins. I don't have to do our whole git workflow to put plugins on our test server.
| 9:58:10 PM
|-
| Dan Poltawski
| Gareth J Barnard: it is done automatically by xmldb
| 9:58:11 PM
|-
| Jason Hardin
| to keep the plugin but downgrade/
| 9:58:12 PM
|-
| Rex Lorenzo
| Jason, cannot rollback any updates on Moodle.
| 9:58:25 PM
|-
| Gareth J Barnard
| @Dan - Very COOL :D - Thanks.
| 9:58:27 PM
|-
| Mark Nelson
| Downgrading requires the upgrade.php file to reverse what it has done, so no.
| 9:58:39 PM
|-
| Davo Smith
| Gareth, or you can use: https://docs.moodle.org/dev/Upgrade_API#uninstall.php if anything is not covered
| 9:58:40 PM
|-
| Gareth J Barnard
| @Davo Thanks
| 9:59:00 PM
|-
| Tim Hunt
| I did not see the UI screen that gets you to sign in blood that you have made a backup before you start.
| 9:59:03 PM
|-
| Dan Poltawski
| timhunt: there is a tickbox
| 9:59:26 PM
|-
| Aparup Banerjee
| bmbrands: i think the solution there is the github repository for uploading to Plugins directory. if its just to try/test perhaps there could be an alternative url that can be entered to fetch a zip from.
| 9:59:28 PM
|-
| Tim Hunt
| Good
| 9:59:36 PM
|-
| Dan Poltawski
| although it might not be there from the plugins directory route atm
| 9:59:39 PM
|-
| Davo Smith
| I can see that going wrong just a bit too often ....
| 10:00:23 PM
|-
| Dan Poltawski
| ^ wahey
| 10:00:31 PM
|-
| marxjohnson00
| That would be nice, but terrifying
| 10:00:35 PM
|-
| Dan Poltawski
| hehe
| 10:00:40 PM
|-
| bmbrands
| Yes, could get annoying having updates weekly
| 10:00:45 PM
|-
| marxjohnson00
| I'd need to write a lot of unit tests before I was comfortable doing that
| 10:00:55 PM
|-
| bmbrands
| Cool stuff David
| 10:01:01 PM
|-
| Rex Lorenzo
| There can be a contact developer button about problems. Or "Send a crash report", lol.
| 10:01:10 PM
|-
| Gareth J Barnard
| Thanks David
| 10:01:23 PM
|-
| David Mudrák
| thanks. Apu should get half of the credit for sure, this was a real team project.
| 10:01:38 PM
|-
| bmbrands
| I have made a "microsoft clippy" block for that, still hoping it will be core one day
| 10:01:45 PM
|-
| Ruslan Kabalin
| Sorry guys, just learned 10 mins ago that I am supposed to present something... do not have mic and did not have chance to prepare
| 10:01:50 PM
|-
| Tim Hunt
| Martin, just demo it!
| 10:02:06 PM
|-
| Dan Poltawski
| MArtin: ^
| 10:02:09 PM
|-
| Ruslan Kabalin
| I can comment here though
| 10:02:22 PM
|-
| Eloy Lafuente (stronk7)
| marTIN: ^^
| 10:02:25 PM
|-
| Dan Poltawski
| use QA site
| 10:02:35 PM
|-
| Dan Poltawski
| (or someting on integration)
| 10:02:45 PM
|-
| Andrew Nicols
| It may also be worth demoing the collapsed editor
| 10:02:45 PM
|-
| Dan Poltawski
| hehe
| 10:03:27 PM
|-
| Dan Poltawski
| try chat
| 10:03:43 PM
|-
| Tim Hunt
| Or quiz
| 10:03:53 PM
|-
| Jason Hardin
| for 2.6 will there be a focus on important fields showing not the whole section?
| 10:04:31 PM
|-
| Rex Lorenzo
| Hmm.. yeah something important, but not required
| 10:04:52 PM
|-
| Jason Hardin
| right
| 10:05:12 PM
|-
| Rex Lorenzo
| Oh, I like the collapsed editor
| 10:05:19 PM
|-
| Andrew Nicols
| Demo adding a new Multiple Choice question
| 10:05:22 PM
|-
| Jason Hardin
| the idea is to initially have all the fields that are most commonly used
| 10:05:25 PM
|-
| Jason Hardin
| shown
| 10:05:27 PM
|-
| Tim Hunt
| The heuristic is: Forms with more than 2 sections: any section after the first is collapsed by default.
| 10:05:35 PM
|-
| Jason Hardin
| then i expand what I need to add
| 10:05:36 PM
|-
| Andrew Nicols
| ah - some in there too
| 10:05:37 PM
|-
| David Mudrák
| jennygray: there is warning for anything lower than MATURITY_STABLE
| 10:05:44 PM
|-
| Tim Hunt
| Right, Jason.
| 10:05:47 PM
|-
| Dan Poltawski
| Jason Hardin: Fred hsa been reworking a lot of the forms in addition to the other work
| 10:05:58 PM
|-
| Jason Hardin
| It is more than that Dan
| 10:06:16 PM
|-
| bmbrands
| I love the editor toggle
| 10:06:18 PM
|-
| Tim Hunt
| Easy to override the default.
| 10:06:19 PM
|-
| Jason Hardin
| If there were an api like advanced
| 10:06:22 PM
|-
| Anthony Borrow
| any thought to add that new tinymce option for comments?
| 10:06:24 PM
|-
| Jason Hardin
| that a dev can tag a fields as "initial" or "important"
| 10:06:39 PM
|-
| Dan Poltawski
| Jason Hardin: I don't see it happening any time soon
| 10:06:51 PM
|-
| Tim Hunt
| Jason, we already have show advanced.
| 10:06:57 PM
|-
| Rex Lorenzo
| Jason, in the assignment plugin, the submission type section is made to be opened by default, but none of those options are required. So it is possible to define what sections to leave open
| 10:07:03 PM
|-
| Rex Lorenzo
| vs collapsed
| 10:07:06 PM
|-
| Dan Poltawski
| there is only so much we can add onto the existing forms library, this is part of the way forward
| 10:07:15 PM
|-
| Jason Hardin
| @tim yeah i know that but we dont' have important or initial as a concept
| 10:07:21 PM
|-
| Jason Hardin
| advanced is used to hide settings
| 10:07:34 PM
|-
| Sam Hemelryk
| Oh hurrah! policy bugs
| 10:07:34 PM
|-
| Rex Lorenzo
| Dan, any followup on the idea of replacing quickforms?
| 10:07:36 PM
|-
| Jason Hardin
| this would be used to show inputs
| 10:07:40 PM
|-
| Tim Hunt
| Jason, re-arrange your form to move the important stuff to the top.
| 10:07:42 PM
|-
| Dan Poltawski
| https://tracker.moodle.org/browse/MDL/component/12733
| 10:07:50 PM
|-
| Dan Poltawski
| https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20component%20%3D%20Policy%20AND%20status%20%3D%20Open%20ORDER%20BY%20priority%20DESC
| 10:08:06 PM
|-
| Tim Hunt
| Thank Colin Chambers for the collapsed editor
| 10:08:10 PM
|-
| Jason Hardin
| @tim that defeats the purpose of grouping fields by identifiable names
| 10:08:11 PM
|-
| Amy Groshek
| Interesting, but it's not toggling between HTML raw and wysiwyg, both are wysiwyg...
| 10:08:21 PM
|-
| Amy Groshek
| So to get to HTML I have to show the editor and then select HTML view... I have more steps than before...
| 10:08:42 PM
|-
| Aparup Banerjee
| if only politicians had bugs.
| 10:08:45 PM
|-
| bmbrands
| @amy: would be nice to have a raw tab for that
| 10:09:02 PM
|-
| Ruslan Kabalin
| my pleasure
| 10:09:18 PM
|-
| Marina Glancy
| hello
| 10:09:50 PM
|-
| Marina Glancy
| can I just type?
| 10:09:58 PM
|-
| Petr Škoda
| lol
| 10:10:14 PM
|-
| Marina Glancy
| Basically in 2.5 all course listings will go through renderer. I made screenshots https://www.dropbox.com/sh/ytgtceoahiw5m6u/2tFpM389pW#/
| 10:10:36 PM
|-
| Rex Lorenzo
| Why aren't they using the QA site?
| 10:11:13 PM
|-
| Marina Glancy
| Rex, who are they?
| 10:11:25 PM
|-
| Marina Glancy
| We still might correct some CSS things there
| 10:12:00 PM
|-
| bmbrands
| Great to have images there, they could be used to create icon buttons for mobile
| 10:12:00 PM
|-
| Marina Glancy
| By the way, screenshots are made using https://github.com/marinaglancy/moodle-tool_behatui
| 10:12:34 PM
|-
| Tim Hunt
| How does that look with 2000 courses?
| 10:12:51 PM
|-
| Marina Glancy
| there are settings that limit the number of courses per page
| 10:13:06 PM
|-
| bmbrands
| @tim: isn't the limit set to 200 ?
| 10:13:11 PM
|-
| Davo Smith
| looks like I'm going to have to catch up with the rest of this later - time for the school run; see you all later
| 10:13:20 PM
|-
| Tim Hunt
| No. The OU has many courses.
| 10:13:22 PM
|-
| Dan Poltawski
| ciao Davo
| 10:13:30 PM
|-
| Marina Glancy
| more about settings: https://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
| 10:14:15 PM
|-
| Tim Hunt
| Where are the developer docs for what might break?
| 10:14:18 PM
|-
| Tim Hunt
| Ah!
| 10:14:19 PM
|-
| Tim Hunt
| Thanks.
| 10:14:20 PM
|-
| Dan Poltawski
| hehe
| 10:15:17 PM
|-
| Andrew Nicols
| There is a new JS side to it which hasn't yet landed
| 10:15:26 PM
|-
| Marina Glancy
| unfortunately it was not possible to keep old css because it was different everywhere
| 10:15:28 PM
|-
| Marina Glancy
| no, that's it. thanks
| 10:15:51 PM
|-
| Dan Poltawski
| there is a bit of lag here I think Martin (you keep giving up on us saying stuff)
| 10:16:09 PM
|-
| Andrew Nicols
| Yup - it lets you drill down, and loads the course information on the page
| 10:16:22 PM
|-
| Tim Hunt
| Hi!
| 10:17:09 PM
|-
| Dan Poltawski
| aergh!
| 10:17:18 PM
|-
| Gareth J Barnard
| Hi Petr
| 10:17:20 PM
|-
| Aparup Banerjee
| i didn't know he was moving in that close!
| 10:17:32 PM
|-
| Moodle HQ
| I think he's trying to look scary
| 10:17:36 PM
|-
| Andrew Nicols
| It's the light that makes it particularly scary
| 10:18:24 PM
|-
| Jenny Gray
| presumably we might move up to jquery 2.x when Moodle decides to drop support for older IE versions though?
| 10:19:17 PM
|-
| Dan Poltawski
| https://docs.moodle.org/dev/jQuery
| 10:19:37 PM
|-
| Jason Hardin
| I thought only IE 9+ was supported?
| 10:19:48 PM
|-
| Eloy Lafuente (stronk7)
| Prototype added for 2.6?
| 10:19:57 PM
|-
| Jason Hardin
| why is jQuery worried about IE 6?
| 10:19:59 PM
|-
| Anatai
| currently IE 8+ supported
| 10:20:05 PM
|-
| Andrew Nicols
| Jason Hardin, We support IE8
| 10:20:06 PM
|-
| Andrew Nicols
| FYI YUI supports back to IE6
| 10:20:17 PM
|-
| Jason Hardin
| sigh
| 10:20:33 PM
|-
| Eloy Lafuente (stronk7)
| Mootools for 2.7 ?
| 10:20:34 PM
|-
| Dan Poltawski
| Like Petr says, we're not intentionally breaking IE support
| 10:20:41 PM
|-
| Eloy Lafuente (stronk7)
| Dojo for 2.8?
| 10:20:42 PM
|-
| Amy Groshek
| @Eloy, ha ha
| 10:20:53 PM
|-
| Andrew Nicols
| jennygray, Not necessarily, but maybe. Althoughwe'll drop support for IE8 soon, we'll still try our best to make things work
| 10:20:56 PM
|-
| Andrew Nicols
| Hopefully the recent changes to use Shifter will help there too
| 10:21:15 PM
|-
| Jenny Gray
| OU still supporting IE7 in the "try our best" mode
| 10:21:18 PM
|-
| Andrew Nicols
| I can if you want
| 10:21:42 PM
|-
| Amy Groshek
| YUI resets/normalizr
| 10:21:43 PM
|-
| Moodle HQ
| gmail addres andrew?
| 10:21:50 PM
|-
| Tim Hunt
| Let Andrew talk
| 10:21:50 PM
|-
| Andrew Nicols
| andrewrn@gmail.com
| 10:21:55 PM
|-
| Andrew Nicols
| though Petr has covered most of it
| 10:22:09 PM
|-
| Andrew Nicols
| It will help us to write better API docs for our JS, and unit tests
| 10:22:39 PM
|-
| Aparup Banerjee
| nice coer of it too
| 10:22:43 PM
|-
| Aparup Banerjee
| *cover
| 10:22:47 PM
|-
| Tim Hunt
| Andrew, what is that good YUI theatre talk about YUI modules?
| 10:22:52 PM
|-
| Tim Hunt
| It is worth it!
| 10:23:16 PM
|-
| Andrew Nicols
| ermm...
| 10:23:22 PM
|-
| Andrew Nicols
| The one from Ubuntu One?
| 10:23:36 PM
|-
| Andrew Nicols
| Foxxtrot
| 10:23:40 PM
|-
| bmbrands
| yes
| 10:24:00 PM
|-
| Dan Poltawski
| Moodle 2.5: 'we're sick of the wussy windows devs' :P
| 10:24:01 PM
|-
| mary
| great job tweeting by tsala
| 10:24:07 PM
|-
| Ankit Agarwal
| yes we can
| 10:24:09 PM
|-
| Tim Hunt
| Shifter works fine on Windows
| 10:24:14 PM
|-
| Amy Groshek
| @Andrew love the haircut. Very nice.
| 10:24:14 PM
|-
| Mark Nelson
| Wow, cut your hair.
| 10:24:15 PM
|-
| Aparup Banerjee
| hairloss!
| 10:24:16 PM
|-
| Mike Churchward
| Holy crap! New man!
| 10:24:27 PM
|-
| Justin Filip
| Wowâ€¦ Mod Andrew. =)
| 10:24:35 PM
|-
| Tim Hunt
| If anyone wants to encorage Andrew's hair loss: http://www.justgiving.com/andrewnicols
| 10:24:56 PM
|-
| Dan Poltawski
| lol, the most commented on thing so far this meeting
| 10:24:57 PM
|-
| mary
| I liked the poneytail! But understand the reasons for haircut
| 10:25:05 PM
|-
| mary
| lol
| 10:25:09 PM
|-
| Petr Škoda
| linting - yay!
| 10:26:08 PM
|-
| Sam Hemelryk
| (
| 10:26:12 PM
|-
| Tim Hunt
| I learned a lot from the lint output.
| 10:26:21 PM
|-
| Eloy Lafuente (stronk7)
| I used to understand him better with the long hair, uhm...
| 10:26:30 PM
|-
| Tim Hunt
| Well, you just add Y.log statements to you code for development.
| 10:26:57 PM
|-
| Tim Hunt
| Then, they don't appear in the finished code for people not in dev debug mode.
| 10:27:09 PM
|-
| Aparup Banerjee
| Eloy: you need mod_rmaccent
| 10:27:30 PM
|-
| Petr Škoda
| https://docs.moodle.org/dev/jQuery is the jQuery docs page
| 10:27:32 PM
|-
| Mark Nelson
| What shampoo do you use?
| 10:27:34 PM
|-
| Justin Filip
| Andrew's so dreamy!
| 10:27:48 PM
|-
| Dan Poltawski
| wow, thats a good colour in your face now!
| 10:28:00 PM
|-
| Aparup Banerjee
| LOL
| 10:28:08 PM
|-
| Mark Nelson
| I keep thinking I am watching a shampoo commercial on youtube
| 10:28:15 PM
|-
| Dan Poltawski
| I can see ruslan trying to get in the picture
| 10:28:20 PM
|-
| Dan Poltawski
| with his arms
| 10:28:22 PM
|-
| mary
| lol
| 10:28:23 PM
|-
| Andrew Nicols
| https://docs.moodle.org/dev/YUI https://docs.moodle.org/dev/Javascript/Shifter
| 10:28:48 PM
|-
| Gareth J Barnard
| Get LANCs to change the paint colour!
| 10:28:51 PM
|-
| Andrew Nicols
| And https://docs.moodle.org/dev/YUI/Modules is in progress
| 10:28:56 PM
|-
| Dan Poltawski
| its gone dark
| 10:29:19 PM
|-
| Dan Poltawski
| https://docs.moodle.org/dev/Acceptance_testing
| 10:30:56 PM
|-
| Martin Dougiamas
| Are you hearing David ok?
| 10:31:34 PM
|-
| Dan Poltawski
| yep
| 10:31:36 PM
|-
| Ankit Agarwal
| yes
| 10:31:42 PM
|-
| Gareth J Barnard
| yep
| 10:31:43 PM
|-
| Eloy Lafuente (stronk7)
| best english in the season!
| 10:31:43 PM
|-
| David Mudrák
| yes
| 10:31:44 PM
|-
| Dan Poltawski
| (I am used to his spanish accent )
| 10:31:48 PM
|-
| Mark Nelson
| season, or session?
| 10:31:55 PM
|-
| Eloy Lafuente (stronk7)
| year*
| 10:32:01 PM
|-
| Eloy Lafuente (stronk7)
|
| 10:32:02 PM
|-
| Mark Nelson
| lol
| 10:32:05 PM
|-
| Andrew Nicols
| Martin Dougiamas, Where were you suggesting I add the links to the new docs?
| 10:32:24 PM
|-
| Helen Foster
| David sounds great!
| 10:32:45 PM
|-
| Martin Dougiamas
| The April 2013 dev meeting page
| 10:32:46 PM
|-
| Andrew Nicols
| will do
| 10:32:53 PM
|-
| Martin Dougiamas
| Thanks!
| 10:33:05 PM
|-
| bmbrands
| could this be used to create performance tests too? this looks easier than doing jmeter scripts.
| 10:33:32 PM
|-
| Dan Poltawski
| bmbrands: no
| 10:33:44 PM
|-
| Rex Lorenzo
| It wouldn't make sense to time the tests as a performance indicator?
| 10:34:04 PM
|-
| Dan Poltawski
| (not out of the box, I don't think.. doubting myself now)
| 10:34:06 PM
|-
| Eloy Lafuente (stronk7)
| not really (there are some "pauses" here and there), and will evolve along the time/depend of the product used.
| 10:34:13 PM
|-
| Martin Dougiamas
| Yes it can
| 10:34:13 PM
|-
| Dan Poltawski
| rexlorenzo@gmail.com: they are doing pauses and all kinds of things
| 10:34:21 PM
|-
| Dan Poltawski
| its not a very reliable way to do it
| 10:34:28 PM
|-
| Mark Nelson
| Just a note to developers: MDK (Fred's plugin) will set behat up for you.
| 10:35:07 PM
|-
| Martin Dougiamas
| No, sure. But I think with lots and lots of tests the pauses will sort of even out.
| 10:35:08 PM
|-
| Martin Dougiamas
| At least it would detect really stupid mistakes.
| 10:35:23 PM
|-
| Marina Glancy
| I found another implementation recently - it is useful to run the same test across all/some themes and make screenshots
| 10:35:29 PM
|-
| Mark Nelson
| Whoops, when I say plugin, I mean script. It is not a moodle plugin.
| 10:35:52 PM
|-
| Martin Dougiamas
| Post your code again marina.
| 10:35:55 PM
|-
| Martin Dougiamas
| It's a cool idea
| 10:36:12 PM
|-
| Marina Glancy
| https://github.com/marinaglancy/moodle-tool_behatui
| 10:36:17 PM
|-
| Martin Dougiamas
| (Y)
| 10:36:34 PM
|-
| bmbrands
| @marina: coool
| 10:36:49 PM
|-
| Marina Glancy
| I added there a big test for course listings, I'm going to suggest it for theme developers in my course listings doc
| 10:36:57 PM
|-
| Eloy Lafuente (stronk7)
| it can be used to cover some "key" vualizations.
| 10:37:05 PM
|-
| Eloy Lafuente (stronk7)
| *visualizations.
| 10:37:11 PM
|-
| Dan Poltawski
| If you have moodle 2.5, you can see the list of steps definitons in: admin/tool/behat/index.php
| 10:37:24 PM
|-
| Eloy Lafuente (stronk7)
| (aka the vocabulary)
| 10:38:07 PM
|-
| Anthony Borrow
| Given Marina submits moodle-tool_behatui to Moodle plugins, Then I can automatically install with Aparup's install button
| 10:38:37 PM
|-
| Jason Hardin
| behat is not using the mink plugin to allow for other test servers other than selenium?
| 10:39:38 PM
|-
| Eloy Lafuente (stronk7)
| yes
| 10:39:43 PM
|-
| Eloy Lafuente (stronk7)
| in fact I want to try it against others soon (faster and headless with JS support)
| 10:40:21 PM
|-
| Mark Nielsen
| Hrm... that can help speed up tests though. Using a headless browser, etc
| 10:40:42 PM
|-
| bmbrands
| have to leave, thanks all
| 10:40:52 PM
|-
| Jason Hardin
| it does help but has issues
| 10:41:03 PM
|-
| Jason Hardin
| not all headless support the same funcitonality as selenium
| 10:41:12 PM
|-
| Eloy Lafuente (stronk7)
| for non-js, non-corss-browser ones it already uses headless afaik)
| 10:41:16 PM
|-
| Jason Hardin
| selenium seems to be the best supported though
| 10:41:21 PM
|-
| Eloy Lafuente (stronk7)
| nah
| 10:41:25 PM
|-
| Jason Hardin
| the others have "issues"
| 10:41:27 PM
|-
| Eloy Lafuente (stronk7)
| lol, selenium has too
| 10:41:34 PM
|-
| Dan Poltawski
| Mark: yes. The problem is real useers don't use javascript-less browsers
| 10:41:38 PM
|-
| Martin Dougiamas
| Thanks Bas!
| 10:41:44 PM
|-
| Jason Hardin
| @eloy, true, but you can get the server to run
| 10:41:49 PM
|-
| Jason Hardin
| i have not gotten others to run onlinux and mac
| 10:42:01 PM
|-
| Jason Hardin
| only one or the other
| 10:42:06 PM
|-
| Rex Lorenzo
| Oh, are you guys also running behats tests for accessibility? The idea about javascript browsers made me think about it.
| 10:42:18 PM
|-
| Eloy Lafuente (stronk7)
| well, I've tried zombie and it rocks
| 10:42:26 PM
|-
| Jason Hardin
| i tried zombie and it failed
| 10:42:36 PM
|-
| Eloy Lafuente (stronk7)
| for the purposes I'm thinking about.
| 10:42:36 PM
|-
| Rex Lorenzo
| *javascript-less
| 10:42:41 PM
|-
| Dan Poltawski
| rexlorenzo@gmail.com: an interesting side effect of behat tests is that I think it helps us with accessibility
| 10:42:50 PM
|-
| Mark Nielsen
| @poltawski: not all tests require JS though - if I just want to confirm that some text appears after hitting a button, I don't need anything special
| 10:43:13 PM
|-
| Jason Hardin
| yeah when Eloy means javascript less it is that the testing software doesn't need aJS to run the tests
| 10:43:14 PM
|-
| Jason Hardin
| not that there is no js testing
| 10:43:18 PM
|-
| Dan Poltawski
| because we spot things like multiple links with the same meaning
| 10:43:20 PM
|-
| Dan Poltawski
| grr
| 10:43:24 PM
|-
| Dan Poltawski
| different meaning
| 10:43:28 PM
|-
| Andrew Nicols
| same heading, different meaning
| 10:43:43 PM
|-
| Dan Poltawski
| @watermark.nielsen its already supported with headless browser, if itsnnot got javascript requirement
| 10:43:46 PM
|-
| Mark Nielsen
| ah
| 10:43:57 PM
|-
| Jason Hardin
| if you want accessibility testing there is a fireeyes plugin that works pretty well it is free
| 10:43:58 PM
|-
| Dan Poltawski
| there is an @javascript tag for javascript depdendent tests
| 10:44:09 PM
|-
| Jason Hardin
| http://www.deque.com/deque-fireeyes
| 10:44:10 PM
|-
| Jason Hardin
| it si produced by the consulting company Moodlerooms hired to review Moodle
| 10:44:20 PM
|-
| Jason Hardin
| and free to use as long as you are not providing consulting services around it
| 10:44:36 PM
|-
| Eloy Lafuente (stronk7)
| he
| 10:44:42 PM
|-
| Eloy Lafuente (stronk7)
| meeting interruptus?
| 10:45:13 PM
|-
| Dan Poltawski
| thats his screen isn't it
| 10:45:16 PM
|-
| Dan Poltawski
| keep commentating!
| 10:45:22 PM
|-
| Eloy Lafuente (stronk7)
| music!
| 10:45:28 PM
|-
| Eloy Lafuente (stronk7)
| brasil!
| 10:45:32 PM
|-
| Dan Poltawski
| Ijust saw his terminal
| 10:45:52 PM
|-
| Aparup Banerjee
| seeing terminal snow
| 10:46:11 PM
|-
| Sam Hemelryk
| Yip I can see it
| 10:46:13 PM
|-
| Dan Poltawski
| its threre now
| 10:46:16 PM
|-
| Aparup Banerjee
| *now
| 10:46:19 PM
|-
| Rajesh Taneja
| yes
| 10:46:20 PM
|-
| David Mudrák
| finally a command line interface!
| 10:46:23 PM
|-
| Dan Poltawski
| its just that its at top of screen
| 10:46:23 PM
|-
| Eloy Lafuente (stronk7)
| DONT TYPE the ROOT's PASSWORD NOW!
| 10:46:25 PM
|-
| Ankit Agarwal
| lol
| 10:46:26 PM
|-
| Andrew Nicols
| Martin: Click on his window at the bottom. It's based on who is talking most
| 10:46:27 PM
|-
| Dan Poltawski
| get him to press enter
| 10:46:27 PM
|-
| Aparup Banerjee
| gone
| 10:46:29 PM
|-
| Andrew Nicols
| heh
| 10:46:40 PM
|-
| Andrew Nicols
| wfm ;)
| 10:46:49 PM
|-
| Dan Poltawski
| I see him!
| 10:47:05 PM
|-
| Aparup Banerjee
| its there now
| 10:47:06 PM
|-
| Eloy Lafuente (stronk7)
| here we go
| 10:47:13 PM
|-
| Dan Poltawski
| look you guys look!
| 10:47:23 PM
|-
| Eloy Lafuente (stronk7)
| it's boring... although last time i was 80 mins looking for them to complete.
| 10:48:01 PM
|-
| Helen Foster
| wow, how cool is that!
| 10:48:01 PM
|-
| Dan Poltawski
| lol
| 10:48:01 PM
|-
| Dan Poltawski
| david is cheating
| 10:48:28 PM
|-
| Dan Poltawski
| hes just doing it quickly
| 10:48:35 PM
|-
| Eloy Lafuente (stronk7)
| it's a recorded video! Fake!
| 10:48:42 PM
|-
| Eloy Lafuente (stronk7)
|
| 10:48:51 PM
|-
| Eloy Lafuente (stronk7)
| eh, have you seen the setType warning, Dan?
| 10:49:07 PM
|-
| Gareth J Barnard
| He has a Raspberry Pi controlled mouse ;)
| 10:49:09 PM
|-
| Aparup Banerjee
| suspects trained monkeys
| 10:49:10 PM
|-
| Dan Poltawski
| yes!
| 10:49:11 PM
|-
| Dan Poltawski
| errors not detected
| 10:49:25 PM
|-
| Justin Filip
| Does this take screenshots at any points for making sure a page is rendered correctly?
| 10:49:29 PM
|-
| Jason Hardin
| can you run just the plugin tests?
| 10:49:36 PM
|-
| Eloy Lafuente (stronk7)
| yeah, we should have them caught already, grrr
| 10:49:38 PM
|-
| Justin Filip
| Such as: this page looks great in Chrome and FF but renders incorrectly in IE8?
| 10:49:46 PM
|-
| Dan Poltawski
| Jason Hardin: you can run by tag
| 10:49:49 PM
|-
| Jason Hardin
| awesome
| 10:49:56 PM
|-
| Dan Poltawski
| jfilip: yes
| 10:49:56 PM
|-
| Eloy Lafuente (stronk7)
| by tag or by name (part of the description)
| 10:50:07 PM
|-
| Justin Filip
| Cool, thanks.
| 10:50:08 PM
|-
| Jason Hardin
| nice
| 10:50:20 PM
|-
| Moodle HQ
| Justin, that's exactly what Marinas behatui thing does
| 10:50:25 PM
|-
| Rex Lorenzo
| Are you guys running also running selenium in windows to test IE? How many different environments are you running selenium or planning to?
| 10:50:34 PM
|-
| Eloy Lafuente (stronk7)
| 2.6 testing won't be QA testing anymore but "picture testing" instead, lol.
| 10:51:15 PM
|-
| Justin Filip
| I'll take a look at it, thanks for the info.
| 10:51:41 PM
|-
| Moodle HQ
| Sauce labs, for now
| 10:52:11 PM
|-
| Rex Lorenzo
| Which service?
| 10:52:14 PM
|-
| Dan Poltawski
| https://saucelabs.com/
| 10:52:24 PM
|-
| Eloy Lafuente (stronk7)
| settype again
| 10:52:50 PM
|-
| Dan Poltawski
| https://saucelabs.com/u/moodle
| 10:52:58 PM
|-
| Dan Poltawski
| ^ cool
| 10:53:00 PM
|-
| Eloy Lafuente (stronk7)
| we need to catch all those notices/warnings/debuggins ASAP
| 10:53:34 PM
|-
| Rex Lorenzo
| Very cool stuff.
| 10:53:40 PM
|-
| Eloy Lafuente (stronk7)
| awesome stuff, david!
| 10:53:56 PM
|-
| Dan Poltawski
| now everyone else needs to start writing tests
| 10:54:14 PM
|-
| Eloy Lafuente (stronk7)
| i want to
| 10:54:20 PM
|-
| Dan Poltawski
| (steam was coming out of davids ears when I was in perth)
| 10:54:27 PM
|-
| Ankit Agarwal
| Nice presentations
| 10:54:58 PM
|-
| Ankit Agarwal
| slides
| 10:55:10 PM
|-
| Eloy Lafuente (stronk7)
| wasn't there a pending backport issue for tests to 2.4 ?
| 10:55:12 PM
|-
| Eloy Lafuente (stronk7)
| (evil)
| 10:55:18 PM
|-
| Eloy Lafuente (stronk7)
| (assign ones)
| 10:55:28 PM
|-
| Dan Poltawski
| yup
| 10:55:31 PM
|-
| Dan Poltawski
| aren't they waiting on Damyon
| 10:56:11 PM
|-
| Dan Poltawski
| yup: MDL-37632
| 10:56:31 PM
|-
| Moodle Bot
| https://tracker.moodle.org/browse/MDL-37632 - Backport unit tests for mod/assign/lib.php and mod/assign/lib.php and mod/assign/upgradelib.php to 24
| 10:56:31 PM
|-V: 0, W: 3, Type: Improvement, Assignee: Damyon Wiese, Priority: Minor, Status: Reopened
| Andrew Nicols
| yay people using the new drag/drop of help
| 10:59:07 PM
|-
| Dan Poltawski
| lol
| 11:00:11 PM
|-
| Dan Poltawski
| profile description from mdk
| 11:00:26 PM
|-
| Davo Smith
| popped back just in time
| 11:04:14 PM
|-
| Gareth J Barnard
| Will MDL-37490 make it into M2.5?
| 11:04:26 PM
|-
| Moodle Bot
| https://tracker.moodle.org/browse/MDL-37490 - Display assignment due date on course page.
| 11:04:27 PM
|-V: 4, W: 7, Type: New Feature, Assignee: Gareth J Barnard, Priority: Minor, Status: Waiting for integration review
| Ankit Agarwal
| yes
| 11:05:21 PM
|-
| Andrew Nicols
| Seeing it on youtube now
| 11:05:21 PM
|-
| Rajesh Taneja
| yes
| 11:05:24 PM
|-
| David Mudrák
| yes
| 11:05:27 PM
|-
| Justin Filip
| Yes
| 11:05:33 PM
|-
| sbourget
| yes
| 11:05:36 PM
|-
| Eloy Lafuente (stronk7)
| another perfect english speaker, yay!
| 11:06:05 PM
|-
| Eloy Lafuente (stronk7)
| the orange looks "too much" for me, lol.
| 11:09:00 PM
|-
| Tim Hunt
| No such thing as too much orange.
| 11:09:12 PM
|-
| Eloy Lafuente (stronk7)
| will it support custom backgrounds?
| 11:09:37 PM
|-
| David Mudrák
| typical mobile developer - having even desktop windows resized to 200 x 300 px
| 11:09:53 PM
|-
| Ankit Agarwal
| heh
| 11:10:04 PM
|-
| Martin Dougiamas
| Yes you can change backgrounds and everything via CSS
| 11:12:24 PM
|-
| Martin Dougiamas
| there is a new setting in Moodle 2.5 that lets you specify the URL to a CSS file
| 11:12:44 PM
|-
| Eloy Lafuente (stronk7)
| super
| 11:12:53 PM
|-
| Martin Dougiamas
| And the app will get this and use it
| 11:12:57 PM
|-
| Andrew Nicols
| Same goes for language customisations
| 11:13:18 PM
|-
| Martin Dougiamas
|
| 11:13:23 PM
|-
| Martin Dougiamas
| And all this is cached in the app
| 11:13:28 PM
|-
| Eloy Lafuente (stronk7)
| well done1
| 11:14:03 PM
|-
| Andrew Nicols
| It's a nice app - well done Juan
| 11:14:17 PM
|-
| Aparup Banerjee
| nice! (browser appears black sometimes in youtube)
| 11:14:49 PM
|-
| Rex Lorenzo
| Is the push notifications something similar to what Moodlerooms is proposing for their alert system in here? https://moodle.org/mod/forum/discuss.php?d=223812
| 11:14:59 PM
|-
| Rex Lorenzo
| How can we sent push notifications? Does it use the messaging api?
| 11:15:28 PM
|-
| Tim Hunt
| More open. Less free
| 11:15:29 PM
|-
| marxjohnson00
| Haha oh dear
| 11:15:36 PM
|-
| marxjohnson00
| lets not get into that now
| 11:15:40 PM
|-
| Dan Poltawski
| rexlorenzo@gmail.com: the notification using messaging system
| 11:15:43 PM
|-
| Juan Leyva
| Rex, yes messaging output plugins
| 11:15:46 PM
|-
| Eloy Lafuente (stronk7)
| "we are legion"
| 11:15:49 PM
|-
| Martin Dougiamas
| We have a server called AirNotifier that will recieve messages from Moodle
| 11:16:17 PM
|-
| maberdour
| Holy crap, been trying out different jabber settings for an hour. Made it in. Thanks @anatai
| 11:16:18 PM
|-
| Martin Dougiamas
| via Message API
| 11:16:21 PM
|-
| Eloy Lafuente (stronk7)
| jabber is sooo simple, lol.
| 11:16:33 PM
|-
| Martin Dougiamas
| and send it to Apple/Google and then to your phone
| 11:16:35 PM
|-
| Anatai
| @maberdour you're welcome
| 11:16:38 PM
|-
| Eloy Lafuente (stronk7)
| super
| 11:16:51 PM
|-
| Eloy Lafuente (stronk7)
| exciting
| 11:16:55 PM
|-
| Eloy Lafuente (stronk7)
| amazing
| 11:16:57 PM
|-
| sam marshall
| (yeah, how come irc works much better than jabber?
| 11:16:58 PM
|-
| Gareth J Barnard
| Thank you
| 11:17:05 PM
|-
| Aparup Banerjee
| yes the notifications i've received were cool Jerome
| 11:17:08 PM
|-
| Juan Leyva
| https://docs.moodle.org/24/en/Moodle_Mobile_app
| 11:17:19 PM
|-
| Juan Leyva
| https://docs.moodle.org/dev/Moodle_Mobile
| 11:17:19 PM
|-
| Eloy Lafuente (stronk7)
| welcom, G
| 11:17:21 PM
|-
| Andrew Nicols
| We've lost camear on youtube
| 11:17:22 PM
|-
| Andrew Nicols
| Got your camera now
| 11:17:44 PM
|-
| Anthony Borrow
| any updates on MDL-36350 / https://docs.moodle.org/dev/Survey_2_module - it seems to keep getting pushed back - possible GSOC project?
| 11:18:30 PM
|-
| Moodle Bot
| https://tracker.moodle.org/browse/MDL-36350 - Implement Survey 2 module
| 11:18:30 PM
|-V: 12, W: 18, Type: New Feature, Assignee: Daniele Cordella, Priority: Major, Status: Open
| Moodle HQ
| AFAIK Daniele stil on it
| 11:19:10 PM
|-
| Eloy Lafuente (stronk7)
| afaik Danielle is back, hard working on it, Anthony.
| 11:19:13 PM
|-
| Anthony Borrow
| good news!
| 11:19:21 PM
|-
| Andrew Nicols
| lag is tricky
| 11:19:54 PM
|-
| Dan Poltawski
| hi GSOC students watching!
| 11:19:58 PM
|-
| marxjohnson00
| 1
| 11:20:05 PM
|-
| Andrew Nicols
| and Twitter hasn't been great for it
| 11:20:06 PM
|-
| Ankit Agarwal
| Brilliant
| 11:20:07 PM
|-
| Aparup Banerjee
| this is way way better
| 11:20:08 PM
|-
| Eloy Lafuente (stronk7)
| 0.5
| 11:20:08 PM
|-
| Gareth J Barnard
| Will this live stream be saved? +1
| 11:20:09 PM
|-
| Andrew Nicols
| +1 though
| 11:20:09 PM
|-
| Rajesh Taneja
| 1
| 11:20:11 PM
|-
| Tim Hunt
| Video and audio is good.
| 11:20:11 PM
|-
| Sam Hemelryk
| 1
| 11:20:13 PM
|-
| Justin Filip
| Pretty good
| 11:20:13 PM
|-
| Rex Lorenzo
| Better than bbb
| 11:20:17 PM
|-
| Eloy Lafuente (stronk7)
| 0.2
| 11:20:17 PM
|-
| David Mudrák
| 1
| 11:20:18 PM
|-
| Tim Hunt
| Harder to see who is in the meeting and chat
| 11:20:20 PM
|-
| Andrew Nicols
| Could do with the stream running a bit for 15 minutes before hand to give people a chance to get themselves sorted
| 11:20:24 PM
|-
| Mark Nelson
| It worked with very little effort.
| 11:20:35 PM
|-
| Dan Poltawski
| 1
| 11:20:38 PM
|-
| Tim Hunt
| Yes. Starting the stream earlier woudlbe good.
| 11:20:40 PM
|-
| Eloy Lafuente (stronk7)
| google rocks!
| 11:20:42 PM
|-
| Jenny Gray
| twitter has been surprisingly quiet.
| 11:20:42 PM
|-
| Eloy Lafuente (stronk7)
|
| 11:20:43 PM
|-
| Gareth J Barnard
| BBB is being used at iMoot 2013.
| 11:20:56 PM
|-
| Andrew Nicols
| thanks
| 11:21:10 PM
|-
| David Mudrák
| too many places to check for feedback
| 11:21:11 PM
|-
| Gareth J Barnard
| Thank you all
| 11:21:26 PM
|-
| Eloy Lafuente (stronk7)
| devs rocks! C'mon!
| 11:21:35 PM
|-
| Tim Hunt
| Thanks.
| 11:21:36 PM
|-
| Anatai
| thanks
| 11:21:38 PM
|-
| David Mudrák
| thanks
| 11:21:40 PM
|-
| Ankit Agarwal
| Cya all
| 11:21:42 PM
|-
| Justin Filip
| Thanks
| 11:21:42 PM
|-
| mary
| thanks
| 11:21:44 PM
|-
| Rex Lorenzo
| Thanks.
| 11:21:44 PM
|-
| Sam Hemelryk
| Cool, thanks guys
| 11:21:45 PM
|-
| Mark Nelson
| Ciao.
| 11:21:49 PM
|-
| Dan Poltawski
| ciao
| 11:21:49 PM
|-
| David Mudrák
| (clap)
| 11:21:50 PM
|-
| David Mudrák
| +1 mojito
| 11:21:54 PM
|-
| Rossiani Wijaya
| cya
| 11:22:01 PM
|-
| Rajesh Taneja
| cya
| 11:22:01 PM
|-
| David Mudrák
| did I hear "meeting rums?"
| 11:22:07 PM
|-
| Aparup Banerjee
| thanks! good night! moodle out yo
| 11:22:14 PM
|-
| Eloy Lafuente (stronk7)
| did i hear "mojito" ?
| 11:22:16 PM
|-
| Eloy Lafuente (stronk7)
| lol
| 11:22:20 PM
|}

reportbuilder/A Basic Join

2013-06-10T14:05:56Z

Simoncoggins:

[[reportbuilder|Back to Index]]

Our hello world source now makes it possible to display any database fields from the course table, but currently there is no way to get data from any other table in the database. For instance, what if we wanted to add a column that displayed the course category along side the course name? The name of the course category is stored in a different table:
<pre>
mdl_course:
id | fullname | category
1 | My Course | 1

mdl_course_categories:
id | name
1 | Miscellaneous
</pre>
We need to add a join to the joinlist, so report builder knows how to correctly connect the base table to the 2nd table. We do this by adding a join object to the joinlist array:
<pre>
$joinlist = array(
new rb_join(
'course_category',
'LEFT',
'{course_categories}',
'course_category.id = base.category'
)
);
</pre>
The rb_join method takes 4 required arguments:
* Join name. A unique string, used to identify this join.
* Join type. Describes the type of join (e.g. LEFT OUTER, RIGHT OUTER, INNER). This effects how the records are combined. See http://en.wikipedia.org/wiki/Join_(SQL)
* Table name. The full name of the table to join to
* Join condition. This describes which fields the tables should be joined on. Use the Join name to describe other tables, or 'base' for the base table. In this case we are joining the 'category' field of the base (course) table, to the 'id' field of the course_categories table.

See also [advanced join options] and the [rb_join documentation].

Once the join has been defined, column options can make use of fields from the joined tables, by specifying which joined tables they will use. For example, to include a column option which displays the course category:
<pre>
new rb_column_option(
'course',
'category',
get_string('category'),
'course_category.name',
array(
'joins' => 'course_category'
)
);
</pre>
Here the field name uses the syntax '[join name].[field name]' to define the desired field. Any additional optional parameter 'joins' is added which lists which joins must be made to get access to this field. The 'joins' parameter can take a join name or an array of join names if you need to join multiple tables. You only need to include dependencies needed by the new join - report builder will automatically add the dependencies of joins you mention.

If you add the join and column option code to the Hello World source file and save it, you should see a new column option appear when you edit the report. Add the new column to the report and should look like the report below:

[SCREENSHOT OF REPORT]

Moodle 2.5 release notes

2013-05-05T20:13:54Z

Simoncoggins:

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%222.5%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 2.5].

See [https://docs.moodle.org/25/en/New_features New features] for a user-friendly tour with screenshots

===Requirements===

These are just minimums. We recommend keeping all your software updated.

* Recommended minimum browser: Google Chrome 11, Firefox 4, Safari 5, Internet Explorer 8 (IE 10 required for drag and drop of files from outside the browser into Moodle)
* Moodle upgrade: Moodle 2.2 or later (if upgrading from earlier versions, you must upgrade to 2.2.9 as a first step)
* Minimum DB versions: PostgreSQL 8.3, MySQL 5.1.33, MariaDB 5.2, MSSQL 2005 or Oracle 10.2 (oci_native_moodle_package.sql needs to be executed before upgrade on Oracle servers)
* Minimum PHP version: PHP 5.3.3
* New PHP extension requirements: GD

NOTE: We will drop support for IE8 in Moodle 2.6 (to be released November 2013). This means IE8 will probably still work for 2.6, but developers will not be required to test their new code on that browser. Moodle, like most of the world's web sites and browser producers, encourages you to keep your browsers current to improve security and functionality while saving us valuable time. ([http://googleappsupdates.blogspot.ca/2012/09/supporting-modern-browsers-internet.html For example see what Google is doing])

===Highlights===

* MDL-35073 - [https://docs.moodle.org/25/en/Badges Open Badges integration]
* MDL-38509 - New admin tool for [https://docs.moodle.org/25/en/Installing_add-ons installing add-ons]
* MDL-38016 - New themes ''Bootstrapbase'' and ''[[Clean theme|Clean]]'' with responsive design for all screen sizes
* MDL-30637 - Improvements to the usability of big complex Moodle forms in general
* MDL-37459 & MDL-37417 - More specific usability improvements to the forms for the assignment module, and for creating questions
* MDL-32652 - Block drag & drop now works throughout the site (not just on course pages)!
* MDL-36804 - Assignment resubmission system
* MDL-37009 - Course listings are displayed consistently throughout the site (theme [https://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5 changes] may be required)
* MDL-37284 - Unicode support in MariaDB/MySQL is now configured automatically during installation
* MDL-35611 - behat integration, the framework for testing of user expectations

===Enrolment improvements===

* MDL-26956 - You can now search the list of users enrolled in a course
* MDL-36514 - New option for preventing of new self-enrolments in course
* MDL-7537 - Support for more currencies in PayPal
* MDL-32387 - Implemented expiration of PayPal enrolments
* MDL-37291 - Restore support for PayPal enrolments
* MDL-37187 - Multiple problems fixed in Flat File enrolment plugin
* MDL-28705 - Configurable mapping between IMS course names and Moodle course names for IMS Enterprise enrolment
* MDL-36504 - Complete list of all enrolment related improvements

===Performance===

* MDL-35716 - New performance overview report
* MDL-35685 - Improved login performance
* MDL-36809 - Support for persistent connections to MariaDB/MySQL servers
* MDL-34344 - CFG caching in MUC
* MDL-34346 - New repository caching
* MDL-34401 - New caching of plugin information
* MDL-37718 - Improved database recordset memory use
* MDL-38212 - Workaround for some memory issues in cron
* MDL-38391 - Improved YUI module loading performance
* MDL-37127 - Use of minified YUI modules to reduce content size

===Miscellaneous===

* MDL-38166 - [https://docs.moodle.org/en/Building_Database Database activity] URL field has option to open link in new window
* MDL-37455 - New folder resource option to display folder contents on the course page
* MDL-30790 - New folder resource option to display sub-folders expanded or collapsed
* MDL-37602 - Overall assessment feedback support in the [[:en:Workshop module|Workshop module]]
* MDL-28585 - LDAP authentication password expiry handling
* MDL-20131 - Random glossary entry block can use a global glossary
* MDL-35842 - Random glossary entry block alphabetical order option
* MDL-37337 - Assignment settings page improvements
* MDL-37644 - New setting for showing course full names in the navigation block
* MDL-5875 - Option to show the word count of forum posts
* MDL-23504 - Transparency and RGB support in themes colour picker
* MDL-37806 - New 'Save and show next' button for workshop submissions
* MDL-37728 - Role definition overview improvements
* MDL-37641 - Prettier names when a file already exists
* MDL-38538 - Option to auto-save during quiz attempts
* MDL-36955 - Better grading for partially correct Cloze questions with Interactive behaviour
* MDL-35793 - Defaults for when a question is previewed
* MDL-10516 - Essay questions can have a template, so the student starts answering from the template, not a blank editor
* MDL-36602 - mnethostid available as an upload users field
* MDL-34137 - Option to drag and drop a media file onto the course page to create a label
* MDL-33946 - Option to drag and drop text onto the course page to create a label
* MDL-33688 - Drag and drop file upload progress indicator in filepicker
* MDL-33669 - Option to access Equella site when using Equella repository
* MDL-32341 - Configurable calendar export date range
* MDL-33206 - Book resource type print dialogue link
* MDL-31983 - Settings block renamed 'Administration' and reports moved there
* MDL-34917 - Jump to section navigation for 'One section per page' setting in course formats
* MDL-38708 - Option to add images and other files to the course list
* MDL-36395 - New setting Maximum users per page for specifying the number of users shown in search results
* MDL-37596 - Scheduled maintenance mode
* MDL-35775 - Group import allows new groups to be assigned to groupings
* MDL-38494 - Upload users accepts date-time format custom profile field
* MDL-26649 - Date picker usability improvements
* MDL-37572 - Categories edit page is separated from view and does not depend any more on global editing mode
* MDL-37217 - Folders are now displayed in the [https://docs.moodle.org/25/en/Google_Drive_repository Google Drive repository] (renamed from Google Docs repository). An administrator must enable the Drive API in the Google APIs Console, as described in [https://docs.moodle.org/25/en/Google_OAuth_2.0_setup Google OAuth 2.0 setup].
* Multiple improvements in MS SQL Server and Oracle database drivers
* MDL-35819 - Rewrite tooltip help to improve UI consistency, and performance.

===API changes===

* MDL-34640 - Improvements to how the question engine handles uploaded files. This should make it possible to write question types that automatically grade uploaded files.
* MDL-37287 - 3rd party libraries updated, ex.: YUI 3.9.1, TinyMCE 3.5.8, latest tcpdf and others
* MDL-15727 - jQuery and jQuery UI supported in add-ons
* MDL-29996 - Legacy filters are not supported any more, developers need to migrate filters from modules to standard filter location
* MDL-35356 - Excel and ODS export improvements
* MDL-35434 - Theme developers may use new admin setting type for user uploaded logo images
* MDL-37726 - PREVIOUS and NEXT attributes are not required in install.xml files
* MDL-38558 - It is now possible to run local pre-upgrade script
* MDL-38391 - Convert YUI_config to class in lib/outputrequirements.php.
* MDL-35819 - JS M.util.help_icon deprecated in favour of moodle-core-popuphelp

====Upgrade notes for developers====

;Activity modules: http://git.moodle.org/gw?p=moodle.git;a=blob;f=mod/upgrade.txt;hb=master
;Assignment: http://git.moodle.org/gw?p=moodle.git;a=blob;f=mod/assign/upgrade.txt;hb=master
;Backup: http://git.moodle.org/gw?p=moodle.git;a=blob;f=backup/upgrade.txt;hb=master
;Cache: http://git.moodle.org/gw?p=moodle.git;a=blob;f=cache/upgrade.txt;hb=master
;Calendar: http://git.moodle.org/gw?p=moodle.git;a=blob;f=calendar/upgrade.txt;hb=master
;Core: http://git.moodle.org/gw?p=moodle.git;a=blob;f=lib/upgrade.txt;hb=master
;Course formats: http://git.moodle.org/gw?p=moodle.git;a=blob;f=course/format/upgrade.txt;hb=master
;Enrolment plugins: http://git.moodle.org/gw?p=moodle.git;a=blob;f=enrol/upgrade.txt;hb=master
;Filters: http://git.moodle.org/gw?p=moodle.git;a=blob;f=filter/upgrade.txt;hb=master
;Question types: http://git.moodle.org/gw?p=moodle.git;a=blob;f=question/type/upgrade.txt;hb=master
;Themes: http://git.moodle.org/gw?p=moodle.git;a=blob;f=theme/upgrade.txt;hb=master
;TinyMCE plugins: http://git.moodle.org/gw?p=moodle.git;a=blob;f=lib/editor/tinymce/upgrade.txt;hb=master

===Security issues===

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

====Security related improvements====

* MDL-35332 - Improved security of hashed passwords
* MDL-21342 - New user account lockout mechanism

===Multi-server architectures with different PHP versions ===

Moodle has moved to use a more secure mechanism for securing passwords, from 2.5 new passwords will be generated using bcrypt rather than md5. Because bcrypt is only supported for PHP version 5.3.7 and above, it is important that all servers within a cluster use the same version of PHP (MDL-35332).

===Restoring Moodle 2.5 backups to sites with old PHP versions===

Because bcrypt is not supported in PHP versions below 5.3.7, course backups made using the $CFG->includeuserpasswordsinbackup setting on a site using PHP version 5.3.7+ that are subsequently restored to a site with PHP version < 5.3.7 will require a password reset.

The same issue would occur if you downgraded the PHP version on the server running your site from 5.3.7+ to less than 5.3.7. (MDL-35332)

==See also==
*[[Moodle 2.4 release notes]]

[[Category:Release notes]]
[[Category:Moodle 2.5]]

[[es:Notas de Moodle 2.5]]
[[fr:Notes de mise à jour de Moodle 2.5]]

Moodle 2.5 release notes

2013-05-05T20:10:51Z

Simoncoggins: /* Multi-server architectures with php version differences */

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%222.5%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 2.5].

See [https://docs.moodle.org/25/en/New_features New features] for a user-friendly tour with screenshots

===Requirements===

These are just minimums. We recommend keeping all your software updated.

* Recommended minimum browser: Google Chrome 11, Firefox 4, Safari 5, Internet Explorer 8 (IE 10 required for drag and drop of files from outside the browser into Moodle)
* Moodle upgrade: Moodle 2.2 or later (if upgrading from earlier versions, you must upgrade to 2.2.9 as a first step)
* Minimum DB versions: PostgreSQL 8.3, MySQL 5.1.33, MariaDB 5.2, MSSQL 2005 or Oracle 10.2 (oci_native_moodle_package.sql needs to be executed before upgrade on Oracle servers)
* Minimum PHP version: PHP 5.3.3
* New PHP extension requirements: GD

NOTE: We will drop support for IE8 in Moodle 2.6 (to be released November 2013). This means IE8 will probably still work for 2.6, but developers will not be required to test their new code on that browser. Moodle, like most of the world's web sites and browser producers, encourages you to keep your browsers current to improve security and functionality while saving us valuable time. ([http://googleappsupdates.blogspot.ca/2012/09/supporting-modern-browsers-internet.html For example see what Google is doing])

===Multi-server architectures with different PHP versions ===

Moodle has moved to use a more secure mechanism for securing passwords, from 2.5 new passwords will be generated using bcrypt rather than md5. Because bcrypt is only supported for PHP version 5.3.7 and above, it is important that all servers within a cluster use the same version of PHP (MDL-35332).

===Restoring Moodle 2.5 backups to sites with old PHP versions===

Because bcrypt is not supported in PHP versions below 5.3.7, course backups made using the $CFG->includeuserpasswordsinbackup setting on a site using PHP version 5.3.7+ that are subsequently restored to a site with PHP version < 5.3.7 will require a password reset.

The same issue would occur if you downgraded the PHP version on the server running your site from 5.3.7+ to less than 5.3.7. (MDL-35332)

===Highlights===

* MDL-35073 - [https://docs.moodle.org/25/en/Badges Open Badges integration]
* MDL-38509 - New admin tool for [https://docs.moodle.org/25/en/Installing_add-ons installing add-ons]
* MDL-38016 - New themes ''Bootstrapbase'' and ''[[Clean theme|Clean]]'' with responsive design for all screen sizes
* MDL-30637 - Improvements to the usability of big complex Moodle forms in general
* MDL-37459 & MDL-37417 - More specific usability improvements to the forms for the assignment module, and for creating questions
* MDL-32652 - Block drag & drop now works throughout the site (not just on course pages)!
* MDL-36804 - Assignment resubmission system
* MDL-37009 - Course listings are displayed consistently throughout the site (theme [https://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5 changes] may be required)
* MDL-37284 - Unicode support in MariaDB/MySQL is now configured automatically during installation
* MDL-35611 - behat integration, the framework for testing of user expectations

===Enrolment improvements===

* MDL-26956 - You can now search the list of users enrolled in a course
* MDL-36514 - New option for preventing of new self-enrolments in course
* MDL-7537 - Support for more currencies in PayPal
* MDL-32387 - Implemented expiration of PayPal enrolments
* MDL-37291 - Restore support for PayPal enrolments
* MDL-37187 - Multiple problems fixed in Flat File enrolment plugin
* MDL-28705 - Configurable mapping between IMS course names and Moodle course names for IMS Enterprise enrolment
* MDL-36504 - Complete list of all enrolment related improvements

===Performance===

* MDL-35716 - New performance overview report
* MDL-35685 - Improved login performance
* MDL-36809 - Support for persistent connections to MariaDB/MySQL servers
* MDL-34344 - CFG caching in MUC
* MDL-34346 - New repository caching
* MDL-34401 - New caching of plugin information
* MDL-37718 - Improved database recordset memory use
* MDL-38212 - Workaround for some memory issues in cron
* MDL-38391 - Improved YUI module loading performance
* MDL-37127 - Use of minified YUI modules to reduce content size

===Miscellaneous===

* MDL-38166 - [https://docs.moodle.org/en/Building_Database Database activity] URL field has option to open link in new window
* MDL-37455 - New folder resource option to display folder contents on the course page
* MDL-30790 - New folder resource option to display sub-folders expanded or collapsed
* MDL-37602 - Overall assessment feedback support in the [[:en:Workshop module|Workshop module]]
* MDL-28585 - LDAP authentication password expiry handling
* MDL-20131 - Random glossary entry block can use a global glossary
* MDL-35842 - Random glossary entry block alphabetical order option
* MDL-37337 - Assignment settings page improvements
* MDL-37644 - New setting for showing course full names in the navigation block
* MDL-5875 - Option to show the word count of forum posts
* MDL-23504 - Transparency and RGB support in themes colour picker
* MDL-37806 - New 'Save and show next' button for workshop submissions
* MDL-37728 - Role definition overview improvements
* MDL-37641 - Prettier names when a file already exists
* MDL-38538 - Option to auto-save during quiz attempts
* MDL-36955 - Better grading for partially correct Cloze questions with Interactive behaviour
* MDL-35793 - Defaults for when a question is previewed
* MDL-10516 - Essay questions can have a template, so the student starts answering from the template, not a blank editor
* MDL-36602 - mnethostid available as an upload users field
* MDL-34137 - Option to drag and drop a media file onto the course page to create a label
* MDL-33946 - Option to drag and drop text onto the course page to create a label
* MDL-33688 - Drag and drop file upload progress indicator in filepicker
* MDL-33669 - Option to access Equella site when using Equella repository
* MDL-32341 - Configurable calendar export date range
* MDL-33206 - Book resource type print dialogue link
* MDL-31983 - Settings block renamed 'Administration' and reports moved there
* MDL-34917 - Jump to section navigation for 'One section per page' setting in course formats
* MDL-38708 - Option to add images and other files to the course list
* MDL-36395 - New setting Maximum users per page for specifying the number of users shown in search results
* MDL-37596 - Scheduled maintenance mode
* MDL-35775 - Group import allows new groups to be assigned to groupings
* MDL-38494 - Upload users accepts date-time format custom profile field
* MDL-26649 - Date picker usability improvements
* MDL-37572 - Categories edit page is separated from view and does not depend any more on global editing mode
* MDL-37217 - Folders are now displayed in the [https://docs.moodle.org/25/en/Google_Drive_repository Google Drive repository] (renamed from Google Docs repository). An administrator must enable the Drive API in the Google APIs Console, as described in [https://docs.moodle.org/25/en/Google_OAuth_2.0_setup Google OAuth 2.0 setup].
* Multiple improvements in MS SQL Server and Oracle database drivers
* MDL-35819 - Rewrite tooltip help to improve UI consistency, and performance.

===API changes===

* MDL-34640 - Improvements to how the question engine handles uploaded files. This should make it possible to write question types that automatically grade uploaded files.
* MDL-37287 - 3rd party libraries updated, ex.: YUI 3.9.1, TinyMCE 3.5.8, latest tcpdf and others
* MDL-15727 - jQuery and jQuery UI supported in add-ons
* MDL-29996 - Legacy filters are not supported any more, developers need to migrate filters from modules to standard filter location
* MDL-35356 - Excel and ODS export improvements
* MDL-35434 - Theme developers may use new admin setting type for user uploaded logo images
* MDL-37726 - PREVIOUS and NEXT attributes are not required in install.xml files
* MDL-38558 - It is now possible to run local pre-upgrade script
* MDL-38391 - Convert YUI_config to class in lib/outputrequirements.php.
* MDL-35819 - JS M.util.help_icon deprecated in favour of moodle-core-popuphelp

====Upgrade notes for developers====

;Activity modules: http://git.moodle.org/gw?p=moodle.git;a=blob;f=mod/upgrade.txt;hb=master
;Assignment: http://git.moodle.org/gw?p=moodle.git;a=blob;f=mod/assign/upgrade.txt;hb=master
;Backup: http://git.moodle.org/gw?p=moodle.git;a=blob;f=backup/upgrade.txt;hb=master
;Cache: http://git.moodle.org/gw?p=moodle.git;a=blob;f=cache/upgrade.txt;hb=master
;Calendar: http://git.moodle.org/gw?p=moodle.git;a=blob;f=calendar/upgrade.txt;hb=master
;Core: http://git.moodle.org/gw?p=moodle.git;a=blob;f=lib/upgrade.txt;hb=master
;Course formats: http://git.moodle.org/gw?p=moodle.git;a=blob;f=course/format/upgrade.txt;hb=master
;Enrolment plugins: http://git.moodle.org/gw?p=moodle.git;a=blob;f=enrol/upgrade.txt;hb=master
;Filters: http://git.moodle.org/gw?p=moodle.git;a=blob;f=filter/upgrade.txt;hb=master
;Question types: http://git.moodle.org/gw?p=moodle.git;a=blob;f=question/type/upgrade.txt;hb=master
;Themes: http://git.moodle.org/gw?p=moodle.git;a=blob;f=theme/upgrade.txt;hb=master
;TinyMCE plugins: http://git.moodle.org/gw?p=moodle.git;a=blob;f=lib/editor/tinymce/upgrade.txt;hb=master

===Security issues===

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

====Security related improvements====

* MDL-35332 - Improved security of hashed passwords
* MDL-21342 - New user account lockout mechanism

==See also==
*[[Moodle 2.4 release notes]]

[[Category:Release notes]]
[[Category:Moodle 2.5]]

[[es:Notas de Moodle 2.5]]
[[fr:Notes de mise à jour de Moodle 2.5]]

openbadges

2013-04-10T22:24:17Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
The technical specification can be found on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges v1.0 came out Q1 2013 so we can expect additional features and possibly some API changes over time.

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle. '''Done!'''
# Moodle Block to display badges received from the site (internal badges) '''Done!'''
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them) '''Done!'''
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared) '''Done!'''
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github] - Note this was the pre-release code. Open badges is now integrated into Moodle and available in 2.5 via [http://github.com/moodle/moodle Github]
* [https://tracker.moodle.org/browse/MDL/component/12643 Moodle tracker component] - [https://tracker.moodle.org/browse/MDL-35073 Badges integration issue]

openbadges

2013-04-05T19:23:42Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
The technical specification can be found on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges v1.0 came out Q1 2013 so we can expect additional features and possibly some API changes over time.

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle. '''Done!'''
# Moodle Block to display badges received from the site (internal badges) '''Done!'''
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them) '''Done!'''
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared) '''Done!'''
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL/component/12643 Moodle tracker component] - [https://tracker.moodle.org/browse/MDL-35073 Badges integration issue]

openbadges

2013-04-05T19:23:28Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
The technical specification can be found on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges v1.0 came out Q1 2013 so we can expect additional features and possibly some API changes over time.

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle. '''Done!'''
# Moodle Block to display badges received from the site (internal badges) '''Done!'''
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them) '''Done!'''
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared) '''Done!'''
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL/component/12643 Moodle tracker component] [https://tracker.moodle.org/browse/MDL-35073 Badges integration issue]

openbadges

2013-04-05T19:23:16Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
The technical specification can be found on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges v1.0 came out Q1 2013 so we can expect additional features and possibly some API changes over time.

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle. '''Done!'''
# Moodle Block to display badges received from the site (internal badges) '''Done!'''
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them) '''Done!'''
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared) '''Done!'''
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL/component/12643 Moddle tracker component] [https://tracker.moodle.org/browse/MDL-35073 Badges integration issue]

openbadges

2013-04-05T19:20:56Z

Simoncoggins: /* Implementation plan */

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
The technical specification can be found on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges v1.0 came out Q1 2013 so we can expect additional features and possibly some API changes over time.

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle. '''Done!'''
# Moodle Block to display badges received from the site (internal badges) '''Done!'''
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them) '''Done!'''
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared) '''Done!'''
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

openbadges

2013-04-05T19:19:54Z

Simoncoggins: /* Open Badges Integration */

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
The technical specification can be found on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges v1.0 came out Q1 2013 so we can expect additional features and possibly some API changes over time.

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

openbadges

2013-04-05T19:19:20Z

Simoncoggins: /* Technical specification */

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
The technical specification can be found on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

openbadges

2013-04-05T18:46:16Z

Simoncoggins:

{{Work in progress}}

'''Status:'''
:The initial implementation has now been merged for release in Moodle 2.5.

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
Current work towards technical specification can be followed on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

openbadges

2013-04-04T18:06:09Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:development in progress (MDL-35073)

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
Current work towards technical specification can be followed on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

openbadges

2013-04-04T18:05:57Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:development in progress (MDL-35073)

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
Current work towards technical specification can be followed on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [https://moodle.org/mod/forum/view.php?id=8085 Badges Moodle forum] - [http://moodle.org/mod/forum/discuss.php?d=197834 Post announcing the project]
* [[http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

openbadges

2013-02-18T20:40:55Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:development in progress (MDL-35073)

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
Current work towards technical specification can be followed on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [http://moodle.org/mod/forum/discuss.php?d=197834 Moodle.org forum post]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [https://docs.moodle.org/dev/OpenBadges_User_Documentation Preliminary user documentation]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

openbadges

2013-02-18T20:32:06Z

Simoncoggins: /* Links */

{{Work in progress}}

'''Status:'''
:development in progress (MDL-35073)

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
Current work towards technical specification can be followed on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

===User documentation===

We are working on user documentation. Current functionality description can be found on [[OpenBadges_User_Documentation|OpenBadges User Documentation]] page.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [http://moodle.org/mod/forum/discuss.php?d=197834 Moodle.org forum post]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [http://github.com/totara/openbadges Code on github]
* [https://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]

OpenBadges User Documentation

2013-02-11T03:46:45Z

Simoncoggins: /* Background */

{{Work in progress}}

==Background==

This document describes how to use [[openbadges]] feature developed by [http://www.totaralms.com/ TotaraLMS].

The code is available on github at [https://github.com/totara/openbadges totara/openbadges]. You can use it to install your own site (Please don't use this code on a production site yet. This is still work in progress!), or you can try out our test site at [http://openbadgestotara.elearning.catalyst.net.nz openbadgestotara]. This test site has the external backpack connections and admin access disabled, but you can play around as a teacher (to create badges) or a student (to earn them).

Test site login credentials:

username: ''teacher''
password: ''teacher''

username: ''student''
password: ''student''

If you would like to give us any feedback, please use this [https://moodle.org/mod/forum/discuss.php?d=197834 openbadges forum], or email to [mailto:yuliya.bozhko@totaralms.com Yuliya Bozhko].

==Using Open Badges Feature==

There are two categories of badges:

* Site badges - available to users site-wide and related to the site wide activities, like finishing a set of courses.
* Course badges - available to users enrolled in the course and related to the activities that happen inside of this course.

The main differences between badge types are the available criteria and the location within the navigation menus.

===Badges administration===

Site administrators and users with capability "moodle/badges:manageglobalsettings" can set up general settings for badges such as default issuer name, url, contacts, and enable course badges or external backpack connections. These settings are used to populate relevant fields of a new badge form and can be changed by a badge creator if necessary.

[[File:0_settings.png]]

===Creating badges===

Badges can be created by users with capability "moodle/badges:createbadge". By default, this capability is set for '''manager''', '''course creator''', and '''editing teacher''' roles.

[[File:1_newbadge.png]]

After a badge has been created, users can check its details on overview page.

[[File:2_created.png]]

===Managing badges===

On "Manage badges" page in course or site administration, all existing badges are displayed in a table showing current badge image, name, status, criteria, how many users have already earned this badge, and a set of available actions.

[[File:8_management.png]]

Depending on user role and permissions, the following actions are available in badge management:

[[File:9_actions.png]]

'''Note''': Availability of activate and deactivate actions depends on the current status of a badge (e.g. if a badge is active, users will see deactivate action icon).

Before a badge has been issued to at least one user, all its details and settings can be edited. Use "Edit badge" action icon to access badge editing options.

To set up badge criteria, navigate to "Criteria" tab and select a required option. Criteria are added one at a time with additional options available for each criteria.

[[File:3_select-criteria.png]]

For example, when a user selects "Manual issue by a role" requirement, they will be prompted to select which roles can award the badge and what rules apply to this requirement.

[[File:4_add-manual.png]]

After criterion is set and added, it will be displayed among current badge criteria.

[[File:5_added-manual.png]]

To edit a body and subject of a message which users get upon earning the badge, go to "Message" tab.

Among additional options here are "Attach badge to message" which allows adding an image file to an email and "Notify badge creator" which sends a notification to a badge creator when badge is awarded (this option is available in course badges only).

[[File:6_message.png]]

"Award" tab displays a list of users who have already earned this badges.

[[File:14_viewawards.png]]

===Earning badges===

Once all criteria are set and badge creator is happy with badge details and settings, site users can start earning it. For users to be able to earn a badge, it first needs to be activated by a badge creator/administrator on a badge overview page or "Manage badges" page (as shown on the picture).

'''Only active badges are available to users and can be earned!'''

[[File:7 activate.png]]

Normally, badges are awarded to users automatically based on their actions in the system. Completion criteria of an active badge are re-calculated every time an event such as completion of a course or activity, or updating user profile happens. If a user completed all necessary requirements, they are issued a badge and sent an email notification.

[[File:11_email.png||border]]

Badges that have manual award among their criteria can be issued by one user to another. Users who issue a badge must have "moodle/badges:awardbadge" capability. Site administrators can choose their role when issuing a badge.

[[File:10_award.png]]

'''Important Note''': Currently, once a badge has been issued, it cannot be revoked. So, make sure that you are giving a badge to the right users.

===Displaying badges===

Newly earned badges are added to a private user badge collection which can be managed on "My badges" page from "My profile" options menu. On "My badges" page users can view all earned badges and their details, download these badges, manage their visibility on user profile, and perform search through the badges. If a badge has expired, "Expired" indicator will be added to a badge image. Such badges are still displayed on a user profile page.

If external backpack connections are enabled on the web site, there will also be option related to external badges management.

[[File:13_mybadges.png]]

All badges earned by a user can be displayed on their profile page.

[[File:12_profile.png]]

When users click on a badge, they are redirected to a page with issued badge details. On this page, badge owners can download an image file or send it directly to their Mozilla backpack (if external backpacks are enabled in site global settings).

[[File:15_issued.png]]

Another option for users to see their latest badges is through "My badges" block that can be added to such pages as "My Home" page. Block can be configured to display a certain number of badges (it displays 10 badges by default).

===Connecting external backpack===

If administrator has allowed using external backpacks on the web site, users can set up connection to their backpack on "My badges" page.

Before connecting to external backpack, make sure that you have set up account in the backpack and have a public group of badges available to display.

'''Important Note''': Currently, only connections to [http://beta.openbadges.org Mozilla Backpack] is possible. Once more backpack providers are available to us, we will extend this functionality with an option to choose user preferred backpack service.

When setting up a backpack connection for the first time, users will be prompted to add their email in the backpack and select a group of badges to display.

[[File:16_backpack.png]]

If backpack connection is successfully established, a user will see the results on their "My badges" page.

[[File:17_backpack2.png]]

OpenBadges User Documentation

2013-02-11T03:46:29Z

Simoncoggins: /* Using Open Badges Feature */

{{Work in progress}}

==Background==

This document describes how to use [[openbadges]] feature developed by [http://www.totaralms.com/ TotaraLMS].

The code is available on github at [https://github.com/totara/openbadges totara/openbadges]. You can use it to install your own site (!Please don't use this code on a production site yet. This is still work in progress!), or you can try out our test site at [http://openbadgestotara.elearning.catalyst.net.nz openbadgestotara]. This test site has the external backpack connections and admin access disabled, but you can play around as a teacher (to create badges) or a student (to earn them).

Test site login credentials:

username: ''teacher''
password: ''teacher''

username: ''student''
password: ''student''

If you would like to give us any feedback, please use this [https://moodle.org/mod/forum/discuss.php?d=197834 openbadges forum], or email to [mailto:yuliya.bozhko@totaralms.com Yuliya Bozhko].

==Using Open Badges Feature==

There are two categories of badges:

* Site badges - available to users site-wide and related to the site wide activities, like finishing a set of courses.
* Course badges - available to users enrolled in the course and related to the activities that happen inside of this course.

The main differences between badge types are the available criteria and the location within the navigation menus.

===Badges administration===

Site administrators and users with capability "moodle/badges:manageglobalsettings" can set up general settings for badges such as default issuer name, url, contacts, and enable course badges or external backpack connections. These settings are used to populate relevant fields of a new badge form and can be changed by a badge creator if necessary.

[[File:0_settings.png]]

===Creating badges===

Badges can be created by users with capability "moodle/badges:createbadge". By default, this capability is set for '''manager''', '''course creator''', and '''editing teacher''' roles.

[[File:1_newbadge.png]]

After a badge has been created, users can check its details on overview page.

[[File:2_created.png]]

===Managing badges===

On "Manage badges" page in course or site administration, all existing badges are displayed in a table showing current badge image, name, status, criteria, how many users have already earned this badge, and a set of available actions.

[[File:8_management.png]]

Depending on user role and permissions, the following actions are available in badge management:

[[File:9_actions.png]]

'''Note''': Availability of activate and deactivate actions depends on the current status of a badge (e.g. if a badge is active, users will see deactivate action icon).

Before a badge has been issued to at least one user, all its details and settings can be edited. Use "Edit badge" action icon to access badge editing options.

To set up badge criteria, navigate to "Criteria" tab and select a required option. Criteria are added one at a time with additional options available for each criteria.

[[File:3_select-criteria.png]]

For example, when a user selects "Manual issue by a role" requirement, they will be prompted to select which roles can award the badge and what rules apply to this requirement.

[[File:4_add-manual.png]]

After criterion is set and added, it will be displayed among current badge criteria.

[[File:5_added-manual.png]]

To edit a body and subject of a message which users get upon earning the badge, go to "Message" tab.

Among additional options here are "Attach badge to message" which allows adding an image file to an email and "Notify badge creator" which sends a notification to a badge creator when badge is awarded (this option is available in course badges only).

[[File:6_message.png]]

"Award" tab displays a list of users who have already earned this badges.

[[File:14_viewawards.png]]

===Earning badges===

Once all criteria are set and badge creator is happy with badge details and settings, site users can start earning it. For users to be able to earn a badge, it first needs to be activated by a badge creator/administrator on a badge overview page or "Manage badges" page (as shown on the picture).

'''Only active badges are available to users and can be earned!'''

[[File:7 activate.png]]

Normally, badges are awarded to users automatically based on their actions in the system. Completion criteria of an active badge are re-calculated every time an event such as completion of a course or activity, or updating user profile happens. If a user completed all necessary requirements, they are issued a badge and sent an email notification.

[[File:11_email.png||border]]

Badges that have manual award among their criteria can be issued by one user to another. Users who issue a badge must have "moodle/badges:awardbadge" capability. Site administrators can choose their role when issuing a badge.

[[File:10_award.png]]

'''Important Note''': Currently, once a badge has been issued, it cannot be revoked. So, make sure that you are giving a badge to the right users.

===Displaying badges===

Newly earned badges are added to a private user badge collection which can be managed on "My badges" page from "My profile" options menu. On "My badges" page users can view all earned badges and their details, download these badges, manage their visibility on user profile, and perform search through the badges. If a badge has expired, "Expired" indicator will be added to a badge image. Such badges are still displayed on a user profile page.

If external backpack connections are enabled on the web site, there will also be option related to external badges management.

[[File:13_mybadges.png]]

All badges earned by a user can be displayed on their profile page.

[[File:12_profile.png]]

When users click on a badge, they are redirected to a page with issued badge details. On this page, badge owners can download an image file or send it directly to their Mozilla backpack (if external backpacks are enabled in site global settings).

[[File:15_issued.png]]

Another option for users to see their latest badges is through "My badges" block that can be added to such pages as "My Home" page. Block can be configured to display a certain number of badges (it displays 10 badges by default).

===Connecting external backpack===

If administrator has allowed using external backpacks on the web site, users can set up connection to their backpack on "My badges" page.

Before connecting to external backpack, make sure that you have set up account in the backpack and have a public group of badges available to display.

'''Important Note''': Currently, only connections to [http://beta.openbadges.org Mozilla Backpack] is possible. Once more backpack providers are available to us, we will extend this functionality with an option to choose user preferred backpack service.

When setting up a backpack connection for the first time, users will be prompted to add their email in the backpack and select a group of badges to display.

[[File:16_backpack.png]]

If backpack connection is successfully established, a user will see the results on their "My badges" page.

[[File:17_backpack2.png]]

openbadges

2013-02-03T23:56:58Z

Simoncoggins: /* Links */

{{Work in progress}}

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1][3]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

[3] At the moment, we are also considering locking badge criteria from changes once at least one badge was awarded based on existing criteria. To update the badge completely, badge creator will have to copy/duplicate the badge and make all the changes (Yuliya).

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
Current work towards technical specification can be followed on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and management in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once OpenBadges Infrastructure supports federated backpack providers we would like to add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [http://moodle.org/mod/forum/discuss.php?d=197834 Moodle.org forum post]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]
* [http://github.com/totara/openbadges-docs Specifications on github]
* [http://github.com/totara/openbadges Code on github]

The Moodle Universal Cache (MUC)

2013-01-16T01:23:03Z

Simoncoggins: /* Controlling interaction */

{{Infobox Project
|name = The Moodle Universal Cache (MUC)
|state = Stage 1 completed, stage 2 in progress
|tracker = MDL-25290 and MDL-34224
|discussion =
|assignee = [[User:Sam Hemelryk|Sam Hemelryk]]
}}
{{Moodle 2.4}}

==Foreword==
Over the past couple of weeks I have used my available time to look into a caching solution for Moodle. 
The concept is not a new one and for the past years people have constantly come back to the need for a proper caching solution, particuarly one that allows for a shared cache. 
The tracker issue MDL-25290 has been set up to follow progress on finding a solution, and in fact Tony Levi plus others have writen a community proposal and made initial headway in code [[Caching_system_%28proposed%29|Caching_system_(proposed)]].

I've now read through their proposal and solution, looked into the different caching systems that are available, looking into what other web solutions are doing, and researched the needs that we have in Moodle and have now planned the solution that will make up this proposal.

==The existing proposal==
Having read through the current proposal and having looked at the code created by Tony I can tell you right now that they are off to a very good start. In my research into this I think that we need to take it further again however if you look at the existing solution you will notice that this proposal takes a lot of what they already have and expands upon it.

==Requirements==
The following are the requirements that this new solution hopes to satisfy.
* Add a shared (application) cache.
* Add a static cache to replace static variables presently in use.
* Suitable to replace existing cache solutions with equal or better performance. (the lang string cache will be the primary test case).
* Integrate with and support existing cache products.
* Some mind to support future caching products.
* Have a relativily simple, self explanatory nature to aid developers in making the most of it.
* The cache product integration should also be relativily simple and self explanatory to ensure now cache produce integrations are easy to write.
* Have suitable fail over systems so that things continue to work even when the caches are unavailable.
* Able to be initialised early on in system initialisation (before config for example so that we can cache that)
* Support a time to live on data where applicable to ensure developers can determine how long information can live in the cache before deemed out of date and needs to be generated again.

==Outline==
The section contains information on the key ideas and structures that will form the basis for the cache solution.

===Cache types===
The first thing to understand is that there are three cache types that have been defined and will be addressed by this solution. Each cache type represents a separate way in which information can be cached, and each while being operated identically will function completely differently.

These cache types are one of the few things that developers will need to understand about the cache solution. When defining every cache a cache type needs to be selected for it. That cache type will determine who the cached information is available to and for how long the cache instance will live.

For each type there will be a representative class that the developer can instantiate for a cache and work with to retrieve and set data. This is as far as the developer will usually need to be familiar with the Cache API, everything they require to work with a cache will be made available through the cache type objects.

The three cache types are details below:

====Request cache====
You can think of the request cache type like a static property. It is alive for the duration of the request and cleared at the end of every request. It is also important to point out that this cache is of course user specific, so information stored in the cache will only be accessible to the user who put it there in the first place.

This cache type will be used to replace static caches currently used through Moodle (think static variables, static properties, and global variables).

By default, if either not cache instance has been assigned to the request cache type, or if the data can not be stored in the defined cache instance then a static memory based cache will be used by default.

====Session cache====
The session cache is exactly as the name suggests similar to the session made available through PHP. It is alive for the duration of the users session and of course user specific. At the end of the users session information will be purged (by means of cron or similar).

This is probably the most limited cache type, however the idea behind it is to separate out information that would be blowing out the current session size and allow an installation to specify an instance dedicated to its storage.

====Application====
This is the most prominent and beneficial cache type as there is nothing like it presently within Moodle. The application cache type is a shared cache that all users can access making common data accessible to all without the need for every user to generate it for every request or generate once and store in a user specific cache.

The life time of information within the cache will be determined by a time to live that will be specified by the developer, and will default when not specified to a configuration setting.

===Cache plugins===
This is the second most important thing to understand is that there will be a new plugin type introduced into Moodle, the Cache plugin. The Cache plugins base directory will be $CFG->dirroot/cache and each plugin will have its own sub directory there. Initially we are planning to produce plugins for APC, Memcache, XCache, Database, Static, and File each of which will of have its own sub directory.

Each plugin will define its own cache plugin class that will be required to extend an abstract class or interface that will map out all of the required methods of the plugin.

Also be aware that there can be multiple instances of a plugin. For example you could have two instances of a cache product set up, one a limited set up on the web server, and another running on remote machines. You could then map each instance to particular cache type, or in the future perhaps even a specefic cache.

This is important for a couple of reasons, first that it will allow load balancing and/or prioritisation to occur, and second that it will allow us to further what we can do with the cache solution in the future (after initial integration).

===The cache manager===
The cache manager will tie everything together. It will be responsible for initialising cache instances when required, making generalistic information available, and publishing static methods to interact with the cache solution as a whole. 
This will include publishing events for the following:
* Available cache plugins
* Available configured cache instances
* Maximum data and/or cache size
* Setting and creating the configuration file
* Retrieving and processing the configuration file

Although the cache_manager will be tieing everything together a developer wishing to use the cache API will not in fact need to know anything about it, to keep the cache API straight forward and simple to most common functionality will be wrapped for convienience into several controlling classes, one for each cache type, that will make storing and retrieving data from a cache a very simple task.

In this way the uses of the cache manager within core code will likely be internal use by the cache API itself, and core code where the advanced parts of the API will be required such as configuring instances, or purging caches on cron or through the existing admin interface.

===Logic separation===
The logic for the cache API will be separated into three very clear, separate sections. These sections are API use, core logic, and plugin development. These three highlight the very important idea that when using, or working with this API the developer need only know about the secion they are working with.

; API use : When using the API the developer will not know, or need to know anything at all about cache plugins that have been installed, what instances are available for each of those plugins, or even where their information is going to be stored. The developer will work with a cache type class (more on those later) that gets initialised with the details of the cache and can then be interacted with simply. All the developer needs to know is which cache type they should be making use of. Everything else will be taken care of internally by the core logic, and actual caching and retrieving by the cache plugin (that the developer knows nothing about).
; Core logic : The core logic refers to what ever is controlling the cache (the cache_manager) which will be aware of what plugins are available, and what instances exist for each plugin. It is responsable for managing those plugins, the plugin instances, and any cache events (such as purging all caches). This may sound like a very significant part of the cache solution, and that is because it is. However its very important to recognise that all of those management and general features are going to be rarely used by the developer. In fact I would very few people ever having to utilise the cache manager and this section of the API. It is more for internal, and edge case core use than anything else.
; Plugin development : This is a very essential part of both the solution and the API, the development of cache plugins. In developing a plugin the developer will not need to pay heed to the cache types, or the cache_manager controller. In fact the plugin ther develop will only need to publish methods for the essential interaction with the cache, get, set, delete etc. It will be provided with only the required, already parsed and ready information required for those operations, and will not need to do anything but interact with the cache. Everything else will be taken care of internally by the core logic.

===Controlling interaction===
As mentioned above for convenience and ease of use of the cache API access to it will be controlled by several classes, one for each cache type. All of these classes will operate in the same means (extending the same parent) and will make any allowances required for the cache type internally.

The cache type classes will be designed to be initalised for each bit of data the developer wishes to be cached. Once initialised simple methods are available on the object to get, set, check whether the cache has the information, and delete information from the cache. 
As this is something more easily understood through code example take a peak at the following snippet of code that illustrates how I see interaction occuring.
<code php>
$courseid = required_param('courseid', PARAM_INT);
$cache = new cache_application('core_course', 'modinfo', array('id' => $courseid));
if (!$modinfo = $cache->get($courseid)) {
$course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
$modinfo = get_fast_modinfo($course);
$cache->set($courseid, $modinfo);
}
</code>
As you can see once the object has been initialised for the cache its as simple as calling '''get()''' to retrieve the information, or '''set($data)''' to set it.

As there are three cache types purposed the following classes will be created to control interaction:
; cache_request : For working with a request cache.
; cache_session : For working with a session cache.
; cache_application : For working with an application wide cache.

===Configuration===
In discussing this proposal with Eloy this was one area we highlighted as small but critical area of the cache solution. Initialy I had planned to make use of the main database introducing new tables to record information on plugin instances and their mappings to cache types. 
However in discussing this we decided that there was three problems with this, first it would introduce overhead as we would need to execute a couple of queires to build the required information, second the information being stored would itself be a candidate for caching, and third it would require the setup code for Moodle to be initialised past the point of loading configuration before the code would be usable preventing us for caching the configuration which is one of the candidates for caching.

Our solution to this: the configuration for the caches will be stored in the dataroot as a PHP file, similar to what we do with the current lang cache. 
From there it will be included by the cache API and parsed when the API is first used in a page.

This negates the requirement for additional database tables and interaction, and will allow us to utilise the cache solution much earlier during setup, early enough to allow us to cache configuration.

===The cacheable interface===
There will also be a new cacheable interface, much like the rendererable interface, which can be given to a class to mark it as having special cache methods. 
The interface will have two required methods, the first method will be called when the data is being parsed before being cached and will require the method to return a simple type (stdClass, or array) containing information that will be used to reinitialise the object when it is reawakened. The second method will be a static method and will be given the cached data and expected to reinitialise the object.

A couple of things about this approach:
# This has been done so that objects can take control of what gets cached when they get cached. This allows them to ensure nothing dynamic will be cached and that they don't clutter thing if they are large structures.
# The interface and specific methods will be used rather than utilising serialisation etc because each cache plugin should have its own say on how to process data right before storing it and there will be no requirement to serialise data. This simplification of data happens automatically by some cache programs so there is no way we could ever rely on the magic serialise methods.
# It also has the advantage of clearly marking the object as cacheable when other developers are looking at the code.

==Code specific information==
Basic details on my early thoughts of about the code.

First up please note from the very start I had intended in my thinking and design contruct this design purely in an object orientated fashion. There will be no global functions introduced, everything will be made available through class static methods, or through object instance methods.

===Directories and files===
The following unless otherwise stated make use of $CFG->dirroot. Obvious requirements such as a plugins version and lang files have not been included in this list.

; /cache : The cache plugin directory, and the home of the files that are essential to the cache solution.
; /cache/lib.php : Will contain all of the cache API core classes, and will be included in the list of requires presently happening within /lib/setup.php.
; /cache/settings.php : All of the general settings (and inclusion of external pages) for the cache solution. It will also be responsible for including plugin settings pages if they exist.
; /cache/pluginname : A directory used to house a cache plugin, pluginname will of course be the name of the plugin. It's component will be cache_pluginname.
; /cache/pluginname/lib.php : Will contain the plugin class and be included upon initialisation of cache_manager (its first use).

===Essential classes and public methods===

{| class="nicetable"
|-
! colspan="3" | cache_manager
|-
| static
| instance
| Will return an instance of the cache_manager. This instance will be statically stored within the method as only one cache_manager will ever be required under normal circumstances. However an override may be required to force a re-initialisation such as for configuration changes.
|-
| static
| prepare_data_for_caching
| Helper method to parse data removing references and interacting with cacheable objects.
|-
| static
| parse_cached_data
| When data is brought out of the cache it should be run through this.
|-
| static
| early_get_cache_plugins
| Gets all of the cache plugins that are available without using any core functions so that it can be called early before setup is finished.
|-
|
| add_plugin_instance
| For internal use to add a plugin instance to the configuration.
|-
|
| edit_plugin_instance
| For internal use to edit a plugin instance already in the configuration.
|-
|
| delete_plugin_instance
| For internal use to delete a plugin instance from the configuration.
|-
|
| add_instance_mapping
| For internal use to map a plugin instance to a cache type.
|-
|
| delete_instance_mapping
| For internal use to remove an instance => cache type mapping.
|-
|
| get_cache_type_default
| Returns a cache instance that is the default for a given type
|-
|
| get_cache_type_instance
| Returns the cache instance to use for a given type. Returns the default is none is configured or ready.
|-
|}

{| class="nicetable"
|-
! abstract
! colspan="2" | cache_type
|-
|
| get_type
| Returns the type of this cache type
|-
|
| is_user_specific
| Returns true if the cache type is user specific (request or session).
|-
|
| get
| Retrieves data from the cache for the instance
|-
|
| set
| Sends data to the cache for the instance.
|-
|
| has
| Checks if data exists in the cache for the instance.
|-
|
| delete
| Deletes the data for cache for the instance.
|-
|
| purge
| Purges all information from the entrie cache (not just the data specific to an instance).
|-
|
| uses_simple_types_only
| If called a flag is set to gaurantee simple types only (scalars and array or stdClass instances containing scalars). This can be called to avoid the overhead of data parsing which is not required for simple types under most circumstances.
|-
|}

{| class="nicetable"
|-
! abstract
! colspan="2" | cache_plugin
|-
| static
| is_supported
| Returns true if the plugin is supported (required things installed).
|-
| static
| is_supported_cache_type
| Returns true if the plugin can be used for the given cache type.
|-
| static
| supports_native_ttl
| Returns true if the plugin nativily supports ttl. If it doesn't then ttl will have to be managed internally.
|-
|
| initialise
| Initialises the plugin instance upon its first use.
|-
|
| is_ready
| Returns true if this plugin is properly configured and ready to be used.
|-
|
| supports_multikey
| Returns true if the plugin supports multiple keys, or if it wants to perform its own key handling.
|-
|
| get
| Retrieves the data for the given key from the cache.
|-
|
| set
| Adds the given key => value pair to the cache program.
|-
|
| has
| Checks if there is data for the given key in the cache.
|-
|
| delete
| Deletes the data associated with the given key.
|-
|
| purge
| Purges all information from the cache.
|-
|
| close
| Gets called when the cache variable is destroyed (e.g. at the end of the request) and allows the plugin to perform and closing tasks and cleanup (closing connections, saving files etc).
|-
|}

==Whats to be done==
The following is what needs to be done for before this can be put up for integration into core, hopefully in time for the release of 2.3
* Implement the Cache API
* Implement two special cache instances "static" and "dataroot" to serve as defaults and fall over systems when nothing has been configured or data being cached is unsuitable for the selected solution.
* Implement cache plugins for the following products
** APC
** Memcache
** XCache
** Database
** Static
** File
* Conversion of the following three areas in order or priority
*# Lang string cache. This will be be the first point of testing for the new system as the string requirements are predictable and should be significant enought to easily measure and quantify.
*# Database meta information, particually focused around get_table, and get_column.
*# Config data, this will be a test of the system to ensure it can be initialised early on in overall system initialisation.
* Create an admin tool that can create/edit/delete plugin instances as well as map them to cache types.
* Document the whole system and create tutorials in the docs wiki.

==Whats to be done after the initial integration==
The following are things that can and or need to be done after integration:
* Convert existing cache and static variables/properties to make use of MUC instead [where applicable]
* Implement support for xxx/db/caches.php files that detail where caches are used and what for (read the next to do to see why)
* Expand the admin tool so that cache instances can be mapped to caches specified in xxx/db/caches.php files.

==Proof of concept==
I've created a proof of concept that implements the proposal as at the time of writing. 
This can be found on my github account: https://github.com/samhemelryk/moodle/compare/ba3e7df265...poc_cache_1

While the proof of concept doesn't have the admin interfaces for configuring plugin instances it is largely functional and there a a couple of hundred PHPunit tests for it already.

==Cache terminology==
; Cache : A cache is a collection of data that is kept on hand and made readily available in order to avoid costly fetching and molding upon every request. In this document when I refer to a cache I am referring to an area in code where such information is being dealt with.
; Cache solution : The solution refers the the MUC implementation and everything it embodies, the API, all of the plugins, the milestones etc.
; Cache API : The cache API consists of the cache manager, its supporting classes, and methods both public and private (Where I mention public API or outwards API I am referring to the public methods that developers will be able to make use of).
; Cache product : A 3rd party product that handles the actual caching on information such as APC, or memcache.
; Cache type: There are three cache types defined in this proposal, each is representative of one way of storing information.
; Cache plugin : A cache plugin is code that is reponsible for bridging the cache API and a particular cache product. For instance we expect to have an APC cache plugin.
; Cache instance : A cache instance is single instance of a cache plugin that has been configured to for a specific system. You can have multiple instances of a cache plugin, this is done so that you can direct different cache types to different memcache systems for instance.

Cache API

2013-01-16T01:21:11Z

Simoncoggins:

This document details the Cache API aka MUC aka Moodle's Universal Cache.
I've chosen to use a tutorial/example flow for this document always working with a theoretical module plugin called myplugin.
There is also a [[Cache API - Quick reference]] if you would rather read that.

==Basic usage==
It's very easy to get started with the Cache API. It is designed to be as easy and as quick to use as possible and is predominantely self contained.
All you need to do is add a definition for your cache and you are ready to start working with the Cache API.

===Creating a definition===
Cache definitions exist within the db/caches.php file for a component/plugin. 
In the case of core that is the moodle/lib/db/caches.php file, in the case of a module that would be moodle/mod/myplugin/db/caches.php.

The definition is used API in order to understand a little about the cache and what it is being used for, it also allows the administrator to set things up especially for the definition if they want.
From a development point of view the definition allows you to tell the API about your cache, what it requires, and any (if any) advanced features you want it to have. 
The following shows a basic definition containing just the bare minimum:
<code php>
// moodle/mod/myplugin/db/caches.php
$definitions = array(
'mycache' => array(
'mode' => cache_store::MODE_APPLICATION
)
);
</code>
This informs the API that the myplugin module has a cache called ''somedata'' and that it is an application (globally shared) cache. 
When creating a definition thats the bare minimum, to provide an area ''(somedata)'' and declare the type of the cache application, session, or request. 
:An application cache is a shared cache, all users can access it. 
:Session caches are, well, just stores in the users session. 
:Request caches you can think of as static caches, only available to the user owning the request, and only alive until the end of the request. 
There are of course many more options available that allow you to really take the cache by the reigns, you can read about some of the important ones further on, or skip ahead to [[#The definition]] section which details the available options in full.

===Getting a cache object===
Once your definition has been created you should bump the version number so that Moodle upgrades and processes the definitions file at which point your definition will be useable.

Now within code you can get a cache object to interact with in the following manner.

<code php>
$cache = cache::make('mod_myplugin', 'mycache');
</code>

The cache::make method is a factory method, it will create a cache object to allow you to work with your cache. The cache object will be one of several classes chosen by the API based upon what your definition contains. All of these classes will extend the base cache class, and in nearly all cases you will get one of cache_application, cache_session, or cache_request depending upon the mode you selected.

===Using your cache object===
Once you have a cache object (will extend the cache class and implements cache_loader) you are ready to start interacting with the cache.

Of course there are three basic basic operations. get, set, and delete.

The first is to send something to the cache.
<code php>
$result = $cache->set('key', 'value');
</code>
Easy enough. The key must an int or a string. The value can be absolutely anything your want.
The result is true if the operation was a success, false otherwise.

The second is to fetch something from the cache.
<code php>
$data = $cache->get('key');
</code>
$data will either be what ever was being stored in the cache, or false if the cache could not find the key.

The third and final operation is delete.
<code php>
$result = $cache->delete('key');
</code>
Again just like set the result will either be true if the operation was a success, or false otherwise.

You can also set, get, and delete multiple key=>value pairs in a single transaction.
<code php>
$result = $cache->set_many(array(
'key1' => 'data1',
'key3' => 'data3'
));
// $result will be the number of pairs sucessfully set.

$result = $cache->get_many(array('key1', 'key2', 'key3'));
print_r($result);
// Will print the following:
// array(
// 'key1' => 'data1',
// 'key2' => false,
// 'key3' => 'data3'
// )

$result = $cache->delete_many(array('key1', 'key3');
// $result will be the number of records sucessfully deleted.
</code>

That covers the basic operation of the Cache API. 
In many situations there is not going to be any more to it than that.

==Ad-hoc Caches==
This is the alternative method of using the cache API. 
It involves creating a cache using just the required params at the time that it is required. It doesn't require that a definition exists making it quicker and easier to use, however it can only use the default settings and is only recommended for insignificant caches (rarely used during operation, never to be mapped or customised, only existsing in a single place in code).

Once a cache object has been retrieved it operates exactly as the same as a cache that has been created for a definition.

To create an ad-hoc cache you would use the following:
<code php>
$cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'mod_myplugin', 'mycache');
</code>

Really don't be lazy, if you don't have a good reason to use an ad-hoc cache you should be spending a extra 5 minutes creating a definition.

==The definition==

The above section illustrated how to create a basic definition, specifying just the area name (the key) and the mode for the definition. Those being the two required properties for a definition. 
There are as well many other options that will let you make the most of the Cache API and will undoubtedly be required when implementing and converting cache solutions to the Cache API.

The following details the options available to a definition and there defaults if not applied:

<code php>
$definitions = array(
// The name of the cache area is the key. The component/plugin will be picked up from the file location.
'area' => array(
'mode' => cache_store::MODE_*,
'requireidentifiers' => array('ident1', 'ident2'),
'requiredataguarantee' => false,
'requiremultipleidentifiers' => false,
'requirelockingread' => false,
'requirelockingwrite' => false,
'maxsize' => null,
'overrideclass' => null,
'overrideclassfile' => null,
'datasource' => null,
'datasourcefile' => null,
'persistent' => false,
'persistentmaxsize' => null,
'ttl' => 0,
'mappingsonly' => false,
'invalidationevents' => array('event1', 'event2'),
)
);
</code>

===Setting requirements===
The definition can specify several requirements for the cache. 
This includes identifiers that must be provided when creating the cache object, that the store guarantees data stored in it will remain there until removed, a store that supports multiple identifiers, and finally read/write locking.
The options for these are as follows:

; requireidentifiers : [array] An array of identifiers that must be provided to the cache when it is created.
; requiredataguarantee : [bool] If set to true then only stores that can guarantee data will remain available once set will be used.
; requiremultipleidentifiers : [bool] If set to true then only stores that support multiple identifiers will be used.
; requirelockingread : [bool] If set to true then a lock will be gained before reading from the cache store. It is recommended not to use this setting unless 100% absolutely positively required. Remember 99.9% of caches will NOT need this setting. This setting will only be used for application caches presently.
; requirelockingwrite : [bool] If set to true then a lock will be gained before writing to the cache store. As above this is not recommended unless truly needed. Please think about the order of your code and deal with race conditions there first. This setting will only be used for application caches presently.

===Cache modifiers===
You are also to modify the way in which the cache is going to operate when working for your definition. 
By enabling the persistent option the Cache API will only ever generate a single cache object for your definition on the first request for it, further requests will be returned the original instance. This greatly speeds up the collecting of a cache object. 
Enabling persistence also enables a static store within the cache object, anything set to the cache, or retrieved from it will be stored in that static array for the life of the request.
This makes the persistence options some of the most powerful. If you know you are going to be using you cache over and over again or if you know you will be making lots of requests for the same items then this will provide a great performance boost.
Of course the static storage of cache objects and of data is costly in terms of memory and should only be used when actually required, as such it is turned off by default.
As well as persistence you can also set a maximum number of items that the cache should store (not a hard limit, its up to each store) and a time to live (ttl) although both are discouraged as efficient design negates the need for both in most situations.

; persistent : [bool] This setting does two important things. First it tells the cache API to only instantiate the cache structure for this definition once, further requests will be given the original instance. Second the cache loader will keep an array of the items set and retrieved to the cache during the request. This has several advantages including better performance without needing to start passing the cache instance between function calls, the downside is that the cache instance + the items used stay within memory. Consider using this setting when you know that there are going to be many calls to the cache for the same information or when you are converting existing code to the cache and need to access the cache within functions but don't want to add it as an argument to the function.
; persistentmaxsize : [int] This supplements the above setting by limiting the number of items in the caches persistent array of items. Tweaking this setting lower will allow you to minimise the memory implications above while hopefully still managing to offset calls to the cache store.
; ttl : [int] A time to live for the data (in seconds). It is strongly recommended that you don't make use of this and instead try to create an event driven invalidation system. Not all cache stores will support this natively and there are undesired performance impacts if the cache store does not.
; maxsize : [int] If set this will be used as the maximum number of entries within the cache store for this definition. Its important to note that cache stores don't actually have to acknowledge this setting or maintain it as a hard limit.

===Overriding a cache loader===
This is a super advanced feature and should not be done. ever. Unless you have an very good reason to do so.
It allows you to create your own cache loader and have it be used instead of the default cache loader class. The cache object you get back from the make operations will be an instance of this class.

; overrideclass : [string] A class to use as the loader for this cache. This is an advanced setting and will allow the developer of the definition to take 100% control of the caching solution. Any class used here must inherit the cache_loader interface and must extend default cache loader for the mode they are using.
; overrideclassfile : [string] Suplements the above setting indicated the file containing the class to be used. This file is included when required.

===Specifying a data source===
This is a great wee feature, especially if your code is object orientated. 
It allows you to specify a class that must inherit the cache_data_source object and will be used to load any information requested from the cache that is not already being stored. 
When the requested key cannot be found in the cache the data source will be asked to load it. The data source will then return the information to the cache, the cache will store it, and it will then return it to the user as a request of their get request. Essentially no get request should ever fail if you have a data source specified.

; datasource : [string] A class to use as the data loader for this definition. Any class used here must inherit the cache_data_loader interface.
; datasourcefile : [string] Suplements the above setting indicated the file containing the class to be used. This file is included when required.

===Misc settings===
The following are stand along settings that don't fall into any of the above categories.

; invalidationevents : [array] An array of events that should cause this cache to invalidate some or all of the items within it.
; mappingsonly : [bool] If set to true only the mapped cache store(s) will be used and the default mode store will not. This is a super advanced setting and should not be used unless absolutely required. It allows you to avoid the default stores for one reason or another.

==The loader==

==Using a data source==

==Developing cache plugins==

openbadges

2012-10-23T15:56:11Z

Simoncoggins: /* Links */

{{Work in progress}}

==Background==

In September 2011, Mozilla [http://blog.mozilla.org/blog/2011/09/15/openbadges/ launched] the Open Badges project as a way to "make it easy to issue and share digital learning badges across the web". Mozilla have developed an [https://wiki.mozilla.org/Badges/infrastructure-tech-docs open specification] and API for badge creation and sharing and are looking for developers to implement infrastructure that makes use of the badges.

[http://www.totaralms.com/ TotaraLMS] have volunteered to [http://moodle.org/mod/forum/discuss.php?d=197834 lead the development] to integrate Open Badges into Moodle (and also Mahara).

This document contains our initial ideas and some unanswered questions around implementation in order to receive feedback from the moodle community on what is required and how to implement it.

==User Stories==

Our first step is to attempt to define the requirements and priorities. Feedback welcome:

===Badge creation===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Site administrator||Be able to control who is able to create and issue badges||I can manage the issuing of badges from my organisation||Must have
|-
|Course creator||Be able to create badges||I can issue badges to students for achievements||Must have
|-
|Course creator||Be able to modify existing badges [1]||I can make changes to a badge without having to start again||Must have
|-
|Course creator||Be able to delete badges||They can be removed from the system when no longer required||Must have
|-
|Course creator||Be able to set a background image for the badge||I can customise the appearance of the badges I create||Must have
|-
|Course creator||Be able to embed custom text into the badge image||I can choose the text shown on the badges I create||High
|-
|Course creator||Be able to embed user specific text into the badge image||I can create badges that are specific to each user||High
|-
|Course creator||Be able to clone existing badges||I can create similar badges with less work||Medium
|-
|Site administrator||Be able to create badge design templates for course creators to use||I can provide a consistent look for badges across my organisation||Medium
|-
|Course creator||Be able to create badges based on site-wide design templates||I can quickly create similar looking badges||Medium
|-
|}

[1] Note this means changing the badge that will be issued from that point on - the open badges spec intentionally prevents an issuer from modifying badges once they have been issued to the user for security reasons

===Badge assignment===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to control the criteria that leads to the issuing of badges||I can ensure badges are only issued to students who have achieved them||Must have
|-
|Student||Be able to receive a notification when I have received a new badge||I know when I have made an achievement||Must have
|-
|Student||Be able to receive a copy of badges I achieve||I can keep my own records of my achievements and upload to other services||Must have
|-
|Course creator||Be able to receive notification when a student receives a badge||I can stay informed about my student's progress||High
|-
|}

===Badge display===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Student||Be able to see all of the badges that I have achieved via the site in one location||I can get an overview of my achievements||Must have
|-
|Student||Be able to see the public or shared badges belonging to other users||I can see what learning my peers have achieved.||High
|-
|Student||Be able to see all of the badges that I can achieve via the site||I can prioritize and plan my learning||High
|-
|Student||Be able to control who is able to see each of my badges||I can decide for myself who I would like to share my achievements with.||Medium
|-
|Student||Be able to display all the badges in my "backpack", including those from outside the Moodle site||I can let others know about other learning that I've achieved from other sources.||Medium
|-
|}

===Badge management===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Course creator||Be able to see which of my students have achieved a specific badge||I can track the progress of my students.||Must have
|-
|<del>Course creator</del>||<del>Be able to revoke badges that are no longer valid</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|<del>Course creator</del>||<del>Be able to inform a student that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct an error if a badge is assigned by mistake.</del>||<del>Must have</del>
|-
|Course creator||Be able to see the badges achieved by an individual student||I can assess the progress of an individual student.||High
|-
|Site administrator||Be able to see the badges achieved by any site user||I can track the progress of individuals.||Medium
|-
|Site administrator||Be able to see which site users have achieved a specific badges||I can track overall achievement of a particular badge.||Medium
|-
|<del>Site administrator</del>||<del>Be able to revoke badges across the entire site</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|<del>Site administrator</del>||<del>Be able to inform a set of students that a badge has been revoked and remove it from display for that user</del>[2]||<del>I can correct errors by individual course creators.</del>||<del>Medium</del>
|-
|Student||Be able to push individual badges from Moodle into my external badge backpack||So that I can share my badges externally to moodle||Medium
|-
|Student||Be able to automatically push all my badges from Moodle into my external badge backpack||So that my achievements are available in my backpack without having to push them every time||Low
|-
|Course creator||Be able to set an expiry period for badges||I can use badges in cases where achievements only last a fixed period of time.||Low
|-
|Course creator||Be able to automatically generate user-specific evidence for badges||I can show how students earned the badge.||Low
|-
|Course creator||Be able to perform more detailed reporting (such as who hasn't achieved a badge yet)||I can see which students I need to follow up with.||Low
|-
|}
[2] Revoking of issued badges is not currently possible in Open Badges infrastructure

===Badge verification===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Assessor||Know that all badges displayed within the system are valid (have been achieved by the user they are displayed for)||I can be certain that the badges displayed within the system have all been achieved.||Must have
|-
|Assessor||Be able to confirm from the original source that a badge being displayed by a user (outside of the system) is valid||I can be certain that the student has achieved a particular badge.||Must have
|-
|}

===Integration with Mahara===

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...||Priority
|-
|Mahara user||Be able to easily display all my achieved badges||I can include my achievements in my porfolio.||Must have
|-
|Mahara user||Have my badges from Moodle automatically imported into Mahara||I don't have to manually copy new badges each time I achieve something.||Must have
|-
|Mahara user||Control which badges appear when displaying them in my porfolio||I can present different representations of my achievements to different audiences.||High
|-
|Site administrator||Remove badges from a users portfolio if they have been revoked||I can prevent a user displaying badges that are no longer valid.||High
|-

|}

==Implementation Options==

Moodle already has a module which behaves in a similar way to the proposals for open badges - the [http://moodle.org/plugins/view.php?plugin=mod_certificate Certificate Module]. Initial idea was to consider extending the certificate module to avoid rewriting similar code. However, after some discussions and feedback on the [http://moodle.org/mod/forum/discuss.php?d=197834 community forum], we decided to look at implementing a separate module for Open Badges.

===Badge awarding criteria===

For initial development, we expect to support the following criteria that will lead to the issuing of badges:

* Completing an activity or set of several activities (viewing an activity as a part of it)
* Completing a course
* Completing a set of courses
* Posting to a forum
* Filling in user profile (to encourage participation)
* Discretionary awarding of badges by teacher (e.g to reward certain behaviour)

===Technical specification===
Current work towards technical specification can be followed on GitHub [https://github.com/totara/openbadges-docs Totara openbadges-docs] repository.

==Open Badges Integration==

Open badges are still in beta so we can expect additional features and possibly some API changes over time. v1 is due out [https://wiki.mozilla.org/Badges/roadmap#Q1:_Ship_OBI_v1.0 Q1 2013].

===Implementation plan===

Here is a diagram of the [https://wiki.mozilla.org/images/4/44/Tech-diagram-v3_updated.png current infrastructure] for managing badges. We intend to develop the functionality to make Moodle both a "displayer" and a "issuer" of badges and Mahara as a "displayer".

This diagram outlines the various components:

[[File:Moodle_Open_Badges_Infrastructure_Diagram.png|Open Badges infrastructure diagram]]

It should be possible to implement each component as separate modules. Our proposed order:

# Badge creation and verification service in Moodle.
# Moodle Block to display badges received from the site (internal badges)
# Add code to support direct pushing of internal badges to external backpack (without having to manually download/upload them)
# Badge displayer in Mahara (displays external badges and any internal ones that have been pushed to backpack and shared)
# Badge displayer in Moodle (displays external badges and any internal ones that have been pushed to backpack and shared)
# Add code to support direct pushing of internal badges to Mahara via Porfolio API (no need for external backpack)

Once open badges supports federated backpack providers we may also add:

7. Allow Mahara sites to become backpack providers

The reason for providing a direct method for displaying internal badges without requiring an external backpack is because pushing badges to an external backpack requires an external account for managing badges as outlined here:

https://wiki.mozilla.org/Badges/Onboarding-Earner#II._FUNCTIONAL_FLOW:_FIRST_TIME_EARNER

This workflow has some advantages (primarily the user has full control over their own badges) but seems quite complex. Given that Moodle is both an issuer and displayer we are able to avoid this step for users who do not want to share their badges to a wider audience.

==Links==

* [http://www.openbadges.org/ Mozilla Open Badges website]
* [https://wiki.mozilla.org/Badges MozillaWiki on Open Badges]
* [http://bananigans.tumblr.com/post/22586770579/how-to-learn-more-about-open-badges How to learn more about Open Badges]
* [http://moodle.org/mod/forum/discuss.php?d=197834 Moodle.org forum post]
* [http://blog.mozilla.org/blog/2011/09/15/openbadges/ Mozilla blog post announcing project]
* [http://tracker.moodle.org/browse/MDL-35073 Moodle tracker issue]
* [http://github.com/totara/openbadges-docs Specifications on github]

reportbuilder/spec as user stories

2012-09-10T03:09:51Z

Simoncoggins: /* Report management */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Report content (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Data from one (or more) courses
|-
|Data belonging to one (or more) groups of users
|-
|Data belonging to one (or more) cohorts of users
|-
|Data belonging to users with status (active, suspended)
|-
|Data belonging to users in particular role(s)
|-
|Data belonging to users in any graded role
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:09:35Z

Simoncoggins: /* Report management */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Report content (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Data from one (or more) courses
|-
|Data belonging to one (or more) groups of users
|-
|Data belonging to one (or more) cohorts of users
|-
|Data belonging to users with status (active, suspended)
|-
|Data belonging to users in particular role(s)
|-
|Data belonging to users in any graded role
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:09:15Z

Simoncoggins: /* Report management */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Report content (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Data from one (or more) courses
|-
|Data belonging to one (or more) groups of users
|-
|Data belonging to one (or more) cohorts of users
|-
|Data belonging to users with status (active, suspended)
|-
|Data belonging to users in particular role(s)
|-
|Data belonging to users in any graded role
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:07:18Z

Simoncoggins: /* Filter options */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Report content (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Data from one (or more) courses
|-
|Data belonging to one (or more) groups of users
|-
|Data belonging to one (or more) cohorts of users
|-
|Data belonging to users with status (active, suspended)
|-
|Data belonging to users in particular role(s)
|-
|Data belonging to users in any graded role
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:05:42Z

Simoncoggins: /* Filter options */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Report content (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Data from one (or more) courses
|-
|One (or more) groups
|-
|One (or more) cohorts
|-
|User status (active, suspended)
|-
|User role(s)
|-
|Users in any graded role
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:04:49Z

Simoncoggins: /* Filter options */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Report content (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|One (or more) groups
|-
|One (or more) cohorts
|-
|User status (active, suspended)
|-
|User role(s)
|-
|Users in any graded role
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:02:10Z

Simoncoggins: /* Which records appear in report (rows) */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Report content (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:01:57Z

Simoncoggins: /* Which information appears in report (columns) */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Report content (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:01:23Z

Simoncoggins: /* Users who can view reports */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Report access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T03:01:11Z

Simoncoggins: /* Users who can create/manage reports */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Report management==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:54:08Z

Simoncoggins: /* Column options */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|User profile fields
|-
|Custom user profile fields
|-
|Specific fields depending on report type - see https://docs.moodle.org/dev/reporting_spec#What_is_to_be_reported_on
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:52:18Z

Simoncoggins: /* Data sources */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|Activity logs
|-
|Statistics
|-
|Course activity report
|-
|Course participation report
|-
|Course completion
|-
|Gradebook
|-
|Quiz
|-
|SCORM
|-
|Assignment
|-
|Lesson
|-
|Workshop
|-
|Users
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:48:58Z

Simoncoggins: /* Controlling manage access */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

List of methods for controlling who can create or manage reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:48:39Z

Simoncoggins: /* Controlling view access */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

List of methods for controlling who can see a particular report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:48:20Z

Simoncoggins: /* Data sources */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that report creators may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:48:09Z

Simoncoggins: /* Filter options */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that people may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

List of ways report creators or users may want to filter the data in a report

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:47:47Z

Simoncoggins: /* Column options */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that people may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

List of columns report creators may want to include in one of their reports

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:47:27Z

Simoncoggins: /* Data sources */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

List of things that people may want to report on:

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:46:46Z

Simoncoggins: /* Users who can create/manage reports */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports (see [[https://docs.moodle.org/dev/reportbuilder/spec_as_user_stories#Controlling_manage_access|Controlling manage access]])||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:46:13Z

Simoncoggins: /* Users who can view reports */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create (see [[reportbuilder/spec_as_user_stories#Controlling_view_access|Controlling view access]])||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:45:36Z

Simoncoggins: /* Report management methods */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Controlling manage access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:45:15Z

Simoncoggins: /* Access control methods */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Controlling view access==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Report management methods==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

reportbuilder/spec as user stories

2012-09-10T02:44:14Z

Simoncoggins: /* Which information appears in report (columns) */

=Reporting Spec as user stories=

I've taken the content from https://docs.moodle.org/dev/reporting_spec and tried to convert them to user stories detailing what is required:

==Which information appears in report (columns)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to report on different types of data (see [[reportbuilder/spec_as_user_stories#Data_sources|Data sources]])||I can create a report containing only what is relevant
|-
|Report creator||Be able to decide which columns to include in my report (see [[reportbuilder/spec_as_user_stories#Column_options|Column options]])||It only contains data which is useful to me
|-
|Site administrator||Be able to restrict which user fields can be included based on my selection in "User policies > Show user identity"||I can maintain the privacy of my users
|}

==Which records appear in report (rows)==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to view site-wide data in one place||I don't have to check multiple locations to get the information I need
|-
|Report creator||Be able to restrict which records appear in a report (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can make a report relevant to it's intended audience
|-
|Report user||Be able to filter the report contents (see [[reportbuilder/spec_as_user_stories#Filter_options|Filter options]])||I can find particular records of interest to me
|-
|Report user||Be able to filter by multiple items at the same time||I can see results from more than one item at a time
|-
|}

==Users who can view reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report creator||Be able to control which users can view a report I create||I can make reports private or only available to the people I want
|-
|Report user||Be able to view a list of reports I am allowed to see||I can find reports of interest to me
|-
|}

==Users who can create/manage reports==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Site Administrator||Be able to control which users can create reports||I can control access to the site's data
|-
|Report creator||Be able to create new reports||I can view and share reports on the site
|-
|Report creator||Update existing reports||I can make changes without having to create a new report
|-
|Report creator||Delete existing reports||Get rid of reports that are no longer required
|-
|Report creator||Clone an existing report||Save time when creating similar types of reports
|-
|}

==Report options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! As a...||I want to...||So that...
|-
|Report user||Be able to view a report as an HTML table||The report is easy to access via the site
|-
|Report user||Be able to export a report as a CSV file||I can download the data and manipulate it externally to Moodle
|-
|Report user||Be able to sort the report by any column||Organise the data into a form that is useful to me
|-
|Report user||Be able to restrict the overall width of the report||I can view a report without needing to scroll horizontally
|}

=Specific requirements=

==Data sources==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Column options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Filter options==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Source
|-
|
|-
|}

==Access control methods==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}

==Report management methods==

{|border="1" style="border: 1px solid #d0e0f0; clear:both; width: 100%" cellpadding="5"
|-
! Method
|-
|Specific users (from pick list)
|-
|Users with a specific role
|-
|Users with a specific capability
|-
|Users with a capability in the context of all of the courses included in the report
|-
|Users with a specific profile field value
|-
|}