DashBoard-SRS: Difference between revisions
| (16 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
==1.2 Scope of the product== |
==1.2 Scope of the product== |
||
Our |
Our product is intended for a client, using OAR as manager of resources and tasks |
||
The goal is to display the traffic and work presented in the Grenoble area to be able to adjust his path. |
|||
==1.3 Definitions, acronyms and abbreviations== |
==1.3 Definitions, acronyms and abbreviations== |
||
* Cluster : It is a grouping of multiple servers to perform calculations. |
|||
* Mobile application : it's a standalone program designed to run on a mobile device like a smartphone or a tablet. |
|||
* SPA : Single Page Application |
|||
* Plugin :it's a tool consisting of a set of computer files, and lets you install new features on the sidelines of a program which it is attached. |
|||
= |
=2. General description= |
||
| ⚫ | |||
A dashboard web application for the task manager and resource OAR. |
|||
| ⚫ | |||
'''Fiche''' |
|||
* Add/Remove resources |
|||
* Submit/Delete jobs |
|||
* See information about resources and tasks |
|||
* Login/Logout |
|||
| ⚫ | |||
http://air.imag.fr/index.php/GrenobleFut%C3%A9 |
|||
Client using OAR as manager of resources and tasks |
|||
| ⚫ | |||
'''Home Page''' |
|||
*AngularJS |
|||
*SB Admin v2.0 |
|||
*Approach of a SPA |
|||
==Add resource== |
|||
http://air.imag.fr/index.php/GrenobloisFut%C3%A9 |
|||
'''Description :''' Adding a resource to the cluster if all input are good |
|||
'''Input :''' Hostname, CPU id, CORE id, MEM, besteffort |
|||
==1.5 Overview of the remainder of the document== |
|||
| ⚫ | |||
'''Output :''' Return a message to the client if the resource is created or not |
|||
==Remove resource== |
|||
=2. General description= |
|||
'''Description :''' Delete a resource to the cluster |
|||
| ⚫ | |||
The project goal is to provide an application that provides traffic and led work to Grenoble to be able to adapt its path. |
|||
'''Output :''' Return a message to the client if the resource is deleted or not |
|||
| ⚫ | |||
* Display real-time traffic on the map of the application |
|||
* Display real-time work on the map of the application |
|||
==Submit job== |
|||
| ⚫ | |||
'''Description :''' Submitting a job if the 2 inputs are good |
|||
Plugin users are motorists who travel in the Grenoble area. |
|||
'''Input :''' Resource, Program to run (Name, Type, Reservations, ...) |
|||
| ⚫ | |||
The plugin is available only on android smartphone. |
|||
'''Output :''' Return a message to the client if the job is submitted or not |
|||
==Delete job== |
|||
=3.Specific requirements, covering functional, non-functional and interface requirements= |
|||
'''Description :''' Deleting a job if the 2 inputs are good |
|||
* document external interfaces, |
|||
* describe system functionality and performance |
|||
* specify logical database requirements, |
|||
* design constraints, |
|||
* emergent system properties and quality characteristics. |
|||
'''Output :''' Return a message to the client if the job is submitted or not |
|||
==3.1 Requirement X.Y.Z (in Structured Natural Language)== |
|||
'''Function''': Display on the map the traffic and work. |
|||
==See Resources== |
|||
'''Description''': When traffic is heavy, users see it on the application and can avoid those areas. |
|||
'''Description :''' Describe all the resources |
|||
'''Output :''' Table of all resources |
|||
'''Inputs''': Button press to activate the plugin. |
|||
==See Jobs== |
|||
'''Source''': Open Data from the metromobilite. |
|||
'''Description :''' Describe all the jobs |
|||
''' |
'''Output :''' Panel of all jobs |
||
==Login== |
|||
'''Destination''': This device is designed to be used by all people who have a car. |
|||
| ⚫ | |||
'''Input :''' Username, Password |
|||
'''Action''': The plugin retrieves the free data and displays it on the map as panels or coloring. |
|||
==Logout== |
|||
'''Non functional requirements''': |
|||
'''Description :''' Disconnect the client |
|||
* Easy to use interface |
|||
* Free plugin and application |
|||
=4. Product evolution= |
=4. Product evolution= |
||
* Add more fonctions |
|||
* For the work : we could view the details of the work (which are present in the xml file) by clicking on the icon. |
|||
* Add graphics to have a better view of the cluster's use |
|||
* For the traffic: we could add an option in the GPS which can change routes depending on traffic. |
|||
* Add a zoom setting for the traffic display |
|||
* Spread to other cities |
|||
* Make an off-line mode |
|||
Latest revision as of 10:22, 5 February 2018
1. Introduction
1.1 Purpose of the requirements document
The Software Requirements Specification (SRS) is a document describing the software system of our project: DashBoard for OAR. It describes how the system is supposed to work with functional and non functional requirements.
1.2 Scope of the product
Our product is intended for a client, using OAR as manager of resources and tasks
1.3 Definitions, acronyms and abbreviations
- Cluster : It is a grouping of multiple servers to perform calculations.
- SPA : Single Page Application
2. General description
2.1 Product perspective
A dashboard web application for the task manager and resource OAR.
2.2 Product functions
- Add/Remove resources
- Submit/Delete jobs
- See information about resources and tasks
- Login/Logout
2.3 User characteristics
Client using OAR as manager of resources and tasks
2.4 General constraints
- AngularJS
- SB Admin v2.0
- Approach of a SPA
Add resource
Description : Adding a resource to the cluster if all input are good
Input : Hostname, CPU id, CORE id, MEM, besteffort
Output : Return a message to the client if the resource is created or not
Remove resource
Description : Delete a resource to the cluster
Output : Return a message to the client if the resource is deleted or not
Submit job
Description : Submitting a job if the 2 inputs are good
Input : Resource, Program to run (Name, Type, Reservations, ...)
Output : Return a message to the client if the job is submitted or not
Delete job
Description : Deleting a job if the 2 inputs are good
Output : Return a message to the client if the job is submitted or not
See Resources
Description : Describe all the resources
Output : Table of all resources
See Jobs
Description : Describe all the jobs
Output : Panel of all jobs
Login
Description : Connect the client
Input : Username, Password
Logout
Description : Disconnect the client
4. Product evolution
- Add more fonctions
- Add graphics to have a better view of the cluster's use