OneDrive repository: Difference between revisions

Latest revision as of 08:47, 30 June 2017

About the Microsoft OneDrive repository

The Microsoft OneDrive repository allows you to access your documents from Microsoft OneDrive within Moodle. As well as adding basic files, the OneDrive repository link allows you to access your OneDrive live directly from the configuration icon.

The first time you access the OneDrive repository, you will be prompted to agree to connect. Once you have agreed, you can then log in, view and use your files.

Enabling the OneDrive repository

To use the OneDrive repository, an administrator must first create a Microsoft OAuth 2 service (a new requirement in Moodle 3.3 onwards).

Go to 'OAuth 2 services' in Site administration and click the button to create a new Microsoft service.
Follow the instructions in OAuth 2 Microsoft service and obtain a client ID and secret.
Enter the client ID and secret and save changes.
Go to 'Manage repositories' in Site administration and enable the OneDrive repository.
On the OneDrive configuration page, make sure that Microsoft is selected as the OAuth 2 service then save changes.

Note: OneDrive requires that requests are delivered over SSL - this means that the OneDrive repository will not work if your site is not running over HTTPS.

Access controlled links

Students may submit files from OneDrive as 'access controlled links' in assignments. Once submitted, the student may no longer change them, but the teacher is allowed to edit them.

Teachers may display files from OneDrive as 'access controlled links'. The teacher can then continue updating the files, but students can only view them.

To enable this feature, ensure that:

A system account has been connected in OAuth 2 services in Site administration. This account will own and control access to files submitted by students and teachers. Teachers will be able to edit the files but students will not. This should be a dedicated account for this purpose.
"Supported files" is set to "Internal and External" .
"Default return type" is set to "External (only links stored in Moodle)".

The OneDrive (legacy) repository

In Moodle 3.3, the OneDrive repository used in earlier versions of Moodle has been renamed to 'OneDrive (legacy)'. The API used by this repository plugin has been deprecated by Microsoft and will stop working eventually. Users are encouraged to migrate to the new OneDrive repository right away. Another reason for migrating to the new OneDrive repository is that it works with Business accounts as well as personal.

Note: You need to enable the new OneDrive repository (as above) before migrating from the OneDrive (legacy) repository.

Repository capabilities

There is just one capability associated with this repository: View OneDrive repository.

@@ Line 1: / Line 1: @@
 {{Repositories}}
+==About the Microsoft OneDrive repository==
+The Microsoft OneDrive repository allows you to access your documents from Microsoft OneDrive within Moodle. As well as adding basic files, the OneDrive repository link allows you to access your OneDrive live directly from the configuration icon.
-The Microsoft OneDrive repository (''formerly known as Skydrive'') allows  you to access your documents from Microsoft OneDrive within Moodle.
+[[File:OD8.png|400px]]
-''Note: This is the regular, free OneDrive account, NOT the OneDrive for Business, which will not work.''
+The first time you access the OneDrive repository, you will be prompted to agree to connect. Once you have agreed, you can then log in, view and use your files.
-[[File:OD8.png]]
-As well as adding basic files, the OneDrive repository link allows you to access your OneDrive live directly from the configuration icon.
+==Enabling the OneDrive repository==
-The first time you access the OneDrive repository, you will be prompted to agree to connect:
+To use the OneDrive repository, an administrator must first create a Microsoft OAuth 2 service (a new requirement in Moodle 3.3 onwards).
-[[File:OD7.png]]
+# Go to 'OAuth 2 services' in Site administration and click the button to create a new Microsoft service.
+# Follow the instructions in [[OAuth 2 Microsoft service]] and obtain a client ID and secret.
+# Enter the client ID and secret and save changes.
+# Go to 'Manage repositories' in Site administration and enable the OneDrive repository.
+# On the OneDrive configuration page, make sure that Microsoft is selected as the OAuth 2 service then save changes.
-Once you have agreed, you can then log in,view and use your files.
+Note: OneDrive requires that requests are delivered over SSL - this means that the OneDrive repository will not work if your site is not running over HTTPS.
-==Enabling the repository==
-*Enable the OneDrive repository from 'Manage repositories' in Site administration.
-*You must register your Moodle with Microsoft in order to allow Moodle to communicate with Microsoft. Click the link presented on the OneDrive configuration screen.
-*Sign in with your Microsoft account.
-* Click ‘Add an app:
-[[File:livesdk.png]]
+==Access controlled links==
-*Fill in the form with a name for your Moodle,  accept the terms and click 'Create application'.
+Students may submit files from OneDrive as 'access controlled links' in [[Using Assignment|assignments]]. Once submitted, the student may no longer change them, but the teacher is allowed to edit them.
-[[File:onedriveappreg.png]]
+Teachers may display files from OneDrive as 'access controlled links'. The teacher can then continue updating the files, but students can only view them.
-*If desired, add an organisation logo and link to your Terms of Service:
+To enable this feature, ensure that:
-[[File:onedrivelogoterms.png]]
+# A system account has been connected in [[OAuth 2 services]] in Site administration. This account will own and control access to files submitted by students and teachers. Teachers will be able to edit the files but students will not. This should be a dedicated account for this purpose.
+# "Supported files" is set  to "Internal and External" .
+# "Default return type" is set  to "External (only links stored in Moodle)".
-*Click to save or cancel and then click the link 'API settings' .Paste in the redirect URL you are given in ''Site administration > Plugins > Repositories > Microsoft OneDrive''
+==The OneDrive (legacy) repository==
-[[File:OD4a.png]]
+In Moodle 3.3, the OneDrive repository used in earlier versions of Moodle has been renamed to 'OneDrive (legacy)'. The API used by this repository plugin has been deprecated by Microsoft and will stop working eventually. Users are encouraged to migrate to the new OneDrive repository right away. Another reason for migrating to the new OneDrive repository is that it works with Business accounts as well as personal.
-*Click the link App Setttings:
+Note: You need to enable the new OneDrive repository (as above) ''before'' migrating from the OneDrive (legacy) repository.
-[[File:OD6.png]]
+==Repository capabilities==
-*You will be shown ‘client ID’ and ‘client secret’. You need to paste these into the boxes in ''Site administration > Plugins > Repositories > Microsoft OneDrive''
-*Once saved, users will be able to access their OneDrive files from the OneDrive repository.
-==Repository capabilities==
+There is just one capability associated with this repository: [[Capabilities/repository/onedrive:view|View OneDrive repository]].
-There is just one capability associated with this repository: repository/skydrive:view: [[Capabilities/repository/skydrive:view| View Skydrive]]
+==See also==
+* [[OAuth 2 authentication]] for enabling users to log in to Moodle with their Microsoft account
+[[Category:OAuth 2]]
-[[de:Skydrive Repository]]
+[[de:OneDrive Repository]]
 [[es:Repositorio Skydrive]]

Documentation