Development:Moodle Repository Plugin: Difference between revisions
m (→Requirements: MNet link) |
|||
(43 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
'''This | '''This functional specification is STILL UNDER CONSTRUCTION."''' | ||
Line 5: | Line 5: | ||
'''Functional Specification Revisions:''' | '''Functional Specification Revisions:''' | ||
:0.1 - 27/06/2008 - Jerome Mouneyrac - Draft Version | :0.1 - 27/06/2008 - Jerome Mouneyrac - Draft Version | ||
:0.2 - 25/09/2008 - Jerome Mouneyrac - Updated draft version | |||
'''Audience:''' | '''Audience:''' | ||
:Developer/QA | :Developer/QA | ||
'''Status:''' | '''Status:''' | ||
:not implemented ( | :not implemented (MDL-15352) | ||
==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) | ||
* | * 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 | ||
* | * 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", [[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== | ==User Interface== | ||
=== Plugin === | === Administration: Peer Settings=== | ||
The administrator can add the Remote Moodle Repository plugin. No settings are needed | 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 | * Name | ||
* Moodle Peer | * 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== | ==Use Cases== | ||
===UC004-1 | ===UC004-1 Download a file from a remote Moodle Repository=== | ||
====Base scenario==== | ====Base scenario==== | ||
#User | #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==== | ====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==== | ====Post conditions==== | ||
:- | :- The file has been added to the html editor/parent field | ||
==See also== | |||
*[[Development:Repository API| Repository API]] | |||
*[[QA:Use Case Number Attribution| Use Case Number Attribution]] | |||
*[[MNet]] | |||
[[Category:Repositories]] | |||
[[Category:MNet]] |
Latest revision as of 10:24, 27 March 2010
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