DashBoard-SRS: Difference between revisions

From air
Jump to navigation Jump to search
 
(9 intermediate revisions by 2 users not shown)
Line 9: Line 9:
==1.3 Definitions, acronyms and abbreviations==
==1.3 Definitions, acronyms and abbreviations==
* Cluster : It is a grouping of multiple servers to perform calculations.
* Cluster : It is a grouping of multiple servers to perform calculations.
* SPA : Single Page Application


=2. General description=
=2. General description=
Line 24: Line 25:


==2.4 General constraints==
==2.4 General constraints==
*AngularJS
The plugin is available only on android smartphone.
*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
=3.Specific requirements, covering functional, non-functional and interface requirements=
* 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 resource is created or not
==3.1 Requirement X.Y.Z (in Structured Natural Language)==
'''Function''': Display on the map the traffic and work.


==Remove resource==
'''Description''': When traffic is heavy, users see it on the application and can avoid those areas.
'''Description :''' Delete a resource to the cluster


'''Inputs''': Button press to activate the plugin.
'''Output :''' Return a message to the client if the resource is deleted or not


==Submit job==
'''Source''': Open Data from the metromobilite.
'''Description :''' Submitting a job if the 2 inputs are good


'''Input :''' Resource, Program to run (Name, Type, Reservations, ...)
'''Outputs''': Touchscreen


'''Destination''': This device is designed to be used by all people who have a car.
'''Output :''' Return a message to the client if the job is submitted or not


==Delete job==
'''Action''': The plugin retrieves the free data and displays it on the map as panels or coloring.
'''Description :''' Deleting a job if the 2 inputs are good


'''Output :''' Return a message to the client if the job is submitted or not
'''Non functional requirements''':

* Easy to use interface
==See Resources==
* Free plugin and application
'''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=
=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