Online College Magazine System

Online College Magazine Version 1.0Software Requirement Specification May 18, 2013

Online College Magazine

Software Requirement Specification

Team Member

RamLaxmanBharat1 or tha

College

Poddar Institute of Engineering

Department

Computer Science

1


Table of Contents

Description

1. Introduction

1.1. Purpose____________________________________________

1.2. Scope ___

1.3. Definition, Acronyms and Abbreviation

1.4. Technologies to be used

1.5. References

1.6. Overview

2. Overall Description

2.1. Product Perspective

2.2. Software Interface

2.3. Hardware Interface

2.4. Communication Interface

2.5. Product Function

2.6. User Characteristics

2.7. Constraints

2.8. Architecture Design

2.9. Use Case Model Description

2.10. Class Diagram

2.11. Sequence Diagram

2.12. Database Design

2.12.1. ER Diagram

2.12.2. Schema Design

2.13. Assumptions and Dependencies

2.13.1. Context Diagram2.13.2. 1 Level DFD 2.13.3.2 Level DFD

3. Specific Requirements

3.1. Use Case Reports3.2. Supplementary Requirements

2


1. Introduction

1.1. Purpose

Online College Magazine is a web application where college students and faculties can post and read various articles, thus promoting literary insight. Articles can be searched by any one across the world. The users (Guest/Students/Faculties/Moderators/Administrator) can connect through internet and share their ideas. This web application is more effective and user friendly interactive place where students/Faculties can share their views by the help of blogs, articles and feedbacks.

1.2. Scope

There are four basic users – Guest/Anonymous, Registered Members(Students/Faculties), Moderators, Administrator

All users have their own profiles in Online College Magazine. Only students and faculties can register as a member. Members can post and read their articles Moderator views and manages the Registration of members. He also sends reports to

administrator . Guests can search for Articles to read, to like and they can comment on post but can’t

post. Admin has the authority to add/delete users, grant permission to members and users to

generate an articles, blogs and view feedback.

1.3. Definitions, Acronyms and Abbreviations

Admin Administrator: He has the authority to add/delete users, grant permission to

to members and users.

Apache Tomcat Apache Tomcat: It is an application server that runs and supports J2EE and

web service applications.

MS-Access Microsoft Access: is a database management system from Microsoft that

combines the relational Microsoft Jet Database Engine with a graphical user interface and software-development tools.

JSP Java Server Pages: It is used to create dynamic web content.

3


J2EE Java 2 Enterprise Edition:A programming platform which is a part of java

platform fordeveloping and running distributed java.

UML Unified Modeling Languageis a standard language for writing software

blueprints. TheUML may be used to visualize, specify, construct and document.

XML Extensible Markup Languageis a text based format that let developers describe, deliverand exchange structured data between a range of applications to client for display and manipulation.

HTTP Hypertext Transfer Protocol:It’s a service protocol.

Eclipse Eclipse is a development tool that helps to develop a robust, full-featured,

commercial-quality industry platform for the development of highly integrated tools.

1.4. Technologies to be used

Application architecture – JAVA, J2EE

JAVAJava is an object-oriented programming language developed by Sun Microsystems a

companybest 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, whichmeans that Java programs (applet and application) can run on any machine that has the Java virtualmachine (JVM) installed.

J2EEJava Platform, Enterprise Edition or Java EE is a widely used platform for server

programmingin the Java programming language. The Java platform (Enterprise Edition) differs from the JavaStandard Edition Platform (Java SE) in that it adds libraries which provide functionality to deployfault-tolerant, distributed, multi-tier Java software, based largely on modular components runningon an application server.

Web server – Apache TomcatApache Tomcat is an open source software implementation of the Java Servlet and Java

Server Pages technologies. Apache Tomcat is developed in an open and participatory environment. Apache Tomcat project is trademark of the Apache Software Foundation.

4


Development tool –Eclipse

Eclipse is an extensible, open source IDE (integrated development environment). The project was originally launched in November 2001, when IBM donated $40 million worth of source code from Websphere Studio Workbench and formed the Eclipse Consortium to manage the continued development of the tool.

Database platform – MS-AccessMS-Access is the database management system that delivers a flexible and cost

effective database platform to build robust on demand business.

1.5. References Object Oriented Modeling and Design with UML-Michael Blaha, James

Rambaugh. Software Engineering, Seventh Edition, Ian Sommerville. Java - www.sun.com Wikipedia - www.wikipedia.com Complete Reference - J2EE - Keogh.

1.6. Overview

Existing System: Manually Registration

Drawbacks: No webcam support Not all users can post their articles People who doesn’t have a knowledge of computer and internet cannot use the system

Proposed System: Registration for students and faculty New user can be applied online Members can share their ideas via blogs and articles.

Our Plan: Registration for members of the college. Online maintenance of Articles and post. Post ratings and commenting of articles. Online search of articles across the world Feedback from user

5

http://www.wikipedia.com/


2. Overall Description

2.1. Product Perspective

2.2. Software Interface

Client on InternetWeb Browser, Operating System (any)

Web ServerApache Tomcat, Operating System (any)

Data Base ServerMS-Access

Development EndEclipse (J2EE, Java, Java Bean, Servlets, HTML, XML, AJAX), DB2, OS (Linux),Apache Tomcat(Web Server)

2.3. Hardware Interface

Minimum Requirements:

Client SideProcessor RAM Disk Space

Internet Explorer - 6Intel Pentium III or

AMD -800 MHz128 MB 100 MB

6


Server SideProcessor RAM Disk Space

Apache Tomcat Intel Pentium III or AMD -800 MHz

1 GB 3.5 GB

Ms-Access - 2003256 MB 500 MB

(Excluding Data Size)

Recommended Requirements:

Client SideProcessor RAM Disk Space

Internet Explorer - 6All Intel or AMD - 1

GHZ256 MB 100 MB

Server SideProcessor RAM Disk Space

Apache Tomcat All Intel or AMD - 2 GHZ

2 GB 3.5 GB

Ms-Access - 2003512 MB 500 MB

(Excluding Data Size)

Client Side2.4. Communication Interface

The Online College Magazine will be connected to the World Wide Web. The HTTP protocol will be used to facilitate communication between the client and

server.

2.5. Product Function

Online College Magazine is web application which provides several facilities to the users, registered members, moderators as well as administrator to maintain the entire thing online. Some of the features of the product are as follow:

Search Engine for all the articles posted till date. Accessible by anybody. Essential steps to be taken to prevent authenticity infringement. Articles to be distributed in categories. Can overlap 2 or more categories. Articles to be associated with suitable tags by the registered users at the time of posting, so that they are searchable. The home page to consist of attractive essential features like: most read articles, editor’s pick, recently posted articles, highest rated articles, article of the month, college news, etc. Archives to be maintained. Interactive feedback to be supported to enhance the user experience. Guests can read articles, rate them and comment on them. They can also access other optional features (amenities like Word of the day, etc.) but can’t post articles unless they sign in as registered users. Automatic commenting on articles by spammers/automatic bots to be defied.

7


Prevent standard automated software from filling out a form. College Students/Faculties can only register as members (through unique IDs). Alumni registration to be supported. Registered members, Moderators and Administrators are allowed to post articles. Articles can be downloaded in various formats. Registered users, Moderators, and Admins will have their own profile, where they can edit info for the world to see. Useful “updated” info related to their activities to be available at their profiles. Regex to be extensively used for prohibiting obscene and unacceptable comments. Moderators will have associated categories, according to which to-be-validated-articles will be posted to them on their profiles. On rejection, he will have to provide a reason for the same, which will be forwarded to the concerned user. Automated mails to be sent on rejection/acceptance of articles. Admin can add/delete moderators. Progress report of moderators will be available to her/him. Admin has all the privileges a moderator has. Can post news which will be visible at the home page.

2.6. User Characteristics

Guest/Anonymous: Guests can search for Article to read, to like and he/she can comment on

post but can’t post.

Registered Members (Students/Faculty): Only members of college can register.

Registered Members have their own profiles.

Moderators: Moderator views and manages the Registration of members. He also sends

reports to administrator.

Administrator: Admin has the authority to add/delete members as well as posts or articles,

grant permission to registered members and Moderator to post articles and view profiles.

2.7. Constraints

The information of all the users must be stored in a database that is accessible by the Online College Magazine

The Online College Magazine system is connected to the computer and is running all 24 hours a day.

The users can access Online College Magazine System from any computer that has Internet browsing capabilities and an Internet connection.

The users must have their correct usernames and passwords to enter into the Online College Magazine system.

GUI is only in English.

8


2.8. Architecture Diagram

Application Layer Business Layer Database Layer

9

Architecture Diagram

Member login Login

Registration of members

Registration

Registration

Registration

Member Member Searching of member

Search

Creating & Maintaining Profile

Creating & Maintaining ProfileProfile

Posting of article by member Posting of articles

Comments & like of post Comments & like

Discussion Forum

Discussion Forum

Feedback by Member

Feedback Feedback Feedback


2.9 Use Case Model

Use cases were designed for object oriented software development they focus on what the user need to do with the system. This approach is more powerful as compared to traditional approach. It used a combination of text and pictures in order to improve the understanding of requirements. The use case describe ‘what of a system and not how of a system’. They only give the functional view of the system.

10

Add or delete members

Add or delete members

Report adminReport admin

Post linksPost links

Block studentsBlock students

Manage ProfileManage Profile

Post noticePost notice

Grant permissionsGrant permissions

Block studentsBlock students

Manage registrationManage registration

Post linksPost links

SearchSearch Comments

Comments profileprofile Post

Articles

Post ArticlesRead ArticlesRead Articles RateRate

USE CASE DIAGRAM

Is faculty

ModeratorAdministrator

Registered Members(faculty/ students)

Anonymous/ User


2.10. Class Diagram

11

CLASS DIAGRAM

Anonymous

user_name

Emai_id

signUp()

Read()

Search()

feedback()

rating()

comment()

Admin

User_id

Password

Login()

viewReport()

viewFeedback()

autorized()

updation()

viewStatus()

addDelPost()

AddDelMembers()

Feedback

Feedback_id

Content

postFeedback()

viewFeedback()

Faculty/ Student

id_no

Member_name

Address

Contact_no

Email_id

City

State

Postal_code

Location

signUp()

login()

viewStatus()

postArticles()

postLinks()

viewProfile()

updateProfile()

Moderators

Id_no

Moderator_Name

Email_id

user_id

password

ManageRegistration()

ManageProfiles()

reportAdmin()


2.11. Sequence Diagram

12

User User Database DatabDatabase

Database DatabDatabase

Account Created

Published

Edit profile

System System

Article Posted

Successful login

View profile

Sign up

For Verification

SEQUENCE DIAGRAM


2.12. Database Design2.12.1 Entity-Relationship Diagram

13

ENTITY-RELATIONSHIP DIAGRAMENTITY-RELATIONSHIP DIAGRAM

AnonymousAnonymous

RateRate

Student/FacultyStudent/Faculty

ModeratorModerator AdministratorAdministrator

Is Facult

y

Is Facult

y

NameName PasswordPassword

ArticlesArticles

EmailIDEmailID

CommentComment

User_idUser_idProfileProfile

NoticesNotices

ReportsReports

Student block

Student block

CategoryCategory

ReportsReports

CategoryCategory

ProfileProfile

VerificationVerification

Authorize

Authorize

RateRate PollingPolling

PostPostCommentComment

IdId

POSTPOST

StatusStatus

UpdationUpdationBlogsBlogs

RoleRole


2.12.2. Database Schema

UserType Table: This table maintain the user id ,type ,date and other information.

Field name Data Type

Id AutoNumber

Type Text(20)

DateCreated Date/Time

IsActive Text(1)

Categories Table: This table will store the categories of the user.

14

UserProfile

UserId

UserTypeId

Name

UserCategory

EmailId

RedgId

Address

phoneNo

UserName

Password

IsActive

DateCreated

Status

Feedback

FeedbackId

Content

DateOfPost

DATABASE SCHEMADATABASE SCHEMA


Categories Data Type

Id AutoNumber

Category_name Text(20)

IsActive Text(1)


UserImage Table: This table will store the details of user profile images at the time of Registration.

Admin Table: This table will store details about comments posted by the user/Members.

Comments Data Type

UserId Number

BlogId Text(20)

DateOfPost Date/Time

Status Text(20)

Comment Text(50)

Feedback Table: This table will store the order details of Feedbacks given by the user or members.

Feedback Data Type

15

UserImages Data Type

ImgId AutoNumber

UserId Text (20)

path Text (50)

IsActive Char


CancelOrder Table:In the case if customer or dealer cancels the ordered LPG due to some reason than the entry of that order will be deleted from Order Table and inserted in this table.

UserProfile Data Type

UserId Number

UserTypeId Number

Name Text(20)

UserCategory Text(20)

EmailId Text(40)

RedgId Number

Address Text (80)

phoneNo Number

UserName Text (20)

Password Text (20)

IsActive Text(1)


Status Text (10)

2.13. Data Flow Diagram

2.13.1. Context Level Diagram Level(0):

Signup read search rating comment

16

Anonymous


LOGIN Login

View Report, Feedback Post Articles/ Links

Updation view/update Profile

View Status view status

Add/Delete Members block users

Manage redg login manage report

Profile admin

2.13.2. Detailed DFD

17

System For Online College

Magazine

System For Online College

Magazine

Administrator

Members

Moderator

AnonymousSearch Article

Post comment

Views

Comment table

Read

Admin member Moderator

DATA FLOW DIAGRAM LEVEL(0)


18

Members

Post Articles

Views Database

Create Profile

Admin Moderator

Moderator

Report to admin

Views Database

Manage Profile& reg

Admin


2.14. Assumption and Dependencies

The users have sufficient knowledge of computers. The 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 product can access the member’s database.

3.0. Specific Requirements

Apache Tomcat, Eclipse : Front End JSP,AJAX : Server Side Scripting XHTML : Client Side(JAVA Script) Ms-Access : Back End JAVA Servlet : Program Method

19


3.2. Activity Diagram

1. User Registration Activity

Initially user is made to fill all mandatory fields filled in registration form. Once the user clicks submit,Then the username is verified. If the username is already present, then the user is again taken back,So that, he can changes the username. If the username is not present then it checks for password and remaining mandatory fields. If any of the mandatory field is left empty or filled incorrect, then the user is informed to enter the correct values. Once all these verifications are succeeded, then the registration is done.

20

Login userLogin user

Enter RegistrationEnter Registration

User Already ExistsUser Already Exists

Verification of Mandatory FieldVerification of Mandatory Field

Registered SuccessfullyRegistered Successfully

Go to Home PageGo to Home Page

Fill Required FieldFill Required Field

Not Valid

Valid

Not Valid

Valid


2. User Post Activity

In this a user post articles then it will go for the verification if the article is not verified than it will be rejected else it will be accepted.

21

Read ArticleRead Article

Post CommentsPost Comments

VerificationVerification

Go to Home PageGo to Home Page

Article RejectedArticle Rejected

ApprovedRejected

Article PostedArticle Posted

Notification Send to userNotification Send to user


3. Verified by teacher Activity

The student posts the article which is verified by the teacher. If the article is verified by the faculty than it will published successfully else it will be reject and the notification of rejection will sent to the student.

22

Student PostStudent Post

Verify by FacultyVerify by Faculty

Notification sendNotification send

Published SuccessfullyPublished Successfully

Not Valid

Valid


3.3. Supplementary Requirement

Safety RequirementsHighly recommend Kaspersky 2013 internet security to been Installed in users Pc to prevent the harm that may occurs by unwanted malicious software’s, phishing URLs and all the types of virus attacks during using this application.

Security RequirementsAll users should be properly authenticated before allowed entry into the system authentication will be based on an E-mail address, and a password. All activities on the system must be logged.

Non-Functional Requirements Secure access of confidential data (user’s details). SSL can be used.

24 X 7 availability.

Better component design to get better performance at peak time.

Flexible service based architecture will be highly desirable for future extension.

Other RequirementsThe user must be agreed with all the term and conditions that have provided by the System Administrator, local authority and Should Obey to the all International standards and Protocols.

23

Online College Magazine System

Documents

adddelete users

software interface

college students

web application

various articles

basic users guestanonymous

j2ee java

articles moderator views