30
SOFTWARE REQUIREMENTS SPECIFICATION

Complete

Embed Size (px)

Citation preview

Page 1: Complete

SOFTWARE REQUIREMENTS SPECIFICATION

Page 2: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

VIVACIOUS WINNERS

OONNLLIINNEE CCOOLLLLEEGGEE MMAAGGAAZZIINNEE

SSooffttwwaarree RReeqquuiirreemmeennttss SSppeecciiffiiccaattiioonn

VVeerrssiioonn<<11..00>>

TTTeeeaaammm ggguuuiiidddeee::: KKK...VVV...SSS...RRR...PPP...VVVaaarrrmmmaaa

MMMeeemmmbbbeeerrrsss::: AAA... AAAnnniiilllaaa

AAA... SSSiiinnndddhhhuuu

MMM...RRRaaadddhhhiiikkkaaa KKKrrriiissshhhnnnaaa

MMMooonnniiicccaaa...NNN

CCCooolllllleeegggeee NNNaaammmeee::: GGGIIITTTAAAMMM IIInnnssstttiiitttuuuttteee OOOfff TTTeeeccchhhnnnooolllooogggyyy

DDDeeepppaaarrrtttmmmeeennnttt OOOfff CCCooommmpppuuuttteeerrr SSSccciiieeennnccceee &&& EEEnnngggiiinnneeeeeerrriiinnnggg

VVViiisssaaakkkhhhaaapppaaatttnnnaaammm---444555

AAAnnndddhhhrrraaa PPPrrraaadddeeessshhh

VIVACIOUS WINNERS/GITAM Institute Of Technology 1

Vivacious Winners

Page 3: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

RREEVVIISSIIOONN HHIISSTTOORRYY

DDaattee VVeerrssiioonn DDeessccrriippttiioonn AAuutthhoorr 1122..0022..22001122 11..00 An Online College Magazine where

college students and faculties can post and read various articles, thus promoting literary insight. Articles can be searched by anybody in the world. Factors behind the motivation of this system are:

Not all students make it to the printed magazine.

Creativity of students needs to be nurtured.

Creating a user- friendly interactive place where students/faculties can share their ideas.

VViivvaacciioouuss WWiinnnneerrss

VIVACIOUS WINNERS/GITAM Institute Of Technology 2

Vivacious Winners

Page 4: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

TTAABBLLEE OOFF CCOONNTTEENNTTSS

1. Introduction 1.1Methodology……………………………………….4 1.2 Purpose……………………………………………5 1.3 Scope………………………………………………5 1.4 Definitions, Acronyms and Abbreviations………..6 1.5 Tools Used…………………………………………6 1.6 References…………………………………………7 1.7 Technologies to be used…………………………...8 1.8 Overview…………………………………………..8 2. Overall Description 2.1 Product Perspective………………………………...9 2.2 Software Interface…………………………………9 2.3 Hardware Interface………………………………...10 2.4 Communication Interface………………………….10 2.5 Constraints…………………………………………10 2.6 Architecture Design………………………………..11 3. UML Diagrams 3.1 Activity Diagrams…………………………………..14 3.2 Use case Diagrams………………………………….19 3.3 Class Diagram………………………………………25 3.4 State Chart Diagram………………………………..26 3.5 Sequence Diagram.………………………………....27 3.6 ER Diagram………………………………………....28 4. Supporting Information 4.1 Index…………………………………………………29

VIVACIOUS WINNERS/GITAM Institute Of Technology 3

Vivacious Winners

Page 5: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

SSSOOOFFFTTTWWWAAARRREEE RRREEEQQQUUUIIIRRREEEMMMEEENNNTTTSSS SSSPPPEEECCCIIIFFFIIICCCAAATTTIIIOOONNN

1. Introduction

1.1 METHODOLOGY: The Rational Unified Process brings together elements from all of the generic process models, supports iteration and illustrates good practice in specification and design. The RUP is normally described from three perspectives A dynamic perspective that shows the phases of the model over time. A static perspective that shows the process activities that are enacted. A practice perspective that suggests good practices to be used during the process.

Fig 1.1: Phases of RUP The different phases in RUP are

INCEPTION The goal of the inception phase is to establish a business case for the system. Identifying all external entities that will interact with the system and defining these interactions. This information is used to assess the contribution of system to business.

VIVACIOUS WINNERS/GITAM Institute Of Technology 4

Vivacious Winners

Page 6: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

ELABORATION

The goals of the elaboration phase are to develop an understanding of the problem domain, establish an architectural framework, develop project plan and identify key project risks.

CONSTRUCTION This phase is concerned with system design, programming and testing. Parts of the system are developed in parallel and integrated during this phase.

TRANSITION This is the final phase of RUP and is concerned with moving the system from the development community to the user community and making it work in real environment.

1.2 Purpose:

ONLINE COLLEGE MAGAZINE is a normal kind of magazine but present online. As now a day’s life is

so complicated that there is no time to buy a book or a magazine and to study separately.

Everything is available through Internet. Creating and managing an Online College Magazine where

college students and faculties can post and read various articles, thus promoting literary insight.

Articles can be searched by anybody in the world. Factors behind the motivation of this system are:

1. Not all students make it to the printed magazine.

2. Creativity of students needs to be nurtured.

3. Creating a user-friendly interactive place where students/faculty can share their ideas.

1.3 Scope:

1. Posting Articles

2. Conducting Polls

3. Getting Notifications

4. Several college Advertisements

5. Getting News about College

6. Even thought for the day/Word kind of things etc.

VIVACIOUS WINNERS/GITAM Institute Of Technology 5

Vivacious Winners

Page 7: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

1.4 Definition, Acronyms, and Abbreviations:

HTML (Hyper Text Markup Language): It is used to create static web pages. JSP (Java Server Pages): It is used to create dynamic web content. J2EE (Java 2 Enterprise Edition): It is a programming platform, belonging to the Java

platform, which is used for developing and running distributed java applications. DB2 (IBM Database 2): It is a database management system that provides a flexible

and efficient database platform to raise a strong "on demand" business applications. HTTP (Hyper Text Transfer Protocol): It is a transaction oriented client/ server protocol

between a web browser and a web server. XML (Extensible Markup Language): It is a markup language that was designed to

transport and store data. Ajax (Asynchronous Java Script and XML): It is a technique used in java script to create

dynamic web pages. Web 2.0: It is commonly associated with web applications which facilitate interactive

information sharing, interoperability, user-centered design and collaboration on the World Wide Web.

1.5 tools used:

Application architecture – JAVA, J2EE

JAVA Java is an object-oriented programming language developed by Sun Microsystems a company best known for its high end UNIX workstations. Java language was designed to be small, simple, and portable across platforms, operating systems, both at the source and at the binary level, which means that Java programs (applet and application) can run on any machine that has the Java virtual machine (JVM) installed. J2EE Java Platform, Enterprise Edition or Java EE is a widely used platform for server programming in the Java programming language. The Java platform (Enterprise Edition) differs from the Java Standard Edition Platform (Java SE) in that it adds libraries which provide functionality to deploy fault-tolerant, distributed, multi-tier Java software, based largely on modular components running on an application server.

VIVACIOUS WINNERS/GITAM Institute Of Technology 6

Vivacious Winners

Page 8: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

Web server – WASCE Web Sphere Application Server Community Edition (from now on WASCE) is a free, certified Java EE 5 server for building and managing Java applications. It is IBM's supported distribution of Apache Geronimo that uses Tomcat for servlet container and Axis 2 for web services. Over 15 WASCE developers are committers in the Apache Geronimo project. Development tool –RAD IBM Rational Application Developer for Web Sphere Software (RAD) is an integrated development environment (IDE), made by IBM's Rational Software division, for visually designing, constructing, testing, and deploying Web services, portals, and Java (J2EE) applications. Database platform – DB2 DB2 Database is the database management system that delivers a flexible and cost effective database platform to build robust on demand business applications and supports the J2EE and web services standards. Design tool – Rational Software Modeler IBM Rational Software Modeler, (RSM) made by IBM's Rational Software division, is a Unified Modeling Language UML 2.0-based visual modeling and design tool. Rational Software Modeler is built on the Eclipse open-source software framework and includes capabilities focused on visual modeling and model-driven development (MDD) with the UML for creating resilient, thought-out applications and web services.

1.6 References:

Object Oriented Modeling and Design with UML-Michael Blaha, James Ram Baugh.

Software Engineering, Seventh Edition, Ian Somerville.

IBM Red Books.

IBM TGMC Sample Synopsis.

IBM – www.ibm.in/developerworks.

Java - www.sun.com

Wikipedia - www.wikipedia.com

Database Management Systems - Navathe.

Complete Reference - J2EE - Keogh.

VIVACIOUS WINNERS/GITAM Institute Of Technology 7

Vivacious Winners

Page 9: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

1.7 Technologies TO be used:

DB2: Relational Database Management System.

RAD: Rational Application Developer.

WASCE: Web sphere Application Server Community Edition.

Rational Software Modeler.

1.8 Overview:

Existing System: Registration for users Discussion forum Feedback Proposed System: Registration for students, faculty. Administrator and Moderator take care of the users and their articles and polls. Our Plan: Registration for users. Feedback facility. Uploading and Downloading Articles enabled for Registered users, administrators and moderators. Valuable Comments are accepted (no spam). A search space to search for articles based on the category to which they belong. Anonymous users are allowed to search for articles, post their comments and give feedback. Discussion Poll. Approval by the admin and moderator for uploading articles.

VIVACIOUS WINNERS/GITAM Institute Of Technology 8

Vivacious Winners

Page 10: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

2. OVERALL DESCRIPTION

2.1 PRODUCT PERSPECTIVE:

2.2 SOFTWARE INTERFACE:

CLIENT ON INTERNET Web Browser, Operating System (any)

WEB SERVER WASCE, Operating System (any)

DATABASE SERVER DB2, Operating System (any)

DEVELOPMENT END RAD (J2EE, Java, Java Bean, Servlets, HTML, XML, AJAX), DB2, OS (Windows), Web Sphere (Web Server)

VIVACIOUS WINNERS/GITAM Institute Of Technology 9

Vivacious Winners

Page 11: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

2.3 Hardware Interface:

Minimum Requirements: CLIENT SIDE

Internet Explorer - 6 PROCESSOR: Intel Pentium III or AMD- 800 MHz RAM: 128 MB DISK SPACE: 100 MB

SERVER SIDE RAD, DB2 - 9.5 PROCESSOR: Intel Pentium III or AMD -800 MHz RAM: 1 GB 256 MB DISK SPACE: 3.5 GB500 MB (Excluding Data Size)

Recommended Requirements: CLIENT SIDE

Internet Explorer - 6 PROCESSOR: All Intel or AMD - 1 GHZ RAM: 256 MB DISK SPACE: 100 MB Server Side

SERVER SIDE RAD, DB2 - 9.5 PROCESSOR: All Intel or AMD - 2 GHZ RAM: 2 GB 512 MB DISK SPACE: 3.5 GB500 MB (Excluding Data Size)

2.4 Communication Interface Client (customer) on Internet will be using HTTP/HTTPS protocol.

Client (system user) on Internet will be using HTTP/HTTPS protocol.

2.5 Constraints GUI is only in English.

Login and password is used for the identification of users.

Limited to HTTP/HTTPS.

This system is working for single server.

VIVACIOUS WINNERS/GITAM Institute Of Technology 10

Vivacious Winners

Page 12: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

2.6 SYSTEM DESIGN:

We have decided to use “Client Server Architecture” for developing the project. The reason is because, the whole

magazine is technically a huge data base which contains all the information and it’s online, so it requires a server system

for a proper functioning. The server gets updated quite often and clients can access the information. It is similar to an

online database on a limited scale.

VIVACIOUS WINNERS/GITAM Institute Of Technology 11

Vivacious Winners

Page 13: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

OVERALL DIAGRAM OF ONLINE COLLEGE MAGAZINE:

VIVACIOUS WINNERS/GITAM Institute Of Technology 13

Vivacious Winners

Page 14: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

3.1 OVERALL ACTIVITY DIAGRAM:

VIVACIOUS WINNERS/GITAM Institute Of Technology 14

Login/Register

Home

Search

For All

Articles

Category Archive Comment Update Discussio

n Poll

Thought

Of The

Day

Upload

Articles

Downloa

d Article

s

Feedba

ck

AdministratorRegistered User

Request Admin

Add/Remove

Article User/Mode

ratorPost

Confirm and

Post

Message to

User

Logout

Moderator

Validates

Article Post

Maintains

Profile

Vivacious Winners

Page 15: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

Guest:

Guest can visit online college magazine site and can read articles, rate them & comment on

them. They can also access other optional features like thought of the day but cannot post articles

unless they sign in as registered users.

Administrator: Administrator can add/delete moderators. Can post news which will be visible at the home page. Administrator can maintain achieves. He can categorize articles. Moderator: Moderator can view all the articles & he/she can add articles. Moderator can also comment as a discussion poll. They can post the thought of the day & can give the feedback. User: Registered users will have their own profile where they can their info for the world to see. Useful updated info related to their activities to be available at their profiles.

ACTIVITY DIAGRAM FOR GUEST

VIVACIOUS WINNERS/GITAM Institute Of Technology 15

guest

Home

search artcles catogory archive comment discussion poll thought of the

day

feedback

Vivacious Winners

Page 16: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

ACTIVITY DIAGRAM FOR REGISTERED USER:

VIVACIOUS WINNERS/GITAM Institute Of Technology 16

Login

Search for all

articles Category

Comment

Archive

Update

Uploading

articles

Discussion

Poll

Downloading

articles

Thought of the

day

Feedback

Logout

Vivacious Winners

Page 17: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

ACTIVITY DIAGRAM FOR ADMINISTRATOR

VIVACIOUS WINNERS/GITAM Institute Of Technology 17

Registered

admin

add/remove

Article User Posts

confirm & post

message to

user

log out

moderators

Vivacious Winners

Page 18: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

Activity diagram for moderator

VIVACIOUS WINNERS/GITAM Institute Of Technology 18

moderator

add/remove

Article User Posts

confirm & post

message to

user

log out

Vivacious Winners

Page 19: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

3.2 Overall Use case diagram

VIVACIOUS WINNERS/GITAM Institute Of Technology 19

Feedback

Logout

Add or Delete Moderators

Guest

Login/Register

Search For All Articles

Category

Archive

Comment

Update

Discussion Poll

Thought Of The Day

Uploading Articles

Downloading Articles

Feedback

Registered User

Administrator

Logout

Moderator

Vivacious Winners

Page 20: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

Use case diagram for user:

VIVACIOUS WINNERS/GITAM Institute Of Technology 20

Login/Register

Search For All Articles

Category

Archive

Comment

Update

Discussion Poll

Thought Of The Day

Uploading Articles

Downloading Articles

Feedback

Logout

Registered User

Vivacious Winners

Page 21: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

Use case diagram for guest:

VIVACIOUS WINNERS/GITAM Institute Of Technology 21

Search For Al l Articles

Category

Archive

Comment

Discussion Poll

Thought Of The Day

Feedback

Guest

Vivacious Winners

Page 22: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

Use case diagram for administrator:

VIVACIOUS WINNERS/GITAM Institute Of Technology 23

Login/Register

Search For All Articles

Category

Archive

Comment

Update

Discussion Poll

Thought Of The Day

Uploading Articles

Downloading Articles

Feedback

Logout

Administrator

Vivacious Winners

Page 23: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

Use case diagram for moderator:

VIVACIOUS WINNERS/GITAM Institute Of Technology 24

Login/Register

Search For All Articles

Category

Archive

Comment

Update

Discussion Poll

Thought Of The Day

Uploading Articles

Downloading Articles

Feedback

Logout

Moderator

Vivacious Winners

Page 24: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

3.3 Class diagram:

VIVACIOUS WINNERS/GITAM Institute Of Technology 25

Vivacious Winners

Page 25: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

3.4 State chart dIagram:

VIVACIOUS WINNERS/GITAM Institute Of Technology 26

IdleLogin/Regi

ster

Post Comment DiscussionSearch for

articlesFeedback

Logout

Vivacious Winners

Page 26: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

3.5 Sequence diagram:

VIVACIOUS WINNERS/GITAM Institute Of Technology 27

Registered

MemberOnline college

magazineDtabase Admin

login/register

upload an artcle

Browse your contents

select file/doc. to upload

message to user about postng

download an article

discussion poll

message to user about posting

Requesting feedback

Fill & submit form

logout

successful logout

verification

successful login

Requesting admin to post an article

Article successfully pposted

Query database

File downloaded

reqesting permission to post an discussion poll

Successfully added discussion poll

Authentication from admin

Issue form

Vivacious Winners

Page 27: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

3.6 ER DIAGRAM:

VIVACIOUS WINNERS/GITAM Institute Of Technology 28

GuestOnline

College

Magazine

Visits

Userregisters

in

Administr

ator

Registered

User

Archivesmaintains

Logs in

Moderator

can have

in

Articles

Profile

Feedback

can

view

can

download

can

post

can

givecan

validate

name url

1

name age

UsernamePassword

gender

DOB

Profile

namePicture

Friends

name

category

no.of downloads

Username

Password

gender

DOB

Admin key

dateuser's mail

id

Username

Password

Mod key

DOB

gender

Logs out

from

Vivacious Winners

Page 28: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

4.1 INDEX: A Abbreviations& Acronyms · 6 Administrator · 16 AJAX · 6 Analysis · 3 Design · 18

C Client on Internet · 9 Communication Interface & Constraints · 10

D

Data Base · 9 DB2 · 6 Definitions · 6

E Elaboration · 5 ER Diagram · 28 Existing System · 8

H HTML & HTTP · 6

I Inception & Introduction · 4

J J2EE -6 Java , JSP ·6

M Moderator · 16 Methodology · 4

O Overall · 13 Overview · 8

P Product Perspective · 9 Proposed System · 8 Purpose · 5

R RAD · 7 References · 7 Reports · 4 Rational Unified Process · 7

S Scope · 5 Sequence · 27 Software · 9 State chart-26

T Transition· 5 Technologies · 8

U Use-case · 19 UML · 3

VIVACIOUS WINNERS/GITAM Institute Of Technology 29

Vivacious Winners

Page 29: Complete

Online College Magazine Version<1.0> Software Requirements Specification 12.02.2012

SSPPEECCIIAALL TTHHAANNKKSS

We convey a special thanks to our department, our guide

and to our college. We also convey special thanks to all these

softwares and websites; they have been of great help in doing the

project. We owe a great deal of debt to the IBM-TGMC2011 for giving

us the opportunity to nurture our skills and present our fresh

talent in the form of this project.

VIVACIOUS WINNERS/GITAM Institute Of Technology 30

Vivacious Winners

Page 30: Complete