Académique Documents
Professionnel Documents
Culture Documents
Document Prepared for Intended Audience Date of Publication Page Count Document Location Prepared From Associated Procedures Prepared by
ii
wohlwend
Revision History
Date 4/23/2009 4/28/2009 5/09/2009 Revision 1.0 1.1 1.2 Description Initial Project Description Sections: 2.1.4, 2.1.5, 2.2 Sections: 2.1.1, 2.1.2, 2.1.3, 2.2 Sections: 1.1, 1.2, 2.3, 2.4 Author Tyler Scheerens Tyler Scheerens Steve Wohlwend
wohlwend
iii
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......................................................................................................................1 2.1. PROJECT ABSTRACT....................................................................................................................................1 2.1.1. Project Scope.....................................................................................................................................1 2.1.2. Background........................................................................................................................................1 2.1.3. System Purpose.................................................................................................................................1 2.1.4. System Mission ................................................................................................................................2 2.1.5. System Functions / Responsibilities .................................................................................................2 2.2. FUNCTIONAL OBJECTIVES.............................................................................................................................2 2.3. SYSTEM CONSTRAINTS ...............................................................................................................................2 2.3.1. User Interface Constraints ................................................................................................................2 2.3.2. Hardware Constraints........................................................................................................................2 2.3.3. Software Constraints..........................................................................................................................3 2.3.4. Communications Constraints.............................................................................................................3 2.3.5. Data Management Constraints..........................................................................................................3 2.3.6. Operational Constraints.....................................................................................................................3 2.3.7. Site Adaptation Constraints...............................................................................................................3 2.3.8. Design Standards Compliance...........................................................................................................3 2.4. OTHER CONSTRAINTS..................................................................................................................................3 3. SYSTEM EVENTS AND DATA FLOWS.................................................................................................4 3.1. EVENT TABLE............................................................................................................................................4 3.2. CONTEXT DIAGRAM.....................................................................................................................................4 3.3. PRODUCT FUNCTIONS - SYSTEM ACTIVITIES ....................................................................................................6 3.4. USER CHARACTERISTICS..............................................................................................................................6 4. SPECIFIC REQUIREMENTS..................................................................................................................1 4.1. USE CASE DIAGRAM - ORGANIZED BY SUBSYSTEM..............................................................................................1 4.2. USE CASES..............................................................................................................................................2 4.2.1. Use Case Scenario <#>.....................................................................................................................2
iv Proprietary and Confidential wohlwend
4.2.2. Use Case <#> Prototype....................................................................................................................3 4.2.3. Use Case <#> Object Interaction Diagram .......................................................................................3 5. VALIDATED OBJECT MODEL...............................................................................................................4 5.1. CLASS DIAGRAM........................................................................................................................................4 5.2. CLASS SPECIFICATIONS...............................................................................................................................5
wohlwend
1. Introduction
1.1. Purpose
The Project IQ Social Networking Component provides the functionality of a message board, user comment system, and a means of uploading appraisals.
1.2.
Scope
The Social Networking component integrates the open source Yet Another Forum message board code. It also involves modification to the Property IQ master page to integrate a user login system. It includes a nested page for each property that lists forum threads about that particular property. It finally includes an appraisal hosting and uploading system.
1.3.
References
This is a complete list of all documents referenced elsewhere in this document. 1. Systems Analysis and Design in a Changing World , Satzinger, Burd, Jackson, 3rd edition. 2. The Object Oriented Approach Concepts, System Development and Modeling with UML, Satzinger, Orvik, 2nd edition.
1.4.
Standards
This 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.5.
Definitions
GUI Graphical User Interface WSID Workstation Identification Number DB - Database
This section contains a list of definitions for organizational specific words that are not universal.
wohlwend
2. Overall Description
2.1. Project Abstract
Project IQ Social Networking Component Steve Wohlwend, Tyler Scheerens, Erdem Myalcin, Kim 9 May 2009
2.1.1.
Project Scope
Property IQ will be a real estate property and foreclose tool giving users access to statistical data, maps and pictures of all real estate properties in an area, tools to help model past and future values of the property, and a social networking aspect that allows users to communicate with each on a dedicated forum, or post information on specific listed properties. This document deals with the social networking component.
2.1.2.
Background
A recent credit crisis in the United States has led to a significant increase in the number of distressed and foreclosed homes. The system being developed will provide a multipurpose tool for handling a variety of tasks associated with these properties. One component of the mashup will show static information on all properties in an area. Things like recent selling price, number of bedrooms, and other commonly available information. A second component will gather all GIS data and pictures associated with a home, including providing a tool to locate other properties sold in the area. The third component will provide trends data on the future price of the home based on information gathered by the statistical data group and an in house developed formula. The fourth group will provide a social networking aspect to the website, enabling users to post on real esate-related message boards, or comment and attach information on specific properties.
2.1.3.
System Purpose
Who Mortgage brokers, real estate agents, prospective home buyers Where The system will be web-based and accessible to all users. What Scope: o The system will be responsible for providing up to date information on all properties in an area and allow users to communicate on general topics or specific properties. o The system will not allow users to buy and sell properties on the site. Why A credit crisis in the United States has led to a high number
Proprietary and Confidential 1
wohlwend
2.1.4.
System Mission
foreclosure mashup that will of a user discussion board, a topics dedicated to specific about that property can be
Build a social networking component for a real estate and allow user interaction with the real estate system in the form property listing service, and the ability for users to post properties where information like pictures and appraisals posted.
2.1.5.
1. Discussion board available to mashup users to discuss relevant real estate and foreclosure topics. 2. Listing resource where users can list or begin discussions about specific properties. This aspect will also list information available from other components of the mashup that are relevant to the specific property (hard data, maps, and price models). 3. The ability to attach appraisal information to a specific property. That appraisal information will be shared with the trends component of the mashup to make better price projections on a given property. 4. Develop a simple and efficient search feature to find topics and information on specific properties. 5. Develop and manage a user registration and login system for the web site.
2.2.
Functional Objectives
1. The system shall provide a user message board, allowing users to post real estate related discussion topics on the site. 2. The system shall provide the ability for users to post topics on specific properties, allowing users to request information on said property, post images and other related data, and discuss the property with other users. 3. The system shall provide the ability for users to register and login before they are allowed to interact with the social networking aspect of the web site. 4. The system shall provide hosting for and the ability to upload appraisal documents for appropriate users.
2.3.
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 Constraints
The system should work on most home desktop and laptop computers.
2 Proprietary and Confidential wohlwend
2.3.3.
Software Constraints
2.3.4.
Communications Constraints
System must have access to the included database. Other components of the Property IQ system may require access to certain data and web services; refer to those components' documentation for details.
2.3.5. 2.3.6.
System shall be able to interface with other components according to their specifications.
The 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.
The component will be adapted to the overarching system at the conclusion of the system creation.
2.3.8. 2.4.
None.
Other Constraints
wohlwend
Note that unmodified message board actions are omitted and oversimplified. yetanotherforum.net for detail about those operations. Event User Login Trigger Username and Password PDF file Source User Activity Profile table lookup File placed on website Response Cookie provided to user Link placed in appraisals tab
Destination User data displayed on front page New appraisal file listed and available for download Topic data displayed Post data displayed
Appraisal Upload
User
Topic Creation
Post data
User
Topic data added to forum page Post data added to topic page
Forum Post
Post data
User
3.2.
Context Diagram
Login information Profile data User profile table
User
Login information
wohlwend
Appraisal table
PDF file
Topic information
Topic information
Topic page
Post information
Post information
wohlwend
3.3.
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 2.2.2 Message Board The system provides a message board for users to post real estate discussions. Topic Posts Tied to Properties Topics may be linked to a particular property, causing that propertys Discussion tab to list it among its relevant topics. 2.2.3 Registration and 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.4 Appraisal Upload Properties have a tab that displays posted appraisals of that property. Owners may upload additional appraisals.
3.4.
User Characteristics
Managers who wish to perform system administration functions as well as serve as property holders. Property holders who wish to claim properties, post appraisals on them, serve as contacts for property purchases, and serve as consumers. Consumers who wish to browse property listings and post questions and answers on the forum topics.
wohlwend
4. Specific Requirements
This section of the SRS contains all the system requirements to a level of detail sufficient to enable designers to design a system that satisfies those requirements. Testers can use this section to test that the system satisfies those requirements and technical writers can create the necessary support documentation for operations and maintenance. Note: Use Cases are in priority order.
4.1.
<verb obj>
<user>
wohlwend
4.2.
Use Cases
Use Cases are requirements from the Client translated into unambiguous language. A Use Case may have multiple inputs or outputs as part of the same functional flow. A Use Case without any input or output is not valid. The detailed requirements of a Use Case tend to be extensive. For this reason, it is recommended that careful consideration be given to organizing the requirements in a manner optimal for understanding. Subcases are identical to use cases except where noted. This section provides descriptions of all the use cases devised for this system. Each use case description provides the following information:
4.2.1.
A brief description of what the user is trying to accomplish. A person or external system outside the scope of the system that triggers step one of the Detailed Description. A list of all external data needed for the use case to be performed. A list of all data produced by the use case execution. A condition which is maintained throughout the use case. This section is used to highlight assumptions made for the sake of the use case. Conditions which must hold for the use case to be applicable. It is assumed that these conditions are true prior to the beginning of the use case, and will not be true when the use case completes. Conditions which are guaranteed to hold after completion of the use case. A single, error-free path, which may contain subflows, calculations, logical structures, etc. All exception and error cases, including where/how they were triggered <<includes>> and <<extends>> cases and where they were referenced The rationale for this case, also explains exceptions and errors Any other relevant information not included in the above sections.
Pre-conditions
Post-conditions Basic Flow: Alternative Flow(s): Extension Points: Business Rules: Notes
wohlwend
4.2.2.
4.2.3.
wohlwend
5.1.
Class Diagram
The Class diagram shows the structural scope-of control- entities and relationships in the problem domain of the Object Model.
wohlwend
5.2.
Class Specifications
Class Specifications are the prose detail necessary to elaborate the definitions of each class attribute and algorithm of each class operation. <repeat for each class> Class Parent Description Attributes <attribute name> <description> <class name> <if any> <in prose>
wohlwend