Moodle Repository Plugin: Difference between revisions
From MoodleDocs
mNo edit summary |
|||
| Line 19: | Line 19: | ||
<br /> | <br /> | ||
==Introduction== | ==Introduction== | ||
This document is | 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== | ==Requirements== | ||
* Moodle administrator | * 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 remote Moodle repository instance | * A peer can be linked to only one remote Moodle repository instance | ||
* Administrator needs to have "Enable SSO-IDP publish, and SSO-SP subscribe" for the peer | * Administrator needs to have "Enable SSO-IDP publish, and SSO-SP subscribe" for the peer | ||
| Line 48: | Line 48: | ||
=== File Picker === | === 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 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. | ||
(The Local repository plugin may have to be extended to cope with some new virtual files, such as a "Course" file which might only cause a backup to be created when that item is selected for download) | |||
==Use Cases== | ==Use Cases== | ||
| Line 55: | Line 57: | ||
====Base scenario==== | ====Base scenario==== | ||
#User opens a file picker | #User opens a file picker | ||
#User selects the "Moodle | #User selects the "Other Moodle" in the file picker | ||
#System displays | #System displays the file system of the other Moodle | ||
#User selects a file | #User selects a file | ||
| Line 62: | Line 64: | ||
:- the Moodle Repository plugin is been installed and activated | :- the Moodle Repository plugin is been installed and activated | ||
:- Networking has been turned on and a Moodle peer has been setup | :- Networking has been turned on and a Moodle peer has been setup | ||
:- A Moodle Repository instance has been created | :- A Moodle Repository instance has been created called "Other Moodle" (in this example) | ||
====Post conditions==== | ====Post conditions==== | ||
:- the file has been added to the html editor/parent field | :- the file has been added to the html editor/parent field | ||
Revision as of 06:52, 26 September 2008
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)
Related Documents:
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)
- A peer can be linked to only one remote Moodle repository instance
- 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
- Moodle user cannot set a remote Moodle repository at personal level
- 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 to activate or no 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.
Administration: Instances Settings
A Moodle administrator can add/delete/edit instances. For an instance he can set:
- Name
- Moodle Peer
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.
(The Local repository plugin may have to be extended to cope with some new virtual files, such as a "Course" file which might only cause a backup to be created when that item is selected for download)
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 setup
- - 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
