Choice Results: Difference between revisions
No edit summary |
|||
| Line 17: | Line 17: | ||
This is at Site administration -> Advanced features where you need to enable and save the "Enable web services" setting | This is at Site administration -> Advanced features where you need to enable and save the "Enable web services" setting | ||
[[File:choice_res_enable_ws.png|600px|thumb|center|Enabling web services]] | |||
2) Ensure your site is ready for web services protocols | 2) Ensure your site is ready for web services protocols | ||
This is at Site administration -> Plugins -> Web services -> Manage protocols where you need to enable and save either of the protocols you wish to use (for this guide, we will be using the REST protocol) | This is at Site administration -> Plugins -> Web services -> Manage protocols where you need to enable and save either of the protocols you wish to use (for this guide, we will be using the REST protocol) | ||
[[File:choice_res_enable_protocols.png|600px|thumb|center|Enabling REST protocol]] | |||
3) Ensure your site settings are ready for mobile access, thus allowing choice submissions from users via mobile devices | 3) Ensure your site settings are ready for mobile access, thus allowing choice submissions from users via mobile devices | ||
This is at Site administration -> Plugins -> Web services -> Mobile where you need to enable and save "Enable web services for mobile devices" | This is at Site administration -> Plugins -> Web services -> Mobile where you need to enable and save "Enable web services for mobile devices" | ||
[[File:choice_res_enable_mobile.png|600px|thumb|center|Enabling mobile access]] | |||
4) Add a new user - call them "Choice View User" or something similar. | 4) Add a new user - call them "Choice View User" or something similar. | ||
| Line 35: | Line 37: | ||
On the first Adding a new role page, leave "Use role or archetype" set at "No role" and click on Continue | On the first Adding a new role page, leave "Use role or archetype" set at "No role" and click on Continue | ||
For Context types where this role may be assigned - assign to System | For Context types where this role may be assigned - assign to System | ||
Add | |||
[[File:choice_res_add_role1.png|600px|thumb|center|Add custom role]] | |||
In capabilities - filter for the word service - click on Allow for Web service: REST protocol, or whichever protocol you're using | In capabilities - filter for the word service - click on Allow for Web service: REST protocol, or whichever protocol you're using | ||
Add | |||
[[File:choice_res_add_role2.png|600px|thumb|center|Add capability]] | |||
Finally click on "Create this role" | Finally click on "Create this role" | ||
| Line 48: | Line 52: | ||
Search for your new user (you may need to filter by the user name) | Search for your new user (you may need to filter by the user name) | ||
Select your user in the list and click on Add to assign the user to the role | Select your user in the list and click on Add to assign the user to the role | ||
[[File:choice_res_assign_user.png|600px|thumb|center|Assign role]] | |||
When you reload the Assign system roles page, your new user should be listed in the Users with role column for the role. | When you reload the Assign system roles page, your new user should be listed in the Users with role column for the role. | ||
| Line 55: | Line 60: | ||
This is at Site administration -> Plugins -> Web services -> External services | This is at Site administration -> Plugins -> Web services -> External services | ||
Add the web service, call it Choice View or something similar, click on Enabled, click on Authorised users only and finally click on Add Service. | Add the web service, call it Choice View or something similar, click on Enabled, click on Authorised users only and finally click on Add Service. | ||
Add | |||
[[File:choice_res_add_ws.png|600px|thumb|center|Add web service]] | |||
Next, add two functions to the web service, by searching for the Choice functions (you may need to filter by the word choice): | Next, add two functions to the web service, by searching for the Choice functions (you may need to filter by the word choice): | ||
- mod_choice_get_choice_results | - mod_choice_get_choice_results | ||
- mod_choice_get_choices_by_courses | - mod_choice_get_choices_by_courses | ||
Add | |||
[[File:choice_res_add_functions.png|600px|thumb|center|Add functions]] | |||
8) Add your new user to the web service Authorised users list | 8) Add your new user to the web service Authorised users list | ||
| Line 76: | Line 83: | ||
Add a time restriction if needed | Add a time restriction if needed | ||
Click on Save changes and copy the resulting token | Click on Save changes and copy the resulting token | ||
Add | |||
[[File:choice_res_add_token.png|600px|thumb|center|Add token]] | |||
10) Enrol your new user, "Choice View User", as a teacher in all courses from where you want to access the choice activities. This is needed so that the web service will be able to access the choice activity details using your user's token. | 10) Enrol your new user, "Choice View User", as a teacher in all courses from where you want to access the choice activities. This is needed so that the web service will be able to access the choice activity details using your user's token. | ||
==Sample code file== | |||
==PHP script page for displaying results== | ==PHP script page for displaying results== | ||
Revision as of 16:31, 8 April 2016
Moodle choice live results
Setting up a Moodle web service to view live choice results in real time!.
Initial set up
You will need to configure the following components for this, as follows: 1) Configurations for your Moodle site 2) A separate PHP script page which calls your Moodle site via Moodle web services 3) A chartjs (or similar online graphing application) installation for displaying the choice results in visual graphs online
Moodle site configurations
1) Ensure your site is ready for web services: This is at Site administration -> Advanced features where you need to enable and save the "Enable web services" setting
2) Ensure your site is ready for web services protocols This is at Site administration -> Plugins -> Web services -> Manage protocols where you need to enable and save either of the protocols you wish to use (for this guide, we will be using the REST protocol)
3) Ensure your site settings are ready for mobile access, thus allowing choice submissions from users via mobile devices This is at Site administration -> Plugins -> Web services -> Mobile where you need to enable and save "Enable web services for mobile devices"
4) Add a new user - call them "Choice View User" or something similar.
See https://docs.moodle.org/en/Managing_accounts for further details on this operation.
5) Add a new role - call it "Choice WS Role" or something similar. This is at Site administration -> Users -> Permissions -> Define roles. On the first Adding a new role page, leave "Use role or archetype" set at "No role" and click on Continue For Context types where this role may be assigned - assign to System
In capabilities - filter for the word service - click on Allow for Web service: REST protocol, or whichever protocol you're using
Finally click on "Create this role" See https://docs.moodle.org/en/Creating_custom_roles for further details on this operation.
6) Assign your new user to the new role. This is at Site administration -> Users -> Permissions -> Assign system roles. Click on your new role Search for your new user (you may need to filter by the user name) Select your user in the list and click on Add to assign the user to the role
When you reload the Assign system roles page, your new user should be listed in the Users with role column for the role.
7) Create the web service to be called for the choice results This is at Site administration -> Plugins -> Web services -> External services Add the web service, call it Choice View or something similar, click on Enabled, click on Authorised users only and finally click on Add Service.
Next, add two functions to the web service, by searching for the Choice functions (you may need to filter by the word choice): - mod_choice_get_choice_results - mod_choice_get_choices_by_courses
8) Add your new user to the web service Authorised users list This is at Site administration -> Plugins -> Web services -> External services To add authorised users, click on the Authorised users link for your Choice View web service, this is similar to the interface where you assigned your user to the Choice View role. Search for your new user (you may need to filter by the user name) Select your user in the list and click on Add to assign the user to the Authorised users list
9) Create a web service token to authenticate the expected HTTP(S) requests This is at Site administration -> Plugins -> Web services -> Manage tokens Click on Add Search for the user you created for the Choice View In the Service dropdown, select the Choice View service you also just created Add an IP restriction if needed Add a time restriction if needed Click on Save changes and copy the resulting token
10) Enrol your new user, "Choice View User", as a teacher in all courses from where you want to access the choice activities. This is needed so that the web service will be able to access the choice activity details using your user's token.
Sample code file
PHP script page for displaying results
This page will access your Moodle site choice activities and display their results with visual graphs. Copy our sample PHP script code to wherever you want it hosted and called from. It will need http or https access to your Moodle site where the choice activities are hosted. It will also need to have some level of security if it’s going to be a publicly accessible URL as the PHP script itself contains details of a REST web service login with access to your Moodle site. We would suggest a htaccess login or similar. Edit and save the sample PHP script code to add your Moodle site URL and Choice View token values to where the code states "<yourURL>" and "<yourtoken>" respectively. Add image
The script code will also need access to an installation of chartjs, or other graphing application, in order to display the graphs, please see http://www.chartjs.org/ for more details. You will then also need to edit the script code to add the server directory location of your chartjs installation to where the code states "<yourchartjslocation>".
To reveal the results, just type in the URL of your PHP script code into your browser.
The web service will now display all course accessible choice activities in the page dropdown, displaying the one which was first created initially. If you know the choice id from the database already, you can instead add the parameter to the URL as follows: "?choiceid=X".
One final point, the sample PHP script code is set with a simple reload of the page every 5 seconds so that the displayed graph updates with the latest results regularly. This reload could be more elegantly processed if needed, using AJAX for instance.
- ADD SAMPLE CODE FILE* todo
