Development:Repository Administration Specification: Difference between revisions
No edit summary |
|||
Line 16: | Line 16: | ||
==Introduction== | ==Introduction== | ||
This document is about functional specification for Repository Administration | This document is about functional specification for Repository Administration | ||
Note: part of this document about "settings a repository" (UC001-3) is generic to all plugins. Please see the wiki page for specific specification on this part. | |||
==Requirements== | ==Requirements== |
Revision as of 09:08, 27 June 2008
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:
- Repository API
- Repository Plugins
- Repository Interface for Moodle/Course/User
- Use Case Number Attribution
Introduction
This document is about functional specification for Repository Administration Note: part of this document about "settings a repository" (UC001-3) is generic to all plugins. Please see the wiki page for specific specification on this part.
Requirements
- be able to enable/disable a repository
- be able to order a repository (it will change the way repositories are displayed in the file picker)
- be able to setup a repository
User Interface
We want something similar to Admin > Modules > Filters > Manage Filters (Admin > Modules > Repositories > Manage Repositories). Below an example:
- The list is automatically generated. The list displays all repository plugin located in the moodle/repository/plugins folder
- Enable/Disable operation is available for all plugin
- Order operation is available for all plugin
- Settings operation is not mandatory. This operation is available when the plugin package come with a settings.php file. All these plugin settings page should also be available from some Administration menu entries: Admin > Modules > Repositories > "Repository Name"
Settings operation
When user selects Settings operation for a repository, the system display a new page with a new form.
Settings options can be different for each module:
- allow the user to "Remember password"
- URL to the repository
- Rename the repository (affect only the name displayed in Moodle)
Use Cases
UC001-1 Enable/Disable a repository
Base scenario
- User goes to the Repository Administration page
- User select Enable/Disable repository operation
- System displays the repository as Enable/Disable
Pre conditions
- - the user has Admin permission in Moodle
- - the repository is Disable/Enable
Post conditions
- - the repository is available/not available
UC001-2 Order a repository
Base scenario
- User goes to the Repository Administration page
- User select Move operation for a repository
- System displays the new ordered repository list
Pre conditions
- - the user has Admin permission in Moodle
- - their is at least two repository in the list
Post conditions
- - the repository has been moved one step up or down in the file picker repository list.
UC001-3 Setup a repository
Base scenario
- User goes to the Repository Administration page
- User selects Settings operation for a repository
- System displays Settings page
- User fills the settings form
- User selects save operation
- System displays a save successfull message
Pre conditions
- - the user has Admin permission in Moodle
- - the repository has been installed and has settings available