Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Moodle Repository Plugin

From MoodleDocs
Revision as of 06:48, 26 September 2008 by jerome mouneyrac (talk | contribs)

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 about functional specification for Moodle Repository Plugin (also referenced as Remote 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.

Requirements

  • Moodle administrator set which Moodle peer will be available into 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 => 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.

Use Cases

UC004-1 Download a file from a remote Moodle Repository

Base scenario

  1. User opens a file picker
  2. User selects the "Moodle Repository" in the file picker
  3. System displays Moodle repository file system
  4. 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

Post conditions

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