Note:

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

Mahara Repository Plugin: Difference between revisions

From MoodleDocs
No edit summary
Line 59: Line 59:
====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
== Technical Specification ==
=== Mnet communication ===
=== Mahara mnet function ===


==See also==
==See also==

Revision as of 03:45, 6 April 2009

This functional specification is STILL UNDER CONSTRUCTION."


Functional Specification Revisions:

0.1 - 06/04/2009 - Jerome Mouneyrac - Draft Version

Audience:

Developer/QA

Status:

not implemented (MDL-16909)

Introduction

This document is a functional specification for a Mahara Repository Plugin. The Mahara Repository plugin allows users to browse a Mahara portoflio in the File Picker.

Requirements

  • Moodle administrator sets which Mahara peers will be available in the file picker (one Mahara instance = one peer)
  • Mahara Administrator needs to have "Enable SSO-IDP publish, and SSO-SP subscribe"
  • Moodle Administrator needs to have "Enable SSO-IDP subscribe, and SSO-SP publish"
  • Administrator can change the name and peer of a remote repository instance
  • Administrator can add/delete a Mahara repository instance
  • Administrator can add/delete Mahara repository plugin
  • A teacher cannot set a Mahara repository at the course level (except if the administrator allowed it)
  • Moodle user cannot set a Mahara 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 Mahara repository into the file picker (See Moodle Networking)
  • Mahara repository display content as the Mahara user would see it in Mahara "My Files" page.

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 Mahara 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
  • Mahara Peer

File Picker

When a user clicks on the Mahara repository, Mahara portfolio tree is displayed. It is exactly the same content that would be displayed if the user was displaying "My files" in Mahara.

Use Cases

Download a file from a Mahara repository

Base scenario

  1. User opens a file picker
  2. User selects a Mahara repository in the file picker
  3. System displays the file system of the Mahara site
  4. User selects a file

Pre conditions

- The Mahara Repository plugin is been installed and activated
- Networking has been turned on and a Mahara peer has been set up
- A Mahara Repository instance has been created called "Mahara" (in this example)

Post conditions

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

Technical Specification

Mnet communication

Mahara mnet function

See also