... | ... | @@ -6,122 +6,112 @@ Moodle 2.6+ instructions |
|
|
1. Install [Moodle **2.6 or higher**](http://download.moodle.org/)
|
|
|
|
|
|
|
|
|
2. **Note: please skip step 2 if you have RosarioSIS version 2.7 or higher.**
|
|
|
Download and install the [Web Service Get Contexts local plugin](https://moodle.org/plugins/view.php?plugin=local_getcontexts)
|
|
|
2. Create the [Parent role](https://docs.moodle.org/26/en/Parent_role#Creating_a_new_role) and note down the Parent role ID (the ending part of the URL is _&roleid=9_ where the ID here is 9, when you are on the page _Viewing the definition of role 'Parent'_)
|
|
|
|
|
|
2.1 Extract the _getcontexts/_ folder into Moodle's _local/_ folder
|
|
|
|
|
|
2.2 Reload Moodle and click _Upgrade Moodle database now_ in the _Plugins check_ screen
|
|
|
3. Follow the "Allow an external system to control Moodle" steps (Administration > Site administration > Plugins > Web services > Overview)
|
|
|
|
|
|
3.1 Enable web services: check the box and save (go back to Overview and check the status is _Yes_)
|
|
|
|
|
|
3. Create the [Parent role](https://docs.moodle.org/26/en/Parent_role#Creating_a_new_role) and note down the Parent role ID (the ending part of the URL is _&roleid=9_ where the ID here is 9, when you are on the page _Viewing the definition of role 'Parent'_)
|
|
|
3.2 Enable protocols: click Enable on the line _XML-RPC protocol_ and save (go back to Overview and check the status is _xmlrpc_)
|
|
|
|
|
|
3.3 Create a specific user:
|
|
|
|
|
|
4. Follow the "Allow an external system to control Moodle" steps (Administration > Site administration > Plugins > Web services > Overview)
|
|
|
— 3.3.1 Enter a Username
|
|
|
|
|
|
4.1 Enable web services: check the box and save (go back to Overview and check the status is _Yes_)
|
|
|
— 3.3.2 Choose an authentication method: _Web services authentication_
|
|
|
|
|
|
4.2 Enable protocols: click Enable on the line _XML-RPC protocol_ and save (go back to Overview and check the status is _xmlrpc_)
|
|
|
— 3.3.3 Enter a Password if required / possible
|
|
|
|
|
|
4.3 Create a specific user:
|
|
|
— 3.3.4 Enter a First name, Surname & Email address
|
|
|
|
|
|
— 4.3.1 Enter a Username
|
|
|
— 3.3.5 Click _Create user_
|
|
|
|
|
|
— 4.3.2 Choose an authentication method: _Web services authentication_
|
|
|
3.4 Create a Web Service role (Administration > Site administration > Users > Permissions > Define roles)
|
|
|
|
|
|
— 4.3.3 Enter a Password if required / possible
|
|
|
— 3.4.1 Click _Add a new role_
|
|
|
|
|
|
— 4.3.4 Enter a First name, Surname & Email address
|
|
|
— 3.4.2 Use role or archetype: _No role_, click Continue
|
|
|
|
|
|
— 4.3.5 Click _Create user_
|
|
|
— 3.4.3 Enter the role name
|
|
|
|
|
|
4.4 Create a Web Service role (Administration > Site administration > Users > Permissions > Define roles)
|
|
|
— 3.4.4 Context types where this role may be assigned: check _System_
|
|
|
|
|
|
— 4.4.1 Click _Add a new role_
|
|
|
— 3.4.5 Select _Manager_, _Teacher_, _Student_ & _Parent_ for Allow role assignments
|
|
|
|
|
|
— 4.4.2 Use role or archetype: _No role_, click Continue
|
|
|
— 3.4.6 Check _Allow_ for the following capabilities (you can search for them via ``CTRL + F``): see list at the bottom of page
|
|
|
|
|
|
— 4.4.3 Enter the role name
|
|
|
— 3.4.7 Click _Create this role_
|
|
|
|
|
|
— 4.4.4 Context types where this role may be assigned: check _System_
|
|
|
3.5 Assign Web Service role (Administration > Site administration > Users > Permissions > Assign system roles)
|
|
|
|
|
|
— 4.4.5 Select _Manager_, _Teacher_, _Student_ & _Parent_ for Allow role assignments
|
|
|
— 3.5.1 Click the Web Service role
|
|
|
|
|
|
— 4.4.6 Check _Allow_ for the following capabilities (you can search for them via ``CTRL + F``): see list at the bottom of page
|
|
|
— 3.5.2 Select the Web Service user in Potential users
|
|
|
|
|
|
— 4.4.7 Click _Create this role_
|
|
|
— 3.5.3 Click _Add_
|
|
|
|
|
|
4.5 Assign Web Service role (Administration > Site administration > Users > Permissions > Assign system roles)
|
|
|
3.6 Select a service (Administration > Site administration > Plugins > Web services > Overview)
|
|
|
|
|
|
— 4.5.1 Click the Web Service role
|
|
|
— 3.6.1 Click _Add_ in External services
|
|
|
|
|
|
— 4.5.2 Select the Web Service user in Potential users
|
|
|
— 3.6.2 Name the External service
|
|
|
|
|
|
— 4.5.3 Click _Add_
|
|
|
— 3.6.3 Check _Enabled_ and _Authorised users only_
|
|
|
|
|
|
4.6 Select a service (Administration > Site administration > Plugins > Web services > Overview)
|
|
|
— 3.6.4 Click _Add service_ (go back to Overview)
|
|
|
|
|
|
— 4.6.1 Click _Add_ in External services
|
|
|
3.7 Add functions
|
|
|
|
|
|
— 4.6.2 Name the External service
|
|
|
— 3.7.1 Click _Functions_ link of the external service and then Add funtions
|
|
|
|
|
|
— 4.6.3 Check _Enabled_ and _Authorised users only_
|
|
|
— 3.7.2 Select all the functions except the deprecated ones
|
|
|
|
|
|
— 4.6.4 Click _Add service_ (go back to Overview)
|
|
|
— 3.7.3 Click _Add functions_ (go back to Overview)
|
|
|
|
|
|
4.7 Add functions
|
|
|
3.8 Select a specific user
|
|
|
|
|
|
— 4.7.1 Click _Functions_ link of the external service and then Add funtions
|
|
|
— 3.8.1 Click _Authorised users_ link of the external service
|
|
|
|
|
|
— 4.7.2 Select all the functions except the deprecated ones
|
|
|
— 3.8.2 Select the Web Service user in _Not authorised users_
|
|
|
|
|
|
— 4.7.3 Click _Add functions_ (go back to Overview)
|
|
|
— 3.8.3 Click _Add_ (go back to Overview)
|
|
|
|
|
|
4.8 Select a specific user
|
|
|
3.9 Create a token (Administration > Site administration > Plugins > Web services > Manage tokens)
|
|
|
|
|
|
— 4.8.1 Click _Authorised users_ link of the external service
|
|
|
— 3.9.1 Select the Web service user and the Web service created earlier
|
|
|
|
|
|
— 4.8.2 Select the Web Service user in _Not authorised users_
|
|
|
— 3.9.2 Click _Save changes_
|
|
|
|
|
|
— 4.8.3 Click _Add_ (go back to Overview)
|
|
|
— 3.9.3 Copy the token (ie.: ``639a6beb1992512e44bc69daffd078e3``)
|
|
|
|
|
|
4.9 Create a token (Administration > Site administration > Plugins > Web services > Manage tokens)
|
|
|
|
|
|
— 4.9.1 Select the Web service user and the Web service created earlier
|
|
|
|
|
|
— 4.9.2 Click _Save changes_
|
|
|
4. Configure RosarioSIS
|
|
|
|
|
|
— 4.9.3 Copy the token (ie.: ``639a6beb1992512e44bc69daffd078e3``)
|
|
|
4.1 Login to RosarioSIS and go to Students > Student Fields > General Info
|
|
|
|
|
|
4.2 Click the *+* icon, enter _email_ as the Field Name, select _Text_ for Data Type and click _Save_
|
|
|
|
|
|
4.3 Note down the RosarioSIS Student email field ID. When you point on the email field link in the Student Fields list (the ending part of the URL is ``&id=2`` where the ID here is 2).
|
|
|
|
|
|
5. Configure RosarioSIS
|
|
|
4.4 Go to School Setup > School Configuration
|
|
|
|
|
|
5.1 **Note: skip this step if you have RosarioSIS version 2.7 or higher** Set ``MOODLE_INTEGRATOR`` to true in the _config.inc.php_ file
|
|
|
— 4.4.1 **Note: skip to step 5.6 if you have RosarioSIS version 2.6 or lower** Click _Plugins_
|
|
|
|
|
|
5.2 Login to RosarioSIS and go to Students > Student Fields > General Info
|
|
|
— 4.4.2 Click _Activate_ on the Moodle plugin line
|
|
|
|
|
|
5.3 Click the *+* icon, enter _email_ as the Field Name, select _Text_ for Data Type and click _Save_
|
|
|
— 4.4.3 Click _Configure_ on the Moodle plugin line
|
|
|
|
|
|
5.4 Note down the RosarioSIS Student email field ID. When you point on the email field link in the Student Fields list (the ending part of the URL is ``&id=2`` where the ID here is 2).
|
|
|
4.5 Enter the Moodle URL (internet address you use to access Moodle)
|
|
|
|
|
|
5.5 Go to School Setup > School Configuration
|
|
|
4.6 Enter the Moodle Token (cf. step 3.9.3)
|
|
|
|
|
|
— 5.5.1 **Note: skip to step 5.6 if you have RosarioSIS version 2.6 or lower** Click _Plugins_
|
|
|
4.7 Enter the RosarioSIS Student email field ID (cf. step 4.3)
|
|
|
|
|
|
— 5.5.2 Click _Activate_ on the Moodle plugin line
|
|
|
4.8 Enter the Moodle Parent role ID (cf. step 2)
|
|
|
|
|
|
— 5.5.3 Click _Configure_ on the Moodle plugin line
|
|
|
|
|
|
5.6 Enter the Moodle URL (internet address you use to access Moodle)
|
|
|
|
|
|
5.7 Enter the Moodle Token (cf. step 4.9.3)
|
|
|
|
|
|
5.8 Enter the RosarioSIS Student email field ID (cf. step 5.4)
|
|
|
|
|
|
5.9 Enter the Moodle Parent role ID (cf. step 3)
|
|
|
|
|
|
5.10 Click _Save_
|
|
|
4.9 Click _Save_
|
|
|
|
|
|
|
|
|
Notes
|
... | ... | |