Design Document Template (OOAD) by W7u5JOM6

VIEWS: 37 PAGES: 11

									Web Enabled Social Service Activities
               for
        Manavata Mission

      Object Oriented Design Document
                <Project ID-OOD>


                   Version 1.0




                       Service to Man is
                       Service to God




                     www.manavata.org




           Viswa Manavata Samsta
         Service to Man is Service to God
        16-11-19/5, Saleem Nagar, Malakpet
     Hyderabad - 500 036, Andhrapradesh, INDIA
          Web: http://www.manavata.org
Manavata.org




                      Web Enabled Social Service Activities
                                     for
                              Manavata Mission


                               Object Oriented Design Document
                                        <Project ID-OOD>

                                          Version 1.0




                         Prepared by:           Reviewed by:              Approved by:
  Name:                  Srinivasa Chowdary
  Designation:
                          th
  Date:                  5 April 2003

                                    VERSION HISTORY

Version        Date     Changed                            Changes Made
  No.                     By
                                                                                                                                                       th
Manavata.org                                                                                                                                         5 April 2003



                                                                Manavata.org
                                                   Object Oriented Design Document

                                                                Table of Contents

Topic                                                                                                                                                       Page
No.


INTRODUCTION ..................................................................................................................................................4
PURPOSE ...............................................................................................................................................................4
SCOPE ...................................................................................................................................................................4
DEFINITIONS AND ACRONYMS ..................................................................................................................................4
TOOL(S) USED ........................................................................................................................................................4
REFERENCES ..........................................................................................................................................................4
ASSUMPTIONS ........................................................................................................................................................4
SYSTEM ARCHITECTURE ..................................................................................................................................4
CONVENTIONS AND STANDARDS FOLLOWED ............................................................................................................5
IMPLEMENTATION DIAGRAMS ...................................................................................................................................6
LOGICAL DESIGN.....................................................................................................................................................7
DESIGN CONSIDERATIONS AND CONSTRAINTS ..........................................................................................................8
DATA DESIGN .....................................................................................................................................................9
DATABASE TABLE/ FILE RECORD LAYOUTS ............................................................................................................10
DATABASE/FILE SPACE REQUIREMENTS (OPTIONAL) ..............................................................................................10
PROJECT CONVENTIONS, PRACTICES AND PARAMETERS (OPTIONAL) .....................................................................10
SCREENS AND REPORTS ...............................................................................................................................10
USER INTERFACE SCREEN LAYOUTS ......................................................................................................................10
REPORT LAYOUTS.................................................................................................................................................10
DETAILED DESIGN ...........................................................................................................................................10
DESIGN ELEMENTS ...............................................................................................................................................10
TRACEABILITY .......................................................................................................................................................11




Manavata.org Design / Ver No.1.0                                                                                                                     Page 3 of 11
                                                                                              th
Manavata.org                                                                                5 April 2003



Introduction

Purpose
The purpose of this document is to provide the following information on objectives of the system/sub-
system being designed
     Functional requirements overview
     Physical / Logical design of the system / sub-system
     High level & detailed level architecture of the system

Scope
The scope of the system being built is:

       Member Registration
       Member Management
       Blood Donor Database
       Search for members /donors / organizations
       Keyword search with in website
       Eye donor pledge
       Admin & General
       KTG
       Voluntary Organization
       Message broad casting

Definitions and Acronyms
The following are the terms, acronyms and abbreviations used in this document: <Give
explanation for the terms/abbreviations/acronyms used, if any>

                            Term/Acronym          Explanation




Tool(s) Used
The following tool(s) are used in producing the details of this document:
                         < Specify tools being used. e.g., Tool for design diagrams, database
                         design >

References
URD for Manavata 1.0

Assumptions
<Specify any assumptions made in arriving at the design details. Otherwise mention "None" >.

                            <Note: It should not include open issues since they ought to be
                            clarified by the customer. It should contain factors or issues on which
                            there is agreement and form the basis for the design. For example,
                            one key assumption in designing a HR system could be that an
                            employee reports to only one manager. >
System Architecture

Manavata.org Design / Ver No.1.0                                                             Page 4 of 11
                                                                                       th
Manavata.org                                                                          5 April 2003




Conventions and Standards Followed

UML notation is to be followed as a standard for representation of the modeling elements.
The other standards and naming conventions followed are:

Implementation Diagrams
[Component and Deployment diagrams are used to represent implementation of the system.
These two diagrams together or individually can be used to represent implementation of the
system.]
Below diagram shows the implementation of the system. All the html, jsps, servlets will be
hosted in the web server. Database server will have the connectivity from web server with in
LAN. Using JDBC connectivity, the web application will access database. All the mails / smtp
requests will be routed through the SMTP server.


            web
            Client




        Web Server
     /Application Server
                                              SMTP
                                              Server




          Database
           Server




Manavata.org Design / Ver No.1.0                                                      Page 5 of 11
                                                                                                th
Manavata.org                                                                                   5 April 2003



High level architecture


                                                             Web Server / Application Server
                Web                Internet
                Client                                             Presentation Layer
                                              HTTP request          JSPs / Servlets


                                                                     Business Layer
                                                                   Java Beans / EJBs


                                                                     Database Layer
                                                                         JDBC
        For all HTML requests web server responds              Oracle Database Server
        JDBC connectivity: For all database requests
         will processed using JDBC connectivity.
         Connection parameters will be taken from a
                                                                       Manavata
         configuration file (Manavata.cfg).
                                                                       Database
        SMTP server configuration also will be taken
                                                                       (Oracle)
         from configuration file (Manavata.cfg


               Figure1. High level architecture of the Manavata web Application




<Give the reference/link if tool is used to generate these diagrams.>

Manavata.org Design / Ver No.1.0                                                               Page 6 of 11
                                                                                                 th
Manavata.org                                                                                  5 April 2003



Logical Design
The following is an overview of the logical design under consideration:



                                            JSP / Servlet                        Validations.js
                                                                                 Datepicker.js
                                                                                 PreloadCmb.js
      Request for DB Connection
      Parameters / SMTP server IP


                                                                Redirection
     configReader                      Database                 Page
                                                                               SendMail bean
     bean                             Connection
                                         bean
                                                                              Send Mail to
                                                                              Administrator
                                                            Error Handler
                                                            bean                        SMTP
       Manavata.cfg                                                                     Server
                                       Manavata
     (Configuration file)
                                       Database
                                       (Oracle)
                                                               Logfile




Process flow:
   1. Member Signup:
           By a click on the member signup link on the Manavata home page
           Member Enters the details on the provided registration from
           Click on the Submit/register button
           Validate entered data
           If the provided data is valid save the details else display error message and
              control transferred to the registration page -> end
           Else
                   i. get the connection parameters from configuration file
                  ii. Connect to the database
                 iii. Insert registration data into member table
                 iv. Send “Welcome Mail” to member
                  v. Commit
                 vi. Display options page
           Member selects options and clicks on submit
           Validate input data
           Insert options into member_options table
           Based on the selected options display option fields page (start from blood
              donor)
           Member will fill up the option fields page and submits for each option
           For each option field submit.. data will be saved in the database (member table)
   2. Member Login:
Manavata.org Design / Ver No.1.0                                                               Page 7 of 11
                                                                                           th
Manavata.org                                                                              5 April 2003



               Enter user id and password in the Manavata home page and click login
               Client side Validation: If user or password = null pop the message box and
                keep control in login form -> end
               Else Server side Validate: if (user id & password not matches in the database)
                pop the message box “User id or Password are wrong.. pls try again..” and
                keep the control in the login page -> end
               Else load the user home page with the options
          
    3. Forgot Password:
           By a click on the “forgot password” link on the Manavata home page forgot
              password will be displayed
           User will enter email id and submits
           Client side validation: Validate email id
           If email id available in the database send email with the corresponding user id
              and password of that email id.
           Else show the message the email id not found in the members list

    4. Member Maintenance:
            After login into Manavata, Members should able to update their details and
              should able to change the options, able to maintain their own blood donors
              group, able to see the options in Manavata, able to download the information
              which is available for members in different sections of Manavata (technology,
              yoga, health & etc), able to search members etc.
            Facility to unsubscribe
            Facility to set alerts
    5. Site Search:
            Enter key words in the search text box and click on search button
            Search the key words with in all pages of site and display results in a web page

    6. Organization

               Direct registration: <click org registration on home page>
                     i. Organization registration page will be displayed
                    ii. User enters the details and submits (including username & password)
                   iii. Create a member using contact person name (in member table)
                   iv. Insert organization details in organization table (keep the adminmember
                        as the created memberid of member table)
                    v. Commit
               Organization registration by an existing member
                       <Existing member can login and enter the organization details>
                     i. Click on organization registration
                    ii. Organization registration page will be displayed
                   iii. User enters the organization details and submits
                   iv. Insert organization details in organization table (keep the adminmember
                        as the logged in member id)
                    v. commit

                            <Provide the Three-Tier model diagram if the system is of Three-Tier-
                            Architecture. >
                            < For distributed objects, provide the details of the standards
                            (CORBA / DCOM) and the implementation method >
                            < State the details of object visibility in distributed environment >
Manavata.org Design / Ver No.1.0                                                          Page 8 of 11
                                                                                       th
Manavata.org                                                                          5 April 2003



Design Considerations and Constraints
The following are the considerations and constraints taken into account while preparing this
document:
                       < State all the known limitations of the design. The likely factors may
                       be some of the following:
                        error handling
                        the policy through which security checks and controls are
                          established
                        on-line response times
                        availability of the proposed system
                        permissible system down time
                        performance reporting
                        memory requirements
                        volume considerations
                        other limitations and considerations >
Data Design




Manavata.org Design / Ver No.1.0                                                      Page 9 of 11
                                                                                          th
Manavata.org                                                                             5 April 2003



Database Table/ File Record Layouts
<Provide the following information in this sub-section>
 Physical table / Record layouts
 Primary / Foreign keys and indexes
 Definitions of views provided into the database layouts.>
Refer manaTableScripts01June2003.txt file for data model.

Database/File Space Requirements (Optional)
< This is an optional sub-section and may not be applicable to all projects.
If not applicable, indicate as “Not Applicable”
Or else, specify the following :
 the space required to store all databases and files
 location for tables / indexes / logs. >

Project Conventions, Practices and Parameters (Optional)
< This is an optional sub-section and may not be applicable to all projects.
If not applicable, indicate as “Not Applicable”
Or else, specify:
 the system parameters, which would be common across the project. For example, screen
     headers, titles, start-up procedures, common codes etc.
 the following details, if relevant to the needs of the project:
     Existing Production data files / tables used
     Modifications required on existing production data files / tables
     New data files / tables created. >


Screens and Reports
User Interface Screen Layouts
< In this sub-section, specify the information on elaborated layouts of all the screens that form
part of the system. This is over and above those that are mentioned in the SRS. Traceability to
the SRS needs to be established.>


Report Layouts

< In this sub-section, specify the information on elaborated layouts of all reports that would be
generated by the system. This is over and above those that are mentioned in the SRS.
Traceability to the SRS needs to be established. >


Detailed Design
Design Elements
<Specify the details of each design element in the following format>

 Design Element ID:                     Design Element Name:
 <Specify unique numeric identifier for <Specify a concise, self-explanatory name for the
 the Design Element. This ID is to be Design Element>
 used for establishing traceability to

Manavata.org Design / Ver No.1.0                                                        Page 10 of 11
                                                                                             th
Manavata.org                                                                                5 April 2003



 SRS and from Integration test cases>

 Description:                 <Provide a brief description of the design element, and a reference to
 Note: A bookmark may         a document containing the detailed description or provide a high-level
 be introduced here to        description of the design element. >
 hyperlink from the
 corresponding
 modeling element
 generated using
 Rational Rose.
 Classes:                     <Name the Classes participating in the design element. >

 Method                       <Detail the method specifications for each of the classes in this design
 Specifications:              element>


Traceability
This matrix establishes traceability from the design features and the detailed modeling
elements to the Software Requirements Specifications (SRS) and the technical modeling
elements


 System Feature IDs in SRS /
 Technical modeling elements                Design Element IDs / Detailed modeling elements




Manavata.org Design / Ver No.1.0                                                           Page 11 of 11

								
To top