DOC

Software Design Specification

By Marion Ruiz,2014-04-14 06:06
12 views 0
27 Apr 2008 High-Level Design. Web Site Map. The presentation layer will be implemented by using HTML content-enabled PHP files.

Simple Software Solutions

    Software Design Specification

    for the Exterminator Locator Project

University of Maryland University College

    SWEN670

    Last Updated April 14, 2010;

    Prepared By:

    Vivek Shah

    Josh Hanson

    Monica Langley

    Sarah Hamilton

    Simple Software Solutions: “Synergetic Erudition”

    Change History

    Name Date Reason For Changes Version Vivek Shah 3/08/2008 Initial Creation 1.0 Vivek Shah 3/14/2008 Added updated use cases 1.1 Monica Langley 3/16/2008 Added purpose, intended audience, system 1.2

    architecture text, data structure design section, and

    help section

    Vivek Shah 3/14/2008 Added additional workflows 1.3 Sarah Hamilton 3/18/2008 Formatting, grammar, scope, started intro 1.4 Vivek Shah 3/18/2008 Added Database Design Specifications 1.5 Vivek Shah 3/20/2008 Updated based on 3/18 group review 1.6 Sarah Hamilton 3/21/2008 Changed Quickbooks to QuickBooks, added in 1.7

    assumptions, improved intro

    Vivek Shah 3/24/2008 Updated introduction, methodology, system 1.8

    environment and design sections with use of

    AccessBooks RealTime Plus

    Sarah Hamilton 3/25/2008 Minor Formatting 1.9 Josh Hanson 3/25/2008 Formatting and updated System Architecture 2.0 Vivek Shah 3/26/2008 Added web site map 2.1 Sarah Hamilton 3/27/2008 Updated TOC, list of figures, typos 2.2 Vivek Shah 3/27/2008 Added ERD diagram 2.3 Vivek Shah 3/28/2008 Updated workflow and web site map 2.4 Josh Hanson 3/29/2008 Added class diagram and additional sequence 2.5

    diagrams

    Vivek Shah 3/29/2008 Removes tables section and minor updates to 2.6

    workflow

    Sarah Hamilton 3/29/2008 Verified formatting and grammar 2.7 Josh Hanson 3/30/08 Verified correctness 2.8 Sarah Hamilton 4/10/2008 Incorporated Peer Review comments 2.9 Vivek Shah 4/10/2008 Updated architecture diagram 3.0 Sarah Hamilton 4/13/2008 Turned off track changes 3.1 Sarah Hamilton 4/25/2008 Added Implementation changes 3.2 Vivek Shah 4/26/2008 Updated use cases and workflow 3.3

    Software Design Specification v3.3 Page 2;

    Simple Software Solutions: “Synergetic Erudition”

    Table of Contents

    1. Introduction ..................................................................................................................................... 5 1.1 Purpose ........................................................................................................................................ 5 1.2 Intended Audience ....................................................................................................................... 5 1.3 Project Scope ............................................................................................................................... 5 1.4 References .................................................................................................................................... 6 2. Design Considerations .................................................................................................................... 6 2.1 Assumptions ................................................................................................................................. 6 2.2 Design Methodology .................................................................................................................... 6 2.3 System Environment ..................................................................................................................... 7 3. Workflow Analysis .......................................................................................................................... 7 3.1 High-Level Use Cases .................................................................................................................. 7

    3.1.1 Customer Focused Use Cases: ................................................................................................ 7

    3.1.2 System Administrator Focused Use Cases: ............................................................................. 9

    3.2 Use Case Scenarios....................................................................................................................... 9

    3.2.1 Customer View Information ................................................................................................ 9

    3.2.2 Customer Request Service ................................................................................................ 10

    3.2.3 Customer Manage Account ............................................................................................... 10

    3.2.4 System Administrator Login / Logout ............................................................................... 13

    3.2.5 System Administrator Update Customer Information......................................................... 14

    3.2.6 System Administrator Access GPS Tracking Web site ...................................................... 15

    3.2.7 System Administrator Update Services ............................................................................. 16

    3.2.8 System Administrator Update to Informational Pages ....................................................... 16

    3.2.9 System Administrator Admin Tasks .................................................................................. 16

    4. System Architecture ..................................................................................................................... 17 5. High-Level Design......................................................................................................................... 18 5.1 Web Site Map ............................................................................................................................ 18 5.2 Data Structure Design................................................................................................................. 19

    5.2.1 Entity-Relationship Diagram................................................................................................ 20

    5.2.2 Database Model ................................................................................................................... 21 6. Low Level Design .......................................................................................................................... 24

    6.1.1 PHP Class Diagram ............................................................................................................ 24

    6.1.2 Basic Request Sequence Diagram ........................................................................................ 24

    6.1.3 Database Data Dictionary .................................................................................................... 31 7. User Interface Design ................................................................................................................... 34 7.1 Sample Web site Layout Selected by Client ............................................................................... 34 7.2 UI Mockup for Update Customer Information ............................................................................. 35

    7.3 UI Mockup for View Customer Payments ................................................................................... 36 7.4 Help System Design ................................................................................................................... 36

     Appendix A: Acronyms, and Abbreviations ................................................................................. 37

     Appendix B: Issues List ................................................................................................................... 38

    Software Design Specification v3.3 Page 3;

    List of Figures

    Figure 1: Customer/Guest focused Use Cases ................................................................................ 8

    Figure 2: System Administrator focused Use Cases....................................................................... 9

    Figure 3: Physical Server and Data Location ............................................................................... 18

    Figure 4: Amazon Pest Control Web site Map ............................................................................. 19

    Figure 5: Replication of QuickBooks data via Automatic Synchronization.............................. 20

    Figure 6: ERD Diagram for Amazon Pest Control Solution ...................................................... 21

    Figure 7: Amazon Pest Control Online Database Design Model ............................................... 23

    Figure 8 - PHP Class Diagram ........................................................................................................ 24 Figure 9: Basic Webpage Request Sequence Diagram ................................................................ 25

    Figure 10 New Account Request Sequence Diagram ................................................................ 26

    Figure 11- Service Request Sequence Diagram ............................................................................ 27

    Figure 12- Customer Account Content Modification Sequence Diagram ................................ 28

    Figure 13- Customer Payment Sequence Diagram ...................................................................... 29

    Figure 14- Admin System Summary Request Sequence Diagram ............................................. 30

    Figure 15- Admin Customer Account Information Request Sequence Diagram .................... 31

    Figure 16: Client selected Web site Layout and Color Coordination........................................ 34

    Figure 17: Mock-up of View Customer Update Requests ........................................................... 35

    Figure 18: Mock-up of View Customer Payments........................................................................ 36

    List of Tables

    Table 1: tbleAccountPayments ........................................................................................................ 32 Table 2: tbleServiceRequests........................................................................................................... 32 Table 3: tblRequestStatus ................................................................................................................ 32 Table 4: tbOnlineUsers..................................................................................................................... 33 Table 5: tblCustomerInfoRequestUpdate ..................................................................................... 33

    Table 6: tbleServiceFreq .................................................................................................................. 33 Table 7: tbleServiceType.................................................................................................................. 33 Table 8: tbleQuickBooksReplicationHistory ................................................................................. 34

    Simple Software Solutions: “Synergetic Erudition”

    1.Introduction

    This document contains the design information required for implementing the Exterminator Locator Project.

    The Exterminator Locator Project is a web site for Amazon Pest Control Company of Henderson, NV. The

    web site will be developed in a Linux environment and hosted by GoDaddy.com, Inc.

    (http://www.godaddy.com). The QuickBooks software resides on the personal computer owned by the Amazon Pest Control System Administrator. The design utilizes off-the shelf components to minimize the

    development effort. They also provide our client a better way to maintain the web site after initial

    development is completed.

    1.1Purpose

    This document, adapted from IEEE 1016-1998 to better suit an object-oriented development process, presents

    3the Software Design Document (SDD) for Simple Software Solutions (S) Exterminator Locator Project. The

    purpose of the SDD is to document the approach for construction of the system presented in the Project

    Management Plan and Software Requirements Specification (SRS).

    1.2Intended Audience

    The SDD is a key technical document intended as a reference by everyone involved in the actual creation and

    3maintenance of the software. This group includes S and the maintenance organization. The document

    attempts to capture the information needed by each of these groups to perform their function. If desired, the

    stakeholders and client of the project also have access to the SDD.

    1.3Project Scope

    The scope of the system is limited to the web site software. The prime deliverable will be the Amazon Pest

    Control web site. The following functionality is required for the web site:

    ? Information about company and services

    ? Price list

    ? Customer Contract

    ? Customer request for service

    ? Customer pay online

    ? Customer‟s ability to view account history

    ? Web link to Fleet Locate for GPS tracking of company vehicles

    Software Design Specification v3.3 Page 5;

    Simple Software Solutions: “Synergetic Erudition” 1.4References

    IEEE 1074-1997, IEEE Standard for Developing Software Life Cycle Processes. Institute of Electrical and

    Electronics Engineers, 1997

    Simple Software Solutions, Organizational By-laws, February 2008

    Simple Software Solutions, Project Management Plan, February 2008

    Simple Software Solutions, Risk Management Plan, February 2008

    Simple Software Solutions, Software Requirements Specification, March 2008

    2.Design Considerations

    2.1Assumptions

    ? The client will provide a computer operating system for the web site

    ? The client will provide an internet provider for hosting the web site

    ? The client will provide remote access to Amazon Pest Controls web hosting account for installation of

    the software. S3 will help Amazon Pest Control to acquire a web hosting company.

    ? The client will provide copies of the software currently in use for incorporation into the web site.

    3? The client shall purchase a digital certificate for securing login and account activities. S will help

    Amazon Pest Control to acquire the Digital Certificate.

    ? The QuickBooks software can interact with other software to update the customer database between

    the web site and QuickBooks

    ?3 Amazon Pest Control will supply a copy of QuickBooks and the associated database to S

    ? Amazon Pest Control will install AccessBooks RealTime Plus edition on the client PC running

    QuickBooks and maintain it.

    2.2Design Methodology

    The design document utilizes the workflow analysis method to decompose requirements and getter better

    understanding of the interactions that the user will have with the system. This document will provide all

    relevant design elements used in constructing the system, to include use-case analysis, data structures,

    database design, sequence diagrams, E-R diagrams, etc.

    Software Design Specification v3.3 Page 6;

2.3System Environment Simple Software Solutions: “Synergetic Erudition”

    The solution for the Amazon Pest Control will primarily reside in the web site hosting location at

    GoDaddy.com, Inc. The web site hosting requirements are as follows:

    ? AmazonPestControl.com domain registration

    ? Dedicated Hosting Service on Linux Environment using a virtual dedicated server

    ? SSL Certificate

    ? MySQL Database Instance

    The web site utilizes data exported from the client’s QuickBooks data file. Because the QuickBooks application and data file are installed on the client’s computer, the data will be accessed via a third-party

    application and synchronized via manual execution with the online replica of the QuickBooks data file. The

    client is required to install the AccessBooks RealTime Plus addition to access the QuickBooks data file,

    which has following requirements

    ? QuickBooks 2008 installed on the client PC

    ? Access to MySQL database

    ? MySQL Connector/ODBC 3.51

    The System Architecture Section (4) provides details on the system environment.

    3.Workflow Analysis

    3.1High-Level Use Cases

    The use cases are classified into two categories: the customer focused use cases and the system administrator

    focused use cases. Then the use cases are grouped together as scenarios to combine similar activities together.

    3.1.1Customer Focused Use Cases:

Software Design Specification v3.3 Page 7;

    Simple Software Solutions: “Synergetic Erudition” Services and Prices

    Check Service Area

    Local Insects

    View Frequently InformationAsked Questions

    Amazon Pest Control VideoRequest ServiceLogin / LogoutPassword Change / Reset

    Manage Request Online AccountAccountCustomer / Guest

    View/Update Account Details

    Pay for Service

Figure 1: Customer/Guest focused Use Cases

    Software Design Specification v3.3 Page 8;

    Simple Software Solutions: “Synergetic Erudition”

3.1.2System Administrator Focused Use Cases:

    Login / LogoutView / Update Customer Details

    Update Apply PaymentsCustomer Information

    View Service Requests

    Access GPS Tracking Website

    Update Service Area

    Update Update Informational ServicesFAQs, Help, Local PagesInformation, HomepageSystem Administrator

    Update Services and Prices

    Admin Tasks

    Unlock Account,Create Account

Figure 2: System Administrator focused Use Cases

3.2Use Case Scenarios

    3.2.1Customer View Information

    Use Case User clicks on View Services and Prices link Scenario View Information

    Approach User clicks on View Services and prices link

    Input: None

    System loads the web page with services and prices.

    List of services and prices are loaded from a data file and embedded in the web page.

    Alternatives None

    Use Case User clicks on View Frequently asked questions Scenario View Information

    Approach User clicks on view frequently asked questions link

    Input: None

    System load the web page with frequently asked questions.

    List of frequently asked questions are loaded from a data file and embedded in the web page.

    Alternatives None

Software Design Specification v3.3 Page 9;

Use Case View information about local insects Simple Software Solutions: “Synergetic Erudition”

    Scenario View Information

    Approach User clicks on view frequently asked questions link

    Input: None

    System loads the web page with local insect information. Alternatives None

Use Case View video about Amazon Pest Control

    Scenario View Information

    Approach User clicks on view video about Amazon Pest Control

    Input: None

    System loads the web page with video file embedded. Alternatives None- This requirement is optional and will not be implemented at this time

Use Case Verify address is within service area

    Scenario View Information

    Approach User click on check service area link on the web site

    Input: ZIP code

    System looks up list of zip codes

    System reports back if the address falls within the Service Area Alternatives None

3.2.2Customer Request Service

    Use Case Make service request

    Scenario Request Service

    Approach User clicks on make service request link

    System displays service request webpage

    If user is logged-in, system pre-populates the form.

    Input:

    ? First Name

    ? Last Name

    ? Address (Street, City, State, Zip)

    ? Phone number (Home and Alternate)

    ? E-Mail Address

    ? Square Footage of house

    ? Treatment Service Desired

    ? Service Frequency (one time, monthly, bimonthly)

    ? New customer or returning customer

    ? Referral information if new customer

    ? Special request from customer

    ? Customer's desired appointment preference day

    System verifies that all required fields are filled-in

    System verifies that address falls with-in service area

    System sends acknowledgement e-mail to customer Alternatives If user has not filled-in all required fields, the system displays error message

    If user‟s service area falls outside service area, user is informed such.

3.2.3Customer Manage Account

    Use Case Customer Login

    Scenario Manage Account

    Software Design Specification v3.3 Page 10;

Report this document

For any questions or suggestions please email
cust-service@docsford.com