Box.net Repository Plugin: Difference between revisions

Latest revision as of 07:40, 5 July 2012

Functional Specification Revisions:

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

Audience:

Developer/QA tester

Status:

not implemented (Tracker Issue)

Related Documents:

Introduction

This document is about functional specification for Box.net Repository Plugin

Requirements

Administrator should be able to administrate the box.net plugin

User Interface

Administration page

API_KEY field (Textbox)
A text reminds the administrator that he needs to save the callback url on box.net (the system can show him the callback url and have a link to box.net popup)

Repository Interface page

No needed.
(The authentication has to be done by the user on the box.net site. An authentification cannot be hold more than 24 hours. It's the reason why authentication will be managed by the file picker.)

Use Cases

Please follow the use case UC001-3 Setup a repository

@@ Line 9: / Line 9: @@
 '''Related Documents:'''
-*[[Repository API| Repository API]]
+*[[Repository plugins| Repository plugins]]
 *[[QA:Use Case Number Attribution| Use Case Number Attribution]]
 <br />
@@ Line 17: / Line 17: @@
 ==Requirements==
 * Administrator should be able to administrate the box.net plugin
-* User should be able to setup an access to a Box.net account
 ==User Interface==
-=== Administration: Box.net Settings page ===
+=== Administration page ===
-*API_KEY of box.net need to be set by the administrator
+*API_KEY field (Textbox)
+*A text reminds the administrator that he needs to save the callback url on box.net (the system can show him the callback url and have a link to box.net popup)
-=== Box.net Account page ===
+=== Repository Interface page ===
-The authentication is done on the box.net side. This authentication will be done in the file picker (TBD: File Picker specification)
+No needed.<br />
+(The authentication has to be done by the user on the box.net site. An authentification cannot be hold more than 24 hours. It's the reason why authentication will be managed by the file picker.)
 ==Use Cases==
-===UC003-1 Administrate Box.net Plugin===
+Please follow the use case [[Repository_Administration_Specification|UC001-3 Setup a repository]]
-====Base scenario====
+[[Category:Repositories]]
-# Administrator goes to the Repository Settings page.
-====Pre conditions====
-:- the plugin is installed
-:- the user has Administrator role
-====Post conditions====
-:- The API_KEY of box.net can be changed.
-:- The callback parameters should be specified here.
-===UC003-2 Box.net side setting===
-====Base scenario====
-# The authentication process is done by box.net, so box.net need a callback page to tell Moodle the authentication result
-====Pre conditions====
-:- the plugin is installed in moodle side
-:- a new project has been created in box.net, see http://enabled.box.net/my-projects/
-====Post conditions====
-:- API_KEY
-:- Call-back URL can be set here.
-===UC003-3 Setup a Box.net access===
-====Base scenario====
-# User opens a file picker, try to fetch a file from box.net
-====Pre conditions====
-:- the user has a Box.net account
-====Post conditions====
-:- the user can navigate into his box.net repository in the file picker

Documentation