Repository Interface for Moodle/Course/User

Jump to: navigation, search

Functional Specification Revisions:

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

Audience:

Moodle Administrator/Developer/QA tester

Status:

not implemented (Tracker Issue)

Related Documents:


Introduction

This document is about functional specification of Repository Interface. Repository Interface is the place where a user sets up his repository account parameters in order to access to a specific instance of the repository.
This document is a generic repository interface specification for all plugin. For specific plugin repository interface specification, please see the Repository Plugins wiki page.

Requirements

if the repository plugin allow it:

  • a user should be able setup his repository accounts in his profil (new repository tab)
  • administrator should be able to setup a repository account in the administration. It is used if the administrator whish to give access to a specific repository account at any users in Moodle.
  • teacher should also be able to setup repository accounts for a specific course.

User Interface

Access to a repository interface - User level

For confidentiality reason, a administrator is not allowed to setup a repository account at the user level. A tab named "Repositories" is displayed on the user profil page.

Access to a repository interface - Course level

For confidentiality reason, a administrator is not allowed to setup a repository account at the course level. In the course admin block, system display a new menu entry named "Repositories".

Access to a repository interface - Moodle level

In the repository menu (same level than "Manage Repositories"), system displays "Moodle Repositories Account"

Repository Interface

The window displays a list of repository that the user/teacher/administrator can access to. Each repository has its own setup interface. See repository plugin specification (TBD). Most of them should have:

  • "Remember password" checkbox (display only if the option has been allowed be the administrator in "Manage Repositories". In this case, it should be checked by default)
  • Login/Password (if the checkbox is checked.)
  • A warning message if there is nothing to setup for this repository

Use Cases

UC002-1 User sets up a repository account

Base scenario

  1. User goes on his own repository interface page
  2. User select a repository in the list
  3. System displays account settings form for this repository
  4. User fills the form
  5. User selects Save operation
  6. System displays "success" message

Pre conditions

  • the repository plugin is set as Enable on the Repository administration page
  • the repository can be set by User (TBD: how the system detects this)

Post conditions

  • the user can connect to his repository

UC002-2 Teacher sets up a repository account for a course

Base scenario

  1. User goes on the course repository interface page
  2. Same steps than UC002-1

Pre conditions

  • same than UC002-1

Post conditions

  1. any users from this course can see the repository in their file picker (only when they are doing an action in this same course)

UC002-3 Admin sets up a repository account for Moodle

Base scenario

  1. User goes on the Moodle repository interface page
  2. Same steps than UC002-1

Pre conditions

  • same than UC002-1

Post Condition conditions

  1. any users can see the repository in their file picker