Professional Documents
Culture Documents
Table of Contents
Description Page no
1.0 Introduction
1.1Purpose Purpose 1.2 Scope 1.3 Definition, Acronyms, and Abbreviations 4 1.4References References 1.5 Technologies to be used 6 1.6 Overview 3 3 5 7
2.0Overall Description
2.1Product Product perspective 2.2 Software interface 2.3Hardware 3Hardware Interface 2.4 Product Function 2.5 User Characteristics 2.6 Constraints 14 2.7 Architecture Design 2.8Use Case Model Description 2.9 Class Diagram23 23 Sequence Diagrams s 2.10 Database Design 2.11.1ER Diagram 2.11.2 Schema 8 11 12 13 16 24 29 15 8
3.0Specific Requirements
3.1 Use Case Reports 3.2 Supplementary Requirements Requirements45 44
1.2 SCOPE
The users of OCM system are:A. Guest/Anonymous. B. Registered Member (Students/Faculty). C. Moderators. D. Administrators.
A guest can just view the magazine read the articles. Every registered user has their own individual account in OCM. Moderators can manage (edit, delete and respond) the articles.
Admin has has the authority to add/delete users, grant permission to the moderators
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 Mark-upLanguage): 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 user-centered centered design and collaboration onthe World Wide
1.4 References
Object Oriented Mode Modeling and Design with UML-Michael Michael Blaha, James Rambaugh. Software Engineering, Seventh Edition, Ian Sommerville. IBM Red Books. IBM TGMC Sample Synopsis. IBM www.ibm.in/ www.ibm.in/developerworks. Java - www.sun.com Wikipedia - www.wikipedia.com Database Management Systems - Navathe.
Existing System: Registration for users Discussion forum Drawbacks: Unregistered members cannot post articles No web camera interaction Students who are inadequate with internet connection fail to experience the facilities of OCM. Aims & Aspirations: Registration for valid users. Share of knowledge by each & every individual usage. To enhance views on different articles. User reviews and feedback for articles. articles.Provides an interactive environment where students and faculties of a college colle can interact with each other
The image cannot be display ed. Your computer may not hav e enough memory to open the image, or the image may hav e been corrupted. Restart your computer, and then open the file again. If the red x still appears, y ou may hav e to delete the image and then insert it again.
Front End Client: For software applications, front end is the same as user interface. In client/server applications, the client part of the program i is s often called the front
end...Compilers, Compilers, the programs that translate source code into object code, are often composed of two parts The front end is responsible for checking syntax and detecting errors, whereas the back end performs the actual l translation into object code. The front is an abstraction, simplifyingthe underlying component by providing ding a user user-friendly friendly interface. In network computing omputing front end can refer to any hardware that optimizes or protects network traffic. It is called application front front-end end hardware because it is placed on the network's outward outward-facing facing front end or boundary. Network traffic passes through the front-end front hardware rdware before entering the network. Web Server: Web server can refer to either the hardware (the computer) or the software (the computer application) that helps to deliver content that can be accessed through the Internet. The primary function of a web server is to deliver web pages on the request to clients. This means delivery of HTML documents and any additional content that may be included by a document, such as images, style sheets and scripts. The former is primarily used for retrieving and/or modi modifying fying information from databases. The latter is typically much faster and more easily cached. They can also be found embedded in devices such as printers, routers, webcams and serving only a local network.
Data Base Server: A database server is a compute computer r program that provides database services to other computer programs or computers, as defined by the client client server model. The term may also refer to a computer dedicated to running such a program. Database management systems frequently provide database server ver functionality, and some DBMSs (e.g., MySQL) rely exclusively on the client clientserver server model for database access. Such a server is accessed either through a "front end" running on the users computer which displays requested data or the "back end" which runs s on the server and handles tasks such as data analysis and storage. In a master-slave slave model, database master servers are central and primary locations of data while database slave servers are synchronized backups of the master acting as proxies. Some exam examples ples of Database servers are Oracle, DB2, Informix, Ingres, SQL Server. Every server uses its own query logic and structure. The SQL query language is more or less the same in all the database servers. Back End: A back-end end database is a database that is accessed a by users indirectly through an external application rather than by application programming stored within the database itself or by low level manipulation of the data da (e.g. through SQL commands). commands).A back-end end database stores data data, but does not include end-user user application
10
elements such as stored que queries, ries, forms, macros or reports and the server part is called the BACK END. END Compilers, the programs that translate source code into object code, are often composed of two parts: a front end nd and a back end. Back end performs the actual translation into object code. The back end usually optimizes to produce code that runs faster.
Client Side:
Client Side(Minimum) Processor RAM Internet Explorer - Intel Pentium III or 128 MB 6 AMD-800 800 MHz Client side side(Recommended) Processor RAM Internet Explorer - All Intel or AMD - 1 256 MB 6 GHZ
11
Server Side:
RAD DB2-9.5
Server Side(Minimum) Processor RAM 1GB Intel Pentium III or 256 MB AMD-800MHz 800MHz
RAD DB2-9.5
Server Side Side(Recommended) Processor RAM 2 GB All Intel or AMD AMD-2 512 MB GHZ
The function of the Online college magazine is to provide an interactive environment where students and faculties of a college can post and read various articles and providing a way to share their ideas and doubts which helps the students to enhance their view views s on different aspects.
12
13
2.6 Constraints:
GUI is only in English. Login and password is used for the identification of users. Only registered Students and faculty will be authorized to use the services. Limited to HTTP/HTTPS. This system is working for single server. Secure access of confidential data (users details). SSL can be used. 24 X 7 availability Better component design to get better performance at peak time Flexible ble service based architecture will be highly desirable for future extension
14
15
update profile
view profile
search an article
student login
download article
file complaint
admin
16
Usecase Login View profile Update profile View articles Post articles Respond to article Search an article Download An Article File complaint Withdraw complaint Give feedback
Description The user has to login in order to. Every reg. user has his his\her her own profile in OCM. The user can update his his\her profile. The user can view all posted articles. The user can post the article to OCM. The User can rate, comment and can give feedback on an article. The User can search for an article. The User can download the posted articles. The user can file a complaint to admin. The user has option to withdraw the complaint. The user can give feedback regarding OCM OCM.
17
Moderator:
update profile
manage articles
<<include>>
send to
18
Use case Login View profile Update profile Manage reg. members Manage articles
Description The moderator has to sign sign-in in in order to begin his work. Every moderator has his his\her own profile containing their details (person (personal/professional). The moderator has an option to update his profile. The moderator can manage the register users. The moderator can manage (add/remove) the posted articles articles.
Add\Remove reg. The moderator has the right to add/remove remove the reg. users. users Read & Post The moderator can read the articles and can post the articles articles. Search Generate reports Send to The moderator can search the articles articles\members members in OCM. The moderator generates OCM statistics. The moderator sends reports to the admin.
19
Guest:
search articles
read articles
download articles
Description The guest has to first enter OCM site. The guest can search an article. The guest can read the articles
20
The guest can like/comment comment on the articles. The guest can download the articles in different formats.
Administrator:
Publish to homepage
admin
Backup data
Search
21
Use case Login View profile Update profile Generate reports Publish to homepage Manage articles Manage reg. user Select moderator Backup data Search Read & post articles View feedback Take action
Description The admin has to login to begin his work. The admin can view his/her profile. The admin can update his/her profile. The admin generates reports on OCM. The admin publishes the reports on OCM on home page The admin can manage (add/remove) the posted articles. The admin can manage (add/remove) the reg. members. The admin can select & set the moderator privileges to the user. The admin can backup the entire OCM data. The admin can search the articles articles\members members in OCM. The admin can read the articles and can post the articles. The admin can view the feedback given by users. The admin can take an action on the feedback.
22
Reply to feedback
student name age year branch mob no sex email_id student_id_name password
faculty name experince sub department mob no sex email_id faculty_id_name password
23
User PromptForLogin()
Interface
OCM database
Verify()
[Success]
Forward() Verify
DisplayHomePage()
OnSuccess()
EnterUserNameandPassword()
24
User
Interface
OCM database
PromptToSerachArticle()
DisplayResults()
25
User
Interface
Admin
SendRequestToAuthenticate()
Forward() Check()
[Success]
Display()
AuthenticateAsModerator()
[Failure] Display()
Reject()
26
User
Interface
Admin
Database
PromptToSelectCategory()
27
User
Interface
Admin
Database
PromptToSelectCategory()
28
2.10.1ER ER diagram:
29
2.10.2 Schema Activity diagrams User-Registration: Registration: Initially user is made to enter collegeID, emailID/mobilenumber number in the registration form, and submitted to the admin/moderator, and then verification fication code is sent to mobile number/email email ID if valid and rejected if the college ID is invalid. . The user is then allowed to enter the user name, if it is already exists, then thenthe the user is takenback to change the username. If the username is unique then it checks for password and remaining mandatory fields. If any of the mandatory ndatory field is left empty or filled or incorrect, then the user is informed to enter the correct values. Once all these verification are succeeded, then the reg. is done.
30
Reject
enter details
Not valid
Not valid
Accont created
31
User login:
The user has to enter his user name and password password. (If it is valid) valid then he is asked to enter his unique OCM_ID. The entered details are thus verified and if they are valid the user is logged in and the user home page is displayed. Else they are asked to renter the correct values.
32
valid
Privileged login:
33
Privileged ivileged users here are the administrator and the moderator of OCM.They They are supposed to enter the username and password, entered values are then verified.If the entered username and password are valid then the user is logged in and assigned the desired privileges vileges or else they are asked to retry by entering the correct values.
Not valid
Valid
34
From the home page the user search for an article on the respected topic, if there are no results then asked to renter the right key word to search. If found results are shown, then the required article is read and it can be given comment/rating/like according to users wish it can also be downloaded.
35
Search engine
Search a topic
Not found
Read article
Comment/rate/like
Download
36
Posting article:
User has to enter the relative category in which c category ategory they want to post the article is then uploaded that is verified by admin/moderator if the article is accepted then the admin/mod has to send a mail notifying the acceptance of the article, or else they need to send the reason for the rejection of a article rticle to the user. The accepted article is then published on the home page of OCM
37
Enter category
Upload article
Verification by admin/moderator
Reject
Article published
38
Give feedback: User enters the complaint text and sends it to the admin and a complaint_id is generated and returned to the user user.
send to admin
generate complaint id
39
Reply to feedback: :
The admin views the feedback lodged by the user and then he may reply to the user directly or he may select the respective moderator and forward the complaint to him.
reply to user
select a moderator
forward to a moderator
40
The administrator views the registered members who sent the request for being a moderator and then he selects the desired user and gives him the privileges of the moderator.
admin
set privilages
41
Request to admin for moderator rights: The registered user forwards the request to the administrator. The admin verifies the details & accepts or rejects the approver, if he is accepted he is provided with the privileges of a moderator or else he gets rejected.
42
43
A use case is used to define a series of interactions between external actors (the users or another system) and the system in question (your piece of software). The use case always focuses on a goal, and it ends when this goal is completed. com Besides the main series of interactions, it can also include alternative versions (other series of interactions that will fulfil the goal) and versions that will cause failure. In the end, it will give you a very clear sequence, written in natural language, easy to understand. You can move on by taking a "snapshot" of a use case, called a scenario which is one specific instance of the use case one single path that takes you from the beginning to the end, selected from the various paths and combinations nations available to fulfil the goal.
Use cases are the basis for creating patterns, or you can organize them into diagrams in many cases, a better alternative to long text in natural language. They are a good tools of each requirement and its current s status.
44
Once you have a use case, you need to make sure that it is indeed important, not one of the useless conditions that crowd your project, even if nobody can remember where they originated. A very simple and effective method, called Quality Function Deployment eployment (QFD) will help you identify which are the most important options for the client, and which can be eliminated. Give users (or user surrogates) a list of the use cases and a certain number of points (or a sum of cash, to make it even easier to und understand) erstand) to assign to the use cases, in order of the importance. Make sure you include all the types of users (every group of actors involved), otherwise it's not relevant. In some cases, you may need to organize a hierarchy of the groups of actors for instance, nstance, give more points (or cash) to the group that is likely to use the program more often than the rest. Balance the number of points obtained by each function against the costs of developing it. After that, the results are pretty obvious and easy to interpret.
3.2 Supplementary Requirements Requirements: To enhance the existent features of the project we require the followingSupplementary requirements requirements: User friendly Upgraded configuration with suitable graphic content Compatible with existent spyware & fire fire-wall
45
46