Software Requirements Specification

PROJECT SECME

Software Requirements Specification

EEL5881 SOFTWARE ENGINEERING FALL 2002

Modification history:

Version	Date	Who	Comment
v0.0	8/15/00	G. H. Walton	Template
v1.0	9/28/02	Majid Khan	First version of requirements
v1.1	9/30/02	Carthik Sharma	Modifications as per client feedback

Team Name: TEAM SECME

Team Members:

Carthik Anand Sharma appcash@yahoo.com www.oocities.org/secmep/carthik.htm
Juan Carlos Vivanco juan@cs.ucf.edu www.oocities.org/secmep/juan.htm
Majid Ali Khan majid_kk@hotmail.com www.oocities.org/secmep/majid.htm
Santhosh Kumar Grandai santhu79@hotmail.com www.oocities.org/secmep/santhosh.htm

Contents of this Document

Introduction

Software to be Produced
Reference Documents
Applicable Standards

Definition, Acronyms, and Abbreviations

Product Overview

Assumptions
Stakeholders
Event Table
Use Case Diagram
Use Case Descriptions

Specific Requirements

Functional Requirements
Interface Requirements
Physical Environment Requirements
Users and Human Factors Requirements
Documentation Requirements
Data Requirements
Resource Requirements
Security Requirements
Quality Assurance Requirements

Supporting Material

SECTION 1: Introduction

Software to be Produced:

Minority Engineering and Computer Science Program (MECSP) provides support services to prepare, recruit and retain ethnic minority engineering students. In conjunction with a variety of governmental agencies, industries and school systems; the MECSP office develops and implements pre-college programs to assist ethnic minority elementary, middle and high school students to become academically prepared and aware of career opportunities in engineering, science and other math based fields.

The purpose of this project is to provide online information to the participating schools about upcoming Saturday workshops, annual competition and other events. It will provide a facility for the schools to register online for the annual competition event and for the workshops. It will also provide a facility for users in the Minority Engineering Program to administer information for these upcoming events and to view information provided by these schools.

Reference Documents:

Applicable Standards:

Definitions, Acronyms, and Abbreviations:

MECSP: Minority Engineering and Computer Science Program
SECME: Southeastern Consortium for Minorities in Engineering

SECTION 2: Product Overview

Assumptions:

Client will have Internet Explorer 5 or higher
Server should be able to host a relational database like Microsoft Access.
Server should be able to host Java based components like JSP, Servlets and Java Beans with jdk 1.3 or higher
Server should be able to run Tomcat 4.0 or higher as a web server for serving dynamic JSP pages.

Stakeholders:

MECSP Organizer:
MECSP Organizer is an end user who will use the system on behalf of MECSP program. He/She will interact with the system to get information about registered schools and their students.
School Coordinator:
School coordinator is an end user who will use the system on behalf of a school. He/She will provide registration information online and will be able to modify it later.

Event Table:

Event Name	External Stimuli	External Responses	Internal data and state
Sign On	School coordinator OR MECSP user wants to log into the system	- In case of valid user, the school coordinator/MECSP user will successfully log into the system - In case of invalid input, he/she will be redirected to log on screen.	- valid log in credentials
Register for annual competition/workshop	School coordinator wants to register for an annual competition/workshop	- School coordinator registers for the competition/workshop successfully - In case he/she is not able to register due to some of the applicable limitations, he/she should be able to convey a message to MECSP organizer via email.	- store competition/workshop registration information
Modify competition/workshop registration information	School coordinator wants to modify given competition/workshop registration information	- School coordinator successfully modifies the competition/workshop registration information and MECSP organizer is informed about it via email. - In case deadline has passsed, he/she will not be able to modify competition/workshop registration information	- Store modified competition registration information
View registration information	School coordinator would like to view the registration information	- If entered, the school coordinator should be able to view information.	- Display school specific registration information to the user.
Send Inquiry to MECSP user	School coordinator wants to send questions/inquiry to MECSP user	- School coordinator will be informed on whether an email has been sent to the MECSP user or not.	- requires MECSP email address be configured properly to send an email
Define competition/workshop	MECSP user wants to define upcoming competition or workshop	- MECSP user will be displayed success message if a competition/workshop has been successfully entered. He/She will be provided with the option to notify school coordinators here	- Store competition/workshop inofrmation
View information about registered schools	MECSP user wants to view registered school information about upcoming event	- List of registered schools, and their related registered information will be displayed.	- Display registration information
View summary of information	MECSP user wants to view different summaries of data	- Summaries of data will be presented in require format - In case data is not available, proper error message will be displayed	- Availability of relevant data for summary infromation
Notify school coordinators on upcoming events	MECSP user wants to notify school coordinators about upcoming events	- MECSP user will be notified if all school coordinator are sent an email successfuly . In case of error sending a message, proper error message will be displayed.	- Email addresses of school coordinators are properly configured.

Use Case Diagram:

Use Case Descriptions:

NOTE: A brief description of use cases is provided. Each of this use case will be elaborated in Analysis Phase and more elaborate steps and exception handling will be provided then.

Sign On: Describes the way users will sign on to the system
Register for annual competition: Describes the way school coordinators will register for annual competition
Register for workshop: Describes the way school coordinator will register for workshop
View competition registration information: Describes how the school coordinator will be able to view competition registration information
View workshop registration information: Describes how the school coordinator will be able to view workshop registration information
Modify competition registration information: Describes how the school coordinator will modify competition registration information.
Modify workshop registration information: Describes how the school coordinator will modify workshop registration information.
Send inquiry or message to MECSP user: Describes how the user will send email messages or inquiries to MECSP user.
Define annual competition: Describes how the MECSP user will define annual competition.
Define workshop: Describes how the MECSP user will define workshop.
view registered school information: Describes how the MECSP user will view registered information.
View whole competition summary: Describes how the MECSP user will view information about whole competition.
View students with particular Math level: Describes how the MECSP user will view students with a specific Math level
View competition summary by school type: Describes how the MECSP user will view competition information by school type.
Notify school coordinators about events: Describes how MECSP user will notify school coordinators about upcoming events.

SECTION 3: Specific Requirements

3.1 Functional Requirements:

No: 1

Statement: Ability to support multiple school participation in the registration process.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 2

Statement: Ability to display general guidelines for the schools.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 3

Statement: Ability for users to connect to the SECME national website.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 4

Statement: Ability to define two school coordinators for each of the participating schools

Each school coordinator will have an id and password, with each school having a single user id, and password.
Each school coordinator will have an email address that will be used to notify him/her about upcoming events like annual competition and workshops.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 5

Statement: Ability to define upcoming workshops

Each workshop will have a date and time of conduction.
Each workshop will have details like the workshop subject, description and rules.
Each workshop will have a registration deadline (in terms of date).
Each workshop will have a limit on maximum number of participants

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 6

Statement: Ability to define upcoming annual competition

Competition will have a date of conduction.
Competition will have a registration deadline (in terms of date)

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 7

Statement: Ability to define multiple events for the competition

Each event will have a date, time and location of conduction.
Each event will have details like an event description and rules.
Each event will have a limit of the maximum number of participants.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 8

Statement: Ability for school coordinators to post messages or queries from the website.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 9

Statement: Ability to define MECSP organizer

The organizer will have an email address
All questions posted by school coordinator will be sent to this email address

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 10

Statement: Ability to differentiate between school user and MECSP user.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 11

Statement: Ability to store following information with respect to school, coordinators and students:

School: name, type, phone, fax
Coordinator: name, email address
Student: name, grade level, math level.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 12

Statement: School users (i.e. school coordinators) can:

Register for the annual competition and workshop online.
View/modify information about participants of their schools alone.
Review and modify the participant’s information before completing the registration process.
Modify participant’s information after it has been posted for registration process but before the registration deadline.
Receive confirmation of submission/modification of data.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 13

Statement: Ability to notify the MECSP organizer by email whenever school registration information is added or modified, i.e., whenever the school coordinator submits/modifies the school registration form.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 14

Statement: MECSP users will be able to:

Define the competition and workshops.
Define school coordinators and their information.
View the details of the school coordinators, for the different schools.
Notify via email all participants about the upcoming workshop or annual competition. All email will have a carbon copy sent to MECSP organizer as well.
View information about all the participating schools and their students in relation to the competition or a workshop.
View summary of whole annual competition with school, the events and the students within each event in a tabular format.
View summary of competition filtered by school type providing information on school, events and the students within each event in a tabular format.
View registration information, with the ability to view all submissions/updates received from a specified date, till a specified date.
View student information with respect to Math level of the students.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 15

Statement: Both users should be able to sign in/out of the system using their own id and password.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

No: 16

Statement: An enhanced user interface is required which will provide easy navigation and better look and feel.

Source: client

Dependency: None

Conflicts: None

Supporting Materials: None

Evaluation Method: via testing procedure

Revision History: None

3.2 Interface Requirements:

This system will not interface with any other existing system. Therefore there are no particular interface requirements.

3.3Physical Environment Requirements:

Online system with software running on a server in some safe location at UCF.

3.4 Users and Human Factors Requirements:

The system will be used by two special users (MECSP user and school coordinator user). Both of them are assumed to have sufficient skills to use an online system. No particular training is required for this purpose.

3.5 Documentation Requirements:

No particular requirement for end user documentation

3.6 Data Requirements:

Previous registration information will be retained for historical reasons.

3.7 Resource Requirements:

No particular funding is required. We shall use open source implementations that are available for free. We shall use general computer labs for development.

3.8 Security Requirements:

Both types of users (MECSP user and school coordinator) have respective security requirements. School coordinator will be able to modify only his school's information while MECSP user will be able to view and define upcoming event information.

3.9 Quality Assurance Requirements:

The system should be reliable and robust. It should be able to handle exceptions in a graceful manner.

SECTION 4: Supporting Material

Template created by G. Walton (GWalton@mail.ucf.edu) on March 28, 1999 and last modified on August 15, 2000.

This page last modified by Majid Khan (majid_kk@hotmail.com ) on September 30, 2002