software design specification for counselling system

18
Saurabh Singh - Copyright Page i CCS Saurabh Singh 09BCE049 Supervisor: Akila Victor Software Design Specification Version 1.0

Upload: saurabh-singh

Post on 27-Oct-2014

309 views

Category:

Documents


7 download

DESCRIPTION

SDS for Counselling System, VIT University

TRANSCRIPT

Saurabh Singh - Copyright Page i CCS

Saurabh Singh

09BCE049

Supervisor: Akila Victor

Software Design

Specification

Version 1.0

Saurabh Singh - Copyright Page ii CCS

Table of Contents

Table of Contents .......................................................................................................................... ii

1. Introduction ..............................................................................................................................1 1.1 Purpose ........................................................................................................................................ 1 1.2 System Overview ......................................................................................................................... 1 1.3 Design Map ................................................................................................................................. 2 1.4 Definitions and Acronyms ........................................................................................................... 2

2. Design Considerations .............................................................................................................3 2.1 Assumptions ................................................................................................................................ 3 2.2 Constraints ................................................................................................................................... 4 2.3 System Environment ................................................................................................................... 5 2.4 Risks and Volatile Areas ............................................................................................................. 5

3. Architecture ..............................................................................................................................6 3.1 Overview ..................................................................................................................................... 6 3.2 Subsystem, Component, or Module 1 …N .................................................................................. 6 3.3 Strategy 1…N .............................................................................................................................. 7

4. Database Schema .....................................................................................................................7 4.1 Tables, Fields and Relationships ................................................................................................. 7

4.1.1 Databases................................................................................................................................. 8 4.1.2 New Tables .............................................................................................................................. 8 4.1.3 New Fields(s) .......................................................................................................................... 9 4.1.4 Fields Change(s) ...................................................................................................................... 9 4.1.5 All Other Changes ................................................................................................................. 10

4.2 Data Migration ........................................................................................................................... 51

5. High Level Design ..................................................................................................................62 5.1 View / Model Element 1…N………………………………………………………………...14

6. User Interface Design ..........................................................................................................126 6.1 Application Controls ................................................................ Error! Bookmark not defined.7 6.2 Screen 1… N ............................................................................ Error! Bookmark not defined.8

Saurabh Singh - Copyright Page 1 CCS

1. Introduction

1.1 Purpose

This design will detail the implementation of the requirements as defined in the Software Requirements

Specification.It describes the design constraints that are to be considered when the system is to be designed,

and other factors necessary to provide a complete and comprehensive description of the design for the

software. The SDS captures the complete software requirements for the system, or a portion of the system.

1.2 System Overview

Which courses are good? Which are the best colleges for that course? How to get into those colleges? What is the exam pattern? Students have a lot of confusion about the courses and what exams do they need to appear for getting into that course. Competitive Counselling System (CCS) is a web based application which guides the students and helps them overcome these situations. CCS is designed to aid students and inform them about various streams and different courses. The Competitive Counseling System (CCS) shall be used by students for getting information about various courses, the exam pattern and dates. CCS can also be used by students to clear their queries by posting questions which can be answered by fellow students and counseling experts. It shall also be used by authorized administrators who will be able to view the queries and student profile and also edit the content of the website. The purpose of this document is to analyze and elaborate on the high-level needs and features of the CCS. It focuses on the capabilities and facilities of the CCS. The details of what all are the needs of the CCS and if it fulfills these needs.

1.3 Design Map

This document shows the ER Diagram, UseCase and Class diagrams for the system.

1.4 Definitions and Acronyms

CCS - Competitive Counselling System

HTML - Hyper Text Mark-up Language

CSS - Cascading Style Sheets

PHP - Hypertext Pre-processor

2. Design Considerations

All design considerations were handled in SRS.

Saurabh Singh - Copyright Page 2 CCS

2.1 Assumptions

The users have sufficient knowledge of computers.

The user’s computer should have Internet connection and Internet server capabilities.

The users know the English language, as the user interface will be provided in English.

The CCS can access the database.

2.2 Constraints

We only have about two months to finish all documentation, software creation and enhancements. We have a lot of ideas but cannot implement them due to time constraint. One of the major ones is to move the application to be completely browser based.

2.3 System Environment

The system should have internet connectivity in order to access the CCS. The system should have a web

browser which should support Javascript. The system should have a minimum RAM of 256 MB and a CPU

clock frequency greater than 800MHz. The screen resolution is expected to be 1024 by 768 pixels for

optimum view .The CCS is developed on PHP. The database used to store the data will be SQL Server.

2.4 Risks and Volatile Areas

None have been identified.

2.5 Deployment Diagram

The students may create an account or continue as guests. The system contains the data for each of the streams and their examination and the best colleges. The students can view the results and can also subscribe to our mail services. The students may also post queries. Queries may be answered by administrators or other users. Administrators moderate the query page. CCS provides the login facility to the administrators. After authentication the administrator can manage the content of the system. Administrator can also view the traffic statistics and can view the accounts of each of the students. The administrator can also mail the exam details and other notifications to the subscribed students. The product to be developed has interactions with the users: Students or Visitors, Administrator who manages the CCS. The complete overview of the system is as shown in the deployment diagram below:

Saurabh Singh - Copyright Page 3 CCS

De Fig 2.1 Deployment diagram

3. Architecture

3.1 Overview

Competitive councelling system supports various user functions like

Register an account.

Browse the college database.

Browse the question bank database

Mail subscription for exam alerts

Query posting

Query Response

Other than these functions, administrators have the privilege to manage the content of the system,

view traffic statistics and user details.

3.2 Subsystem, Component, or Module 1 …N

As described in the overview, the system has been divided into separate modules to achieve these tasks.

The subsystems are:

Query Posting

Query Response

College Details

Course Details

Login

Registration

Admin login

Moreover the admin login has sub-components namely:

User Details

Saurabh Singh - Copyright Page 4 CCS

Content Management

View as Guest

Traffic Details

3.3 Strategy

The basic strategy followed in the division and implementation of the module is to group the similar functions together into the same module. This avoids redundancy on part of implementation and thus makes the system highly extensible and reusable. The main objective was to make the system highly readable such that altering a part of the module is affected at all occurrences in the system.

4. Database Schema

4.1 Tables, Fields and Relationships

The database contain five tables holding the data for the system categorized into relevant tables with

their primary keys and constraint relationships to have a centralized and optimized storage of the

system data. In our system. The database is created using MySQL for integrated web development

with php and apache. The databse name is CCS.

Based on the requirements, five tables seem sufficient for the system. The proposed tables along

with their attributes are:

Admin

Username varchar(20)

Password varchar(20)

Email varchar(50)

Query

Timestamp date

Userid char(5)

Content varchar(160)

Qid number(3)

Status char(1)

Page

Id number(2)

Name varchar(20)

Position number(1)

Content varchar(500)

Comment

Qid number(3)

Userid char(5)

Timestamp date

Comment varchar(160)

User

Id char(5)

Saurabh Singh - Copyright Page 5 CCS

Name varchar(40)

Email varchar(50)

Password varchar(20)

Mobile number(10)

Sex char(1)

Address varchar(80)

Subscription char(1)

The Query, Comments and User tables are inter-related. Each Query is posted by a User. Also

each of the comment is posted by some user and a query has multiple comments. Queries have

comments. These relationships are depicted in the ER model diagram in the high level design.

4.1.1 Databases

CCS database on server. CCStest database for testing purposes.

4.1.2 Tables

No new Tables required.

4.1.3 New Fields(s)

No new fields in any of the tables.

4.1.4 Fields Change(s)

No changes till date

4.1.5 All Other Changes

No other changes.

4.2 Data Migration

For data migration, export the database from phpmyadmin and then import to any other tool or environment as required.

Saurabh Singh - Copyright Page 6 CCS

5. High Level Design

5.1 Class diagram

Fig 5.1 Class Diagram

Saurabh Singh - Copyright Page 7 CCS

5.2 Use Case Diagram

Fig 5.2 Use Case Diagram

Saurabh Singh - Copyright Page 8 CCS

5.3 Sequence Diagrams

5.3.1 For admin

Fig 5.3.1 Sequence Diagram for Admin

Saurabh Singh - Copyright Page 9 CCS

5.3.2 For User

Fig 5.3.2 Sequence diagram for user

Saurabh Singh - Copyright Page 10 CCS

5.4 State Chart Diagram

Fig 5.4 State Chart Diagram

Saurabh Singh - Copyright Page 11 CCS

5.5 Entity Relationship (ER) model

Fig 5.5 ER Diagram for CCS

Saurabh Singh - Copyright Page 12 CCS

6. User Interface Design

Some snapshots are posted for the GUI Interface.

Fig:6.1 Index page

Saurabh Singh - Copyright Page 13 CCS

Hower effects have been added to make the GUI interactive and more pleasing to the eye.

Fig 6.2 Effects Snapshot

Fig 6.3 Help Page

Saurabh Singh - Copyright Page 14 CCS

Fig 6.4 About Us

Fig 6.5 user login

Saurabh Singh - Copyright Page 15 CCS

Some pages are still under construction. This screen shows the status.

Fig 6.6 Construction

Fig 6.7 Sign Up page

Saurabh Singh - Copyright Page 16 CCS

Fig 6.8 Admin Login Page

Fig 6.9 Admin Home page