Moodle Repository Plugin: Difference between revisions

Latest revision as of 07:42, 5 July 2012

This functional specification is STILL UNDER CONSTRUCTION."

Functional Specification Revisions:

0.1 - 27/06/2008 - Jerome Mouneyrac - Draft Version

0.2 - 25/09/2008 - Jerome Mouneyrac - Updated draft version

Audience:

Developer/QA

Status:

not implemented (MDL-15352)

Introduction

This document is a functional specification for a Moodle Repository Plugin (also referenced as Remote Moodle Repository Plugin). The Moodle Repository plugin allows users to browse a foreign Moodle site in the File Picker. The user sees all the files/data he has access to there and is able to choose them.

Requirements

Moodle administrator sets which Moodle peers will be available in the file picker (one remote Moodle repository instance = one peer)
Administrator needs to have "Enable SSO-IDP publish, and SSO-SP subscribe" for the peer
Remote Moodle Administrator needs to have "Enable SSO-IDP subscribe, and SSO-SP publish" for the "file picker" Moodle peer
Administrator can change the name and peer of a remote repository instance
Administrator can add/delete a remote repository instance
Administrator can add/delete remote repository plugin
A teacher cannot set a remote Moodle repository at the course level (except if the administrator allowed it)
Moodle user cannot set a remote Moodle repository at personal level (except if the administrator allowed it)
Only people with roles that have "Roam to a remote Moodle", moodle/site:mnetlogintoremote, will see the Remote Moodle repository into the file picker (See Moodle Networking)
Remote repository display content as the Local repository plugin does. (The remote Moodle plugin behave exactly as if the user was using the file picker in Local. Note that there is no enrolment into a course from the file picker)

User Interface

Administration: Peer Settings

In the Peer Service tab: the administrator can choose whether to activate the SSO for Repository services.

Administration: Plugin Settings

The administrator can add/delete the Remote Moodle Repository plugin. No settings are needed at the plugin level.

Administration: Instances Settings

A Moodle administrator can add/delete/edit instances. For an instance he can set:

Name
Moodle Peer

File Picker

When a user clicks on the Moodle repository, Moodle remote content is displayed. It is exactly the same content that would be displayed if the user was using the Local repository plugin in this remote Moodle.

Use Cases

UC004-1 Download a file from a remote Moodle Repository

Base scenario

User opens a file picker
User selects the "Other Moodle" in the file picker
System displays the file system of the other Moodle
User selects a file

Pre conditions

- The Moodle Repository plugin is been installed and activated

- Networking has been turned on and a Moodle peer has been set up

- A Moodle Repository instance has been created called "Other Moodle" (in this example)

Post conditions

- The file has been added to the html editor/parent field

@@ Line 8: / Line 8: @@
 '''Audience:'''
-:Developer/QA tester
+:Developer/QA
 '''Status:'''
-:not implemented ([http://tracker.moodle.org/browse/MDL-15352 Tracker Issue])
+:not implemented (MDL-15352)
-'''Related Documents:'''
-*[[Repository API| Repository API]]
-*[[QA:Use Case Number Attribution| Use Case Number Attribution]]
-*[[Moodle_Network#Setup| Moodle Networking]]
-<br />
 ==Introduction==
-This document is about functional specification for Moodle Repository Plugin. The Moodle Repository plugin allows a user to browse a foreign Moodle site in the File Picker. The user sees all the raw files he has access to there.
+This document is a functional specification for a Moodle Repository Plugin (also referenced as '''Remote Moodle Repository Plugin'''). The Moodle Repository plugin allows users to browse a foreign Moodle site in the File Picker. The user sees all the files/data he has access to there and is able to choose them.
 ==Requirements==
-* Moodle administrator set which Moodle peer will be available into the file picker (one Moodle repository instance = one peer)
+* Moodle administrator sets which Moodle peers will be available in the file picker (one remote Moodle repository instance = one peer)
-* A peer can be linked to only one Moodle repository instance
+* Administrator needs to have "Enable SSO-IDP publish, and SSO-SP subscribe" for the peer
-* A teacher cannot set a Moodle repository at the course level
+* Remote Moodle Administrator needs to have "Enable SSO-IDP subscribe, and SSO-SP publish" for the "''file picker''" Moodle peer
-* Moodle user cannot set a Moodle repository at personal level
+* Administrator can change the name and peer of a remote repository instance
-* Only people with roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam [https://docs.moodle.org/en/Moodle_Network#Setup]
+* Administrator can add/delete a remote repository instance
-* Remote repository display content as the Local repository plugin does. No auto enrolment.
+* Administrator can add/delete remote repository plugin
+* A teacher cannot set a remote Moodle repository at the course level (except if the administrator allowed it)
+* Moodle user cannot set a remote Moodle repository at personal level (except if the administrator allowed it)
+* Only people with roles that have "Roam to a remote Moodle", [[Capabilities/moodle/site:mnetlogintoremote|moodle/site:mnetlogintoremote]], will see the Remote Moodle repository into the file picker ([[MNet|See Moodle Networking]])
+* Remote repository display content as the Local repository plugin does. (The remote Moodle plugin behave exactly as if the user was using the file picker in Local. Note that there is no enrolment into a course from the file picker)
 ==User Interface==
+=== Administration: Peer Settings===
+In the Peer Service tab: the administrator can choose whether to activate the SSO for Repository services.
 === Administration: Plugin Settings===
-The administrator can add/delete the Remote Moodle Repository plugin. No settings are needed to the plugin level.
+The administrator can add/delete the Remote Moodle Repository plugin. No settings are needed at the plugin level.
 === Administration: Instances Settings ===
@@ Line 39: / Line 41: @@
 === File Picker ===
-when the user clicks on the Moodle repository, Moodle remote content is displayed. It is exactly the same content that would be displayed if the user was using the Local repository plugin in this remote Moodle.
+When a user clicks on the Moodle repository, Moodle remote content is displayed. It is exactly the same content that would be displayed if the user was using the Local repository plugin in this remote Moodle.
 ==Use Cases==
-===UC004-1 Enable a connection to a Moodle Repository===
+===UC004-1 Download a file from a remote Moodle Repository===
 ====Base scenario====
-#User goes to the "Moodle Repository" menu entry in the administration
+#User opens a file picker
-#User selects enable for some Moodle repository
+#User selects the "Other Moodle" in the file picker
-#System displays a "saved successfully" message
+#System displays the file system of the other Moodle
+#User selects a file
 ====Pre conditions====
-:- the Moodle Repository plugin is installed
+:- The Moodle Repository plugin is been installed and activated
-:- the user has Administrator role
+:- Networking has been turned on and a Moodle peer has been set up
-:- Some external Moodle have previously been added in the networking administration
+:- A Moodle Repository instance has been created called "Other Moodle" (in this example)
 ====Post conditions====
-:- any user sees the external repository in their file picker
+:- The file has been added to the html editor/parent field
+==See also==
+*[[Repository plugins| Repository plugins]]
+*[[QA:Use Case Number Attribution| Use Case Number Attribution]]
+*[[MNet]]
-===UC004-2 Unable a connection to a Moodle Repository===
+[[Category:Repositories]]
+[[Category:MNet]]

Documentation