Date post: | 22-Oct-2014 |
Category: |
Documents |
Upload: | chaitra-sagar |
View: | 30 times |
Download: | 0 times |
SHOUTBOX
(An online message board)
A Report submitted to MSRIT
Bangalore,
For partial requirement of award of degree of
Bachelor of Engineering in Computer Science and Engineering
ByCHAITRA SAGAR 1MS09CS022
HIMICA KHURANA 1MS09CS036
DEPARTMENT OF COMPUTER SCIENCE AND ENGINEERING
M. S. RAMAIAH INSTITUTE OF TECHNOLOGY
(Autonomous Institute, Affiliated to VTU)
May 2012
Product Requirements DocumentRevision History SHOUTBOX-online message board
Department of Computer Science and Engineering,
M. S. Ramaiah Institute of Technology Bangalore - 54
CERTIFICATE
This is to certify that the following students, who were working under
our guidance, have completed their work as per our satisfaction with the
topic ShoutBox(message board). To the best of our understanding the
work to be submitted in this report does not contain any work, which has
been previously carried out by others and submitted by the candidates
for themselves for the award of any degree anywhere.
CHAITRA SAGAR 09CS022
HIMICA KHURANA 09CS036
Springice Proprietary and Confidential ii
Product Requirements DocumentRevision History SHOUTBOX-online message board
Department of Computer Science and Engineering,
M. S. Ramaiah Institute of Technology Bangalore - 54
DECLARATION
We hereby declare that the entire work embodied in this report has been
carried out by us at M. S. Ramaiah Institute of Technology under the
supervision of Ms. Leelavathi Rathod. This report has not been submitted
in part or full for the award of any diploma or degree of this or any other
University.
CHAITRA SAGAR 09CS022
HIMICA KHURANA 09CS036
Springice Proprietary and Confidential iii
Product Requirements DocumentRevision History SHOUTBOX-online message board
Acknowledgements
The motivation behind this project has always been Ms. Leelavathi Rathod for she introduced us to Internet Technologies, got us completely engaged with it and guided us whenever required. The project wouldn’t have been a success without her.
Springice Proprietary and Confidential iv
Product Requirements DocumentRevision History SHOUTBOX-online message board
Abstract
Many businesses today recognize that the knowledge of their team is one of their most valuable assets. But capturing and tapping that knowledge for the future remains a challenge.Team members don't have the time to meet face-to-face. And valuable electronic communication between employees is lost on desktops and e-mail inboxes and cannot be accessed or shared for relevant situations.Online Discussion Forums solve these challenges and offer new opportunities for knowledge management across your company. The online discussion forums provide a centralized brainstorming area for ideas, information, resources, and feedback on critical business decisions.Unlike a physical meeting, team members can contribute online communication as their schedule allows. And unlike email, the information is labeled, categorized, and stored for future business use.With ODF you can navigate through the forum postings and tap the ideas to make faster, better, and more informed decisions. ShoutBox implements message board using php .Here user can post messages, view messages on the board. Messages can be filtered according to specific date or specific user.
Springice Proprietary and Confidential v
Product Requirements DocumentRevision History SHOUTBOX-online message board
Springice Proprietary and Confidential vi
Product Requirements DocumentRevision History SHOUTBOX-online message board
About This Document
Purpose of this Document
The Systems Requirements Specification (SRS) is designed to express the behavioral, performance, and development requirements of this product and serves as the fundamental requirements document for the development of the product. The Systems Requirements Specification includes a description of every input into the system, every output from the system and all functions performed by the system in response to input or in support of an output. The SRS meets IEEE830 standards and is the exclusive requirements document to be used in development; all design and testing choices must be compatible with this document.
Document Prepared for
M.S RAMAIAH INSTITUTE OF TECHONOLOGY
Date of Publication
May 10th 2012
Page Count 14 pages
Prepared by Chaitra Sagar, Himica Khurana
1MS09CS022, 1MS09CS036
Copyright Notice Permission to make digital or hard copies of all of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for commercial advantage and that copies bear this notice and the full citation on the first page. Abstracting with credit is permitted. To copy otherwise, to republish, to post on servers, or to redistribute to lists, requires prior specific permission and/or a fee. Request permission to republish from the owners.
Springice Proprietary and Confidential vii
Product Requirements DocumentRevision History SHOUTBOX-online message board
Revision History
Date Revision Description Author
15/4/2012 1.0 Initial Project DescriptionSections: 1.1, 1.2, 1.3
Chaitra Sagar
28/04/2012 1.1 Sections: 2.1,2.2 Himica Khurana
1/05/2012 1.2 Sections: 2.3 Chaitra Sagar
10/05/2012 1.3 Sections 3, 4, several small updates, final formatting
Himica Khurana
Springice Proprietary and Confidential viii
Product Requirements DocumentRevision History SHOUTBOX-online message board
Table of Contents
1. INTRODUCTION..................................................................................................................................... 1
1.1. PURPOSE............................................................................................................................................... 1
1.2. SCOPE................................................................................................................................................... 1
1.3. REFERENCES.......................................................................................................................................... 1
1.4. STANDARDS........................................................................................................................................... 1
1.5. DEFINITIONS........................................................................................................................................... 1
2. OVERALL DESCRIPTION...................................................................................................................... 2
2.1. PROJECT ABSTRACT............................................................................................................................... 2
2.1.1. Project Scope..................................................................................................................................... 2
2.1.2. Background........................................................................................................................................ 2
2.1.3. System Purpose................................................................................................................................. 2
2.1.4. System Mission ................................................................................................................................ 3
2.1.5. System Functions / Responsibilities .................................................................................................3
2.2. FUNCTIONAL OBJECTIVES........................................................................................................................ 3
2.3. SYSTEM CONSTRAINTS ........................................................................................................................... 4
2.3.1. User Interface Constraints ................................................................................................................4
2.3.2. Hardware Constraints........................................................................................................................ 4
2.3.3. Software Constraints.......................................................................................................................... 4
2.3.4. Communications Constraints.............................................................................................................4
2.3.5. Data Management Constraints..........................................................................................................4
2.3.6. Operational Constraints.....................................................................................................................4
2.3.7. Site Adaptation Constraints...............................................................................................................4
2.3.8. Design Standards Compliance...........................................................................................................4
2.4. OTHER CONSTRAINTS............................................................................................................................. 4
3. SYSTEM EVENTS AND DATA FLOWS.................................................................................................5
3.1. EVENT TABLE......................................................................................................................................... 5
3.2. CONTEXT DIAGRAM................................................................................................................................. 5
3.3. PRODUCT FUNCTIONS - SYSTEM ACTIVITIES ............................................................................................7
3.4. USER CHARACTERISTICS......................................................................................................................... 7
4. SPECIFIC REQUIREMENTS.................................................................................................................. 8
4.1. USE CASES............................................................................................................................................ 8
4.1.1. Use Case Scenario 1......................................................................................................................... 8
4.1.2. Use Case 1 Prototype........................................................................................................................ 8
4.2.1. Use Case Scenario 2......................................................................................................................... 9
4.2.2. Use Case 2 Prototype........................................................................................................................ 9
Springice Proprietary and Confidential ix
Product Requirements DocumentRevision History SHOUTBOX-online message board
4.3.1. Use Case Scenario 3....................................................................................................................... 10
4.3.2. Use Case 3 Prototype...................................................................................................................... 10
5. Scope for Future Work
Springice Proprietary and Confidential x
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
1. Introduction
1.1. PurposeThe SHOUTBOX-online message board, a social networking component provides the functionality of a message board, user-comment system, and a means of uploading personal messages and public discussions.
1.2. ScopeThe Social Networking component integrates the open source message board code. It also involves a master page to integrate a user login system. .It includes a nested page to post a message or comment with the date .It finally includes a nested page for viewing the message board.
ReferencesThis is a complete list of all documents referenced elsewhere in this document.
Software Engineering , Ian Sommervile, Eighth Edition
1.3. StandardsThis is a complete list of all standards used in this document.
1. IEEE 830-1993 – The content and qualities of a good Systems Requirements Specification (SRS) are described and several sample SRS outlines are presented. This recommended practice is aimed at specifying requirements of software to be developed but also can be applied to assist in the selection of in-house and commercial software products.
1.4. DefinitionsThis section contains a list of definitions for organizational specific words that are not universal.
GUI – Graphical User Interface
DB - Database
Springice Proprietary and Confidential
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
2. Overall Description
2.1. Project Abstract
Project Name: SHOUTBOX-online message board
Authors: Himica Khurana, Chaitra Sagar
Date: 10th May, 2012
2.1.1. Project Scope
An organization of any kind needs a social networking aspect that allows authenticated users to communicate with each on a dedicated forum, or post information on specific issues. This document deals with the social networking component of the organization.
2.1.2. Background
An organization needed a platform for public communication for all the users who are the part of the organization
The component will provide a social networking aspect to the website, enabling users to post on message board, or comment.
2.1.3. System Purpose Who Registered users, members of the organization Where The system will be web-based and accessible to all users. What Scope:
o The system will allow users to communicate on a public forum.o The system will not allow users to remove messages so as to keep a record of all the communication on the board.
Why Broadcasting of messages between the members makes the entire organization aware of what is happening in the organization
2.1.4. System Mission
Build a social networking component for an organization that will allow user interaction in the form of a user message board.
2.1.5. System Functions / Responsibilities
1. Message board available to all registered users to discuss issues and send messages to each other.
2. Develop and manage a login system for the web site.
Springice Proprietary and Confidential
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
3. Develop a simple and efficient search feature to find messages for a specific user.
4. Develop a simple and efficient search feature to find messages for a specific date.
2.2. Functional Objectives
1. The system shall provide a user message board, allowing users to post messages for some other user.
2. The system shall provide the ability for user to login before they are allowed to interact with the social networking aspect of the web site.
3. The system shall provide the ability for to find messages for a specific user that has been posted on the message board by any user.
4. The system shall provide the ability for to find messages for a specific date that has been posted on the message board by any user.
2.3. System Constraints
2.3.1. User Interface Constraints Using this system is fairly simple and intuitive. A user familiar with basic browser navigation skills should be able to understand all functionality provided by the system.
2.3.2. Hardware ConstraintsThe system should work on most home desktop and laptop computers.
2.3.3. Software ConstraintsThe system is designed to run on Firefox 3 and Internet Explorer 7.
2.3.4. Communications ConstraintsSystem must have access to the included database. It will be required to register new members to the organization at the backend.
2.3.5. Data Management ConstraintsSystem shall be able to interface with other components according to their specifications.
2.3.6. Operational ConstraintsThe system is limited by its operating server in terms of the maximum number of users it can support at a given time.
2.3.7. Site Adaptation ConstraintsThe component will be adapted to the overarching system at the conclusion of the system creation.
2.3.8. Design Standards Compliance The system shall be implemented in PHP. Database use is Mysql.
2.4. Other ConstraintsNone.
Springice Proprietary and Confidential
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
3. System Events and Data Flows
3.1. Event Table
Event Trigger Source Activity Response Destination
User Login Username and Password
User Profile table lookup
Session registered
Menu
Page displayed
Message Board User selects the Message Board
button
User Message Table look up
Data displayed
Message Board with sender,
receiver, date and the message
Post User selects the Post button
User Form Displayed
Message is Stored in the
DB
Form fill
Message by Date
User selects the required button
User Message Table look up
Data retrieved for specific
date
Message Board with sender,
receiver, date and the message
Message by User
User selects the required button
User Message Table look up
Data retrieved for specific
user
Message Board with sender,
receiver, date and the message
3.2. Context Diagram
Springice Proprietary and Confidential
SHOUTBOX
Message board
User User profile table
Profile data
Login information
Menu page
Profile data
Login information
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
Springice Proprietary and Confidential
SHOUTBOX
Message board
User
A page with forms
Message board database
Post page
Post information
Post information
Post data
SHOUTBOX
Message board
User
A page required information
Message board database
Display page
Information
InformationSpecific Data (user/date)
SHOUTBOX
Message board
User
A page with Message Board
Message board database
Display page
Request for messages
Message information
Link to display messages
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
3.3. Product Functions - System Activities This subsection of the SRS provides a summary of the major processes that the software will perform, which includes the system tasks and features from the Product Requirements document and Project Charter.
2.2.1 Message Board
The system provides a message board for users to post messages and comments.
2.2.2 Login
The small login menu has been relocated to the website master page. Users may log in from the front page rather than going to the forum first.
2.2.3 Search for Message for a particular date
The system provides a facility to search for messages for a particular date by taking the date as input.
2.2.4 Search for Message for a particular date
The system provides a facility to search for messages for a particular date by taking the date as input.
.
2.2.5 Search for Message for a particular user
The system provides a facility to search for messages for a particular date by taking the user as input.
3.4. User CharacteristicsProperty IQ users consist of the following:
Members of the organization who can post and read messages.
Managers who keep record of communication between the subordinates.
4. Specific Requirements
4.1. Use Cases
4.1.1. Use Case Scenario 1
User Login
Purpose Only authenticated user has the access
Actor A user with an existing profile.
Springice Proprietary and Confidential
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
Input Data Profile username and password.
Output Data Corresponding Session is registered
Invariants Profile table data and user information; user ISP.
Pre-conditions User is not logged in to a profile, input profile exists in data base, user password matches profile
Post-conditions User's computer has been supplied with appropriate cookie, page data is appropriate for selected profile
Basic Flow: Webpage looks up profile data and returns the matching record. Webpage is updated to match new user data.
Alternative Flow(s): Invalid password, invalid username, or mismatched username and password redirect to error message and previous page.
Extension Points: Extends existing profile system in message board, extends master page.
Business Rules: This allows users to log in to their profile from anywhere that hosts the master page.
Notes Further details of login process available at the Yet Another Forum documentation.
4.1.2. Use Case 1 Prototype
User login text boxes in upper right of master page. User types in profile username and password to the corresponding text boxes. User clicks login button. Database is queried for corresponding profile and returns appropriate data. The Session is registered with session id .Website is refreshed and displays page updated for specific user.
4.2.1 Use Case Scenario 2
Post Message
Purpose User posts a message for another user.
Actor A user with an existing profile.
Input Data User data, Sender, Receiver, Date, Message
Output Data Updated database with new message
Invariants User data
Springice Proprietary and Confidential
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
Pre-conditions Unfilled form , message not in database
Post-conditions Message is stored in database with all details
Basic Flow: User fills a form to post the message. Fields like sender, receiver, date and message and filled and is submitted. Database receives the data and stores it.
Alternative Flow(s): User can reset then all the fields are re-intialized.
Extension Points: Page exists within master page.
Business Rules: This allows users to post relevant messages on the website.
Notes The page supports the message-posting and storage in database. It does not sort them.
4.2.2 Use Case 2 Prototype
User navigates to menu page and selects the option to post message. User fills the displayed form. User clicks “submit” .Message is stored in database. Webpage stays to same page to post new messages.
4.3.1 Use Case Scenario 3
Property Claim
Purpose User can view message board
Actor A user with an existing profile.
Input Data User data, Message Data from database
Output Data Updated page with Message Board.
Invariants User information
Pre-conditions User is logged in as a valid profile, Message Board not shown
Post-conditions Message Board with all the messages are displayed
Springice Proprietary and Confidential
Systems Requirements SpecificationIntroduction SHOUTBOX-online message board
Basic Flow: User presses “Display” link and database is looked up. And Messages are displayed in tabular form.
Alternative Flow(s): User may cancel and close the window.
Extension Points: Page exists within master page.
Business Rules: This allows users to view the messages between different members of the organization.
Notes
4.3.2 Use Case 3 Prototype
Message Board is available in main menu page. User clicks on link while current logged in to existing account. Database is looked up to show messages. Page consists of a table showing messages and other relevant details.
ShoutBox has potential to turn into a Year Book like documentation where graduating students can leave final good-byes and adieus to their fellow mates and teachers and carry home all the well wishes with them in the form of a soft copy.
ShoutBox can be used as the social networking component of any organization, where members can communicate with each other and it is maintained as a record for future references.
Springice Proprietary and Confidential