Janssen, 2013 - WordPress.com

advertisement

ITECH 7602 – PROJECT 04/09/2013

“TrueTenants.com.au”

Software Design Document

Submited to : Mr. Ahmad Saeed

Done By : Ayman Chalak 30099129

Ding Wei 30084142

Grigory Punanov 30099435

Pavel Semiklit 30102364

Xiaofei Li 30117218

ITECH 7602 – PROJECT 4/09/2013

Table of Contents

1.

Document Details .......................................................................................................................... 4

2.

Purpose ........................................................................................................................................... 4

Moreover, it focuses on detailing a low-level view of each component of the software and how the components interact with each other.

.................................................................................................. 4

3.

Version History ......................................................................................................................... 4

4.

Approvals ....................................................................................................................................... 4

5.

Distribution .................................................................................................................................... 5

6.

Project Objective ........................................................................................................................... 5

7.

Project Scope ................................................................................................................................. 5

8.

Project Team Details ..................................................................................................................... 5

9.

System Context Diagram .............................................................................................................. 6

9.1 Definition ..................................................................................................................................... 6

9.2 System interaction with external system using the system Context diagram ........................ 6

10.

Description and Justification of chosen methodology for project ........................................ 7

10.1

SDLC ...................................................................................................................................... 7

10.2

PMBOK ................................................................................................................................. 7

10.3

Programming Languages ..................................................................................................... 8

10.4 Project management Tools ....................................................................................................... 8

10.5 Document Management ............................................................................................................ 8

10.6 Image/Graphical Manipulation Software ............................................................................... 8

10.7

Database Management Software ......................................................................................... 8

10.8 Presentation Software ............................................................................................................... 9

11 Stakeholders .............................................................................................................................. 9

11.1 Project Team ............................................................................................................................. 9

11.2 Project guidance ........................................................................................................................ 9

11.3 Users ........................................................................................................................................... 9

12. Architecture Design ...................................................................................................................... 10

12.1 Detailed storyboards/ GUI design ......................................................................................... 10

12.1.1

Homepage ............................................................................................................................ 11

12.1.2

Registration and Login process.

............................................................................................ 13

12.1.2.1 General process ................................................................................................................. 13

12.1.2.2 Tenants ............................................................................................................................... 14

12.1.2.3 Landlords ........................................................................................................................... 15

12.1.2.4 Agents ................................................................................................................................. 16

1

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12.1.3

Creating Rented Property Reviews (created by tenants) and Listed Property Adds

(created by landlords) ......................................................................................................................... 16

12.1.3.1

Rented Property Review (created by tenants) .......................................................... 16

12.1.3.2 Landlords ........................................................................................................................... 18

12.1.3.3 Agents ................................................................................................................................. 19

13 Tenants section ........................................................................................................................ 20

13.1 Tenants section main page ..................................................................................................... 20

13.2 Search results for Tenants Comments. Property profile ..................................................... 21

13.3 No search results ..................................................................................................................... 22

13.4 Listed Property Add (Posted by landlord) ........................................................................... 23

13.5 Search results for Listed Properties Adds ............................................................................ 24

14 Agents section .......................................................................................................................... 25

15 Landlords section .................................................................................................................... 26

16 About the project .................................................................................................................... 27

17 Contact us ................................................................................................................................ 27

18 Face book group ...................................................................................................................... 28

19 Define Colours, Fonts, Button layouts, menu design .................................................................. 29

20. Description of data ........................................................................................................................ 30

20.1 Data dictionary ........................................................................................................................ 30

20.1.1 Data dictionary definition ..................................................................................................... 30

20.2 Data Structure ............................................................................................................................. 31

20.2.1 Definition of Data structure ................................................................................................ 31

21. USE Case Diagram ...................................................................................................................... 32

21.1 Definition of use case diagram ............................................................................................... 32

21.2 Use case Scenarios ................................................................................................................... 32

22. ERD (Entity relationship Diagram) ........................................................................................... 32

22.1 Definition of ERD .................................................................................................................... 32

22.1.2 ERD Scenarios ...................................................................................................................... 33

23. Data Flow Diagram ...................................................................................................................... 33

23.1 Definition of Data Flow Diagram .......................................................................................... 33

23.2 Data Flow Diagram ................................................................................................................. 33

24. UML (unified Modelling Language) ...................................................................................... 34

24.1 Definition of UML ................................................................................................................... 34

24.2 UML ......................................................................................................................................... 34

25. Database Classes ........................................................................................................................... 35

26. Architectural diagram showing high level architecture ............................................................ 36

2

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

26.1 Multi-tier architecture ............................................................................................................ 36

26.1.1 Client-Tier (GUI Layer) ..................................................................................................... 37

26.1.2 Middle-Tier ........................................................................................................................ 37

26.1.3 Data-Storage Tier (Database Layer) .................................................................................. 37

27. Quality Issues ................................................................................................................................ 38

28 Non – Functional Requirements ............................................................................................ 38

28.1 Maintainability ........................................................................................................................ 39

28.2 usability .................................................................................................................................... 39

28.3 Efficiency ................................................................................................................................. 40

28.4 Contingency Plan .................................................................................................................... 40

28.5 Accessibility : ......................................................................................................................... 40

28.6 Ease Of use : ............................................................................................................................ 40

28.7 User Manuals or user documentation ................................................................................... 41

28.8 Date Formats ........................................................................................................................... 41

28.9 Language .................................................................................................................................. 41

28.10 Network .................................................................................................................................. 41

28.11 Availability ............................................................................................................................. 41

29. Appendix A .................................................................................................................................... 42

30. Appendix B .................................................................................................................................... 50

31. Appendix C .................................................................................................................................... 51

32. Appendix D .................................................................................................................................... 52

33. Sign off Report .............................................................................................................................. 53

34 References ....................................................................................................................................... 54

3

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

1.

Document Details

Version of the document template:

Software Use

Name of the report

Ошибка! Источник ссылки не найден.

Microsoft Word 2007

SDD (software design specification )

2.

Purpose

The SDS document will specify a high-level view of the architecture of the system and on the interaction between the user and the system

“truetenants.com.au”

Moreover, it focuses on detailing a low-level view of each component of the software and how the components interact with each other.

3.

Version History

VERSION DATE

1.1

04/09/2008

AUTHOR

Ayman

Chalak

REPORT LEVEL

First draft

4.

Approvals

This document requires the following approvals:

NAME

Grigory Punanov

Xiaofei Li

Ayman Shalak

Ding Wei & Pavel Semiklit

PROJECT TITLE

Project Manager

Project designer

Project documenter/ tester

Project programmer

4

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

5.

Distribution

This document will be stored on project website

(http://zoeqikusa.wordpress.com/documentation/SDD/) and distributed among the people listed above and including the project supervisor.

6.

Project Objective

Truetenats.com.au

is going to solve this problem: this site will connect tenants in one community so they can share knowledge about renting properties online.

Now all minuses, all problems, all issues of properties will be published and available on the

Internet. So, new tenants can be aware of potential issues.

Another powerful feature of this service is that is a used a tool to put pressure on landlord and agent to make them fix the problem, to improve " property's profile ". After solving the issue agent can leave a comment on the property’s profile and tenant can verify it.

At this moment, the project does not have any particular client but after launch it , this website can be presented to any existing tenant’s community such as NSW Tenants Union

( www.tenants.org.au)

7.

Project Scope

The scope of the project is to establish tenant’s social networking site in duration of 12 weeks so that the website will be functional and implemented well without any bugs.

8.

Project Team Details

NAME

Ayman chalak

Ding Wei

Grigory Punanov

Pavel Semiklit

Xiaofei Li

STUDENT

ID

PHONE EMAIL

30099129 0424072248 Ayman_shalak@hotmail.com

30084142 0422895929

30099435 0452525453

Avril3355@hotmail.com gpun138@gmail.com

30102364 0452439379

30117218 0402910139 p.semiklit@gmail.com

Zoe.qikusa@gmail.com

5

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

SDD (Software Design Document)

6

ITECH 7602 – PROJECT 4/09/2013

9.

System Context Diagram

9.1 Definition

Context diagram summarized all processing activities within the system in single picture .It is featured by the followings:

- High level view of a system

- The whole system is represented as one process

- Data flow that pass between the external entities and the system

- Technique that is used to define the boundary between the system and its environment

(Burge, 2011)

9.2 System interaction with external system using the system Context diagram

“The design will be produced later in the final report “

7

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

10.

Description and Justification of chosen methodology for project

10.1

SDLC

The SDLC is a software development lifecycle that defines the phases of the projects to produce the final output .Within the phases of the project, multiple projects to be taken in consideration so that final report and prototype are to be generated .In our project, SDLC methodology adopted is the waterfall model .This approach is used when the project has well defined and small scope .It is sequential SD Model in which development goes into many phases.

(Pamela, 2012)

10.2

PMBOK

PMBOK guide is the application of knowledge, skills and techniques to execute projects effectively and efficiently. This guide has been adopted in our project in which many knowledge areas have been implemented .The Project management knowledge areas are :

1.

Project integration management

2.

Project Scope management

3.

Project Time Plan

4.

Project Procurement Plan

5.

Project HR plan

6.

Project Communication Plan

7.

Project Risk management plan

8.

Project quality Plan

Our project has adopted some knowledge areas of the PMBOK guide like the Project scope plan, Project Communication plan, Project quality Plan, Project risk management plan

(Project managment , 2013)

8

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

10.3

Programming Languages

PHP is a server-side scripting language designed for web development. PHP code is interpreted by a web server with a PHP processor module which generates the resulting web page: PHP commands can be embedded directly into an HTML source document rather than calling an external file to process data.

PHP is free software released under the PHP License .PHP can be deployed on most web servers and also as a standalone shell on almost every operating system and platform, free of charge.

10.4 Project management Tools

Microsoft Project 2010 is utilized as a software tool to aid the project team in controlling the project timeline throughout the lifetime of the project

10.5 Document Management

All text documentations (SPMP, SRS, SDS etc.) are created using Microsoft Word 2010.

10.6 Image/Graphical Manipulation Software

Our team has utilized two major softwares in terms of designing the website

(tenants.com.au) the followings softwares are:

1.

Adobe Photoshop

2.

Adobe illustrator

Both of the software could be used also to create final poster in the coming weeks.

In case animation needed for the website, Adobe flash has been utilized.

10.7

Database Management Software

MySQL is a language used in order to store information .Information could be of any types like single character to a large complete files or graphics .It is considered as a relational database system .

Moreover , it is coupled with PHP because they work together with ease .

9

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

10.8 Presentation Software

Prezi is a US software company produced as cloud based Presentation software. The goal of this software is to provide templates for users to create presentation slides.

11 Stakeholders

11.1 Project Team

In terms of the project roles, refer to the SRS on the word press web application in which roles have been divided among team members.

11.2 Project guidance

The project guidance or coordinator will need to provide feedback and discuss many points on the project on weekly basis. It is crucial to have cooperation between the project team and the coordinator to achieve good deliverable at the end of the semester.

11.3 Users

Many users are to be used the “ truetenants.com.au

” system like the landlords, currents / new tenants, the agents. These are the main participants in utilizing the system

10

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12. Architecture Design

12.1 Detailed storyboards/ GUI design

Types of users and contents participated in the Web application “truetenants.com.au”

Project has got 3 types of registered users:

Tenant

Landlord

Agent

Each type of users will be described in details below according to each users section.

At the moment it is important to say that each type of user has different registration process and create different types of content.

SDD (Software Design Document)

11

ITECH 7602 – PROJECT 4/09/2013

12.1.1

Homepage

SDD (Software Design Document)

12

ITECH 7602 – PROJECT 4/09/2013

Homepage of the Truetenats.com.au

has 6 blocks of content.

Header with Title, Subtitle and Register/Log in button. Title is clickable and leads to homepage. Register/Log in is one button and opens the pop up window which is described in details in Section 2. Registration and Login processes.

After registration users-tenants can post Rented Property profiles and users-landlords can post Listed Property Profiles. This is described in details in section 3.

Main Menu . Menu buttons are active and highlighted when user puts mouse over

Main slider.

Slides automatically. Each slide has a picture, slogan and link to particular section

Search through tenants’ comments

. Interactive service which searches through all property profiles, posted by tenants. User is asked to put in the address of particular property and search for comments of previous tenants. After click on “search” button user is redirected to search results pages which are described in section 4.

Last comments , posted by tenants. In order to increase live effect we have 2 last comments, which are outputted from Tenants section automatically. Comments are clickable and redirect user to the particular Rented Property Profile page

Foote r has Facebook link to True tenants Facebook page and copy right

13

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12.1.2

Registration and Login process.

12.1.2.1 General process

Registration and log in processes are combined in one form. If user has already registered, he/she has to fill in only username and password in the top part of the form. If user has not been registered yet, he/she has to fill in bottom part of the form. There is very important drop down menu which user has to go through: choosing his/her role: whether user is Tenant,

Agent or Landlord. Depending on the role, after clicking “register ” button user is redirected to the particular second form, described in the next steps.

14

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12.1.2.2 Tenants

According to the above Figure , If user chose “tenants” in Registration form, he/she redirects to this form, where tenants has to mention the address and agency, he/she renting property from. Before finalising registration tenants is asked if he/she wants to post comment about any apartment now or later. If the choice is “yes”, user is redirected to Property profile form, described in section 3. If “no”, user logs in.

15

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12.1.2.3 Landlords

If user chose “

Landlord

” in Registration form, he/she redirects to this form, where Landlord can upload the profile picture and before finalising registration landlord is asked if he/she wants to post Property for Rent advertising. If the choice is “yes”, user is redirected to

Landlord Property Form, described in section 3. If no, user just logs in.

16

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12.1.2.4 Agents

If user is an AGENT he/she redirect to this page to finalise registration.

12.1.3

Creating Rented Property Reviews (created by tenants) and Listed Property Adds (created by landlords)

12.1.3.1

Rented Property Review (created by tenants)

Tenants, who ticked “yes” in previous registration form, redirected to the Rented Property

Review Form (above). Here they are asked if they want to post comment about the property,

17

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013 which address they have mentioned in registration form (this address is automatically appeared in the form so user do not have to retype it again). If answer is “yes”, user can type comment straight away and upload pictures of rented property.

If user wants to post review about any property with different address, he/she ticks “no” and form enlarges (see blueprint below) so empty fields for new address appear. After filling them in, user can type review text.

After submitting the Rented Property Review form, this content is saved in the database and can be searched, found and displayed.

18

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12.1.3.2 Landlords

If user is a landlord and wants to post advertising of listed property, he/she is redirected to the form above called Listed Property Add Form. Field here are self-explanatory. After submitting the form, this content is stored in the database and can be searched and displayed as Listed Property Add

19

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

12.1.3.3 Agents

If user is an agent, he/she does not need to fill in special form: agents are not allowed to create property profiles. They can only post comments to the existing reviews (see blueprint above).

To post comment agent has to be logged in. If user is not logged in, he/she will be redirected to the registration/log in form when they click on “post a comment” button. If user is logged in, he/she can post comment straight away. In comment there will be visible user status: either user is tenant, or agent.

20

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

13 Tenants section

13.1 Tenants section main page

Tenants section is divided in to two parts. Left part dedicated to Rented Property Reviews

(created by tenants), right part of the page dedicated to Listed Property Adds (created by landlords)

Search fields in both cases are self-explanatory. Search on the left side works the same way as on the homepage (described in section 2)

Under each search there is last Rented Property Review, posted by tenant and last Listed

Property Add posted by landlord – these is so make web site more interactive and “life”. Both property profiles are clickable and redirect users to particular pages.

Button Post Comment in the left side should redirect unlogged user to registration/login page, and should redirect logged in user to Rented Property Form.

21

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

13.2 Search results for Tenants Comments. Property profile

If Rented Property Review is existing in database, it can be searched and displayed. The searched and found property page looks like above one. It has address, pictures of property insides, name and picture of user, who posted this Rented Property Review.

Every new comment (no matter is it comment by agent or other tenant) is posted below previous one. On the right part there is a tool to send email to the tenant, who created Rented

Property Review and also there are some Listed Property are shown relatively selected by suburb. That will be very useful tool: if user looks for property in particular suburb, there is a

22

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013 high possibility that he/she will be interested in other listed properties in this area. That will also increase the possibility for landlords to rent out their Listed Properties.

Comments may be posted only by registered users, as described in previous chapter.

13.3 No search results

If there are no search results in the Rented Property Review, the above page is displayed.

If there is no results in the Listed Property Adds search, no result pop up appears straight on the Tenants Section main page under the “search” button.

23

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

13.4 Listed Property Add (Posted by landlord)

Listed Property Add looks this way. Here is also comment window so previous tenants can leave a review comment. On the right part there is a tool to send email to owner and other

Listed Properties from the same area (pending)

24

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

13.5 Search results for Listed Properties Adds

Search results for Listed Properties Adds look this way. Every profile is clickable and links to the current page.

25

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

14 Agents section

Agent section is a unique tool for agents to monitor Rented Properties Reviews. If agent choose suburb and type type the name of the agency, he/she will get the list of all existing

Properties Reviews, related to suburb and agency.

It will be very advanced if registered agents receive email notifications about new Rented

Property Reviews straight when they are posted by tenants.

26

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

15 Landlords section

Landlord section has a button for posting Listed Property Adds (if not logged in – redirect to log in/register form first) and also here we have search for Listed Property Adds as on tenants’ section home page – this will give landlords the idea of what other properties are listed in their suburb and what are the prices.

27

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

16 About the project

About the project page has explanation and very meaningful picture, describing the main goals of the project. Under this description we have last Property profiles posted by tenants and landlords

17 Contact us

Contact us page has our team’s email for any feedback.

SDD (Software Design Document)

28

ITECH 7602 – PROJECT 4/09/2013

18 Face book group

Link to the Face book group goes to the Face book account of our project. This tool we will use to promote our project and to deliver it to our target audience.

SDD (Software Design Document)

29

ITECH 7602 – PROJECT 4/09/2013

19 Define Colours, Fonts, Button layouts, menu design

“Produced in the next stage “ 

pending

SDD (Software Design Document)

30

ITECH 7602 – PROJECT 4/09/2013

20. Description of data

20.1 Data dictionary

20.1.1 Data dictionary definition

It is a centralized repository of information about data such as meaning, relationships to other data, origin, usage, and format."A document describing a database or collection of databases

Data element

Header

Description

Property ID Unique ID number for property or apartment

Property Type Type of properties to rent

“apartments, house , etc .

Landlords ID Unique ID number for landlords

Email Address Email address of the landlords

Field Type

Int

Varchar

Varchar

Varchar

Field Length

30

20

30

255

Password Password of the landlord account after being registered to the system

Varchar 32

31

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

20.2 Data Structure

20.2.1 Definition of Data structure

Data elements grouped together under one name is considered as data structure .These data elements have different types and lengths .According to our project , the data structure are sampled according to the followings :

Folder

../public_html

Description

All the files went with

WP package( default)

Location

/home/trutena/public_html

/wp-content

/truetenants

/js

Consists the following folders: - plugging; - themes; - upgrade; - uploads ; and some system files

/home/trutena/public_html/wp-content

Project website folders

Main folder with all files which are related to the project's website (php, css)

All the js files are stored in this folder

/home/trutena/public_html/wpcontent/themes/truetenants/

/home/trutena/public_html/wpcontent/themes/truetenants/js

/images All the images for the website are stored here

/home/trutena/public_html/wpcontent/themes/truetenants/images

Database on web server

/localhost/truetena_wp146 Database of

Wordpress and

Project itself

/localhost/truetena_wp146

32

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

21. USE Case Diagram

21.1 Definition of use case diagram

It is a diagram that shows a set of use cases and their relationships. Use cases represent system functionality, the requirements of the system from user’s perspective.

Moreover , Use

Case Diagrams are closely connected to scenarios. A scenario is an example of what happens when someone interacts with the system. Such interaction could be internally within the system or externally with the system .According to our web application “ tenants.com.au

“ , it highlights the interaction occurring among the different parties by representing the participants in a USE CASE diagrams and the interaction among each others .

(R, 2009) &

(Technologies, 2009)

21.2 Use case Scenarios

Refer to appendix A

22. ERD (Entity relationship Diagram)

22.1 Definition of ERD

An entity-relationship diagram (ERD) is a data modelling technique that graphically illustrates an information system’s entities and the relationships between those entities. An

ERD is a conceptual and representational model of data used to represent the entity framework infrastructure. The elements of an ERD are the followings:

 Entities

 Relationships

 Attributes

(Janssen, 2013)

33

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

22.1.2 ERD Scenarios

Refer to Appendix B

23. Data Flow Diagram

23.1 Definition of Data Flow Diagram

Data flow diagrams are illustrated movement of data between external entities and the processes and data stores within a system .

In addition, data flow diagram technique is

Effective for expressing functional requirements for large complex systems.

A Data Flow Diagram consists of:

•Processes

•Data Flows

•Data Stores

•External Entities

-

An activity that is utilized for business reason is called “Process “

- Several pieces of information or single piece of data is called “Data Flow “

- A data store is a collection of data that is stored

- An external entity is a person, organization, or system that is external to the system but interact with it.

The highest-level of data flow diagram is known as the context diagram.

(Yen, 2010)

23.2 Data Flow Diagram

Check Appendix C

34

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

24. UML (unified Modelling Language)

24.1 Definition of UML

The Unified Modelling Language abbreviated as UML is a graphical technique used to create visual models of object-oriented software systems.

24.2 UML

Check appendix D

35

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

25. Database Classes

The following classes will be used in the Database system :

Landlords

Agents

Tenants

Property

Branch

Post

Suburbs

Comments

Etc.

The database will be used to store all of the application data, to allow for easy design, building and backup of data. The database module consists of both the database server, and the database schema that will be used for the application.

It will also contain the classes that are responsible for managing the database connections.

SDD (Software Design Document)

36

ITECH 7602 – PROJECT 4/09/2013

26. Architectural diagram showing high level architecture

26.1 Multi-tier architecture

It is a client-server based architecture where it acts a mid-layer between the user and teh database .This conclude that user interface, data storage, etc. are to be considered as independent modules .A multi-tiered architecture is able to control and identify each user’s access. In addition , the architecture allows different languages to be used such as HTML for the client side, PHP language for the sever side programming language and SQL for database.

Data Storage Tier

MySQL

Middle Tier

Client Tier

Server

SDD (Software Design Document)

User1

User2

37

ITECH 7602 – PROJECT 4/09/2013

26.1.1 Client-Tier (GUI Layer)

This layer allows the user to view, manipulate and update data to provide simple control of the system. This layer represents all things that are visible to the user, including screen layout and navigation. user will view the final product through a web browser which means the user will view HTML source code. The HTML will be functioning in conjunction with CSS for presentation purposes.

26.1.2 Middle-Tier

The middle-tier, also known as middleware is the layer that will be in the server to assist in resource sharing.According to our System , the middle-tier will be PHP server side programming language which is used in order to make link or connections between the

HTML and the Database (SQL )

26.1.3 Data-Storage Tier (Database Layer)

The Data-Storage layer will contain a database where all the data is stored. It can be accessed and modified by the middle tier. In terms of our project , the database layer will be in the form of a MySQL database sitting on the server. The database will be interacted and manipulated by the PHP code based on instructions from user in the presentation layer.

38

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

27. Quality Issues

For extra information on Quality Measures, please refer to the Quality Management Plan from Truetenants.com.au website in which the quality report has been mentioned in the

SPMP under the d documentation section - > SPMP

28 Non – Functional Requirements

Non-functional requirements are often called qualities of a system that could be mentioned according to the followings:

Accessibility

Ease of use

Availability

Backup of the system

Documentation

Disaster recovery

Interoperability Maintainability

Portability

Quality

Recovery / recoverability

Reliability

Date formats

Language

Network

39

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

28.1 Maintainability

Maintainability is the ease in which a System or web application can be maintained in order to:

 isolate defects

 correct defects

 repair or replace faulty su components without having to replace the the system itself

 prevent unexpected breakdowns

 maximize efficiency, reliability, and safety,

The system will be maintained by the client after delivery, so the system must have suitable documentation for the client to be able to do so. This will include detailed design / code information to ensure someone with basic technological knowledge, including programming knowledge in the application language, can maintain the system.

And so forth. The project team will not be responsible for the system once it is handed over to the supervisor. Therefore the system must be well developed and documented to ensure that the supervisor or users can maintain the system without project team assistance.

28.2 usability

The application is designed with an easy to use user interface, to make it as simple as possible, so that anyone with minimum computer skills is able to understand and use the application. The website will have minimal page refreshes, prompts and tooltips to make it easier for a new user to understand.

40

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

28.3 Efficiency

The application must be efficient for both the users and the administrator. The user must have reasonable response times and minimal learning. The application contains mostly screens that are viewed to get information from and instructions can be found by selecting the appropriate buttons or links. The user will be able to use the application with minimum mouse clicks on each specific role. When a change is done to the user details at registration, the update has to be received by the other users within 15 seconds.

28.4 Contingency Plan

A contingency plan is a plan devised for a specific situation when things could go wrong.

This is already catered for in the Risk Management Plan and can be found

Truetenants.com.

au website team website

( http://zoeqikusa.wordpress.com/documentation/SPMP ) which include the risk management plan.

28.5 Accessibility

The System “ truetenants.com.au

“ is accessible by every and each user with no restrictions on any parties , but there is some functionalities in which some of them would not be able to perform it .

The followings parties are:

Tenants, new tenants, landlords and agents .These parties are able to access the system whenever they would like because the system is operable 24/7 if connectivity takes place

28.6 Ease Of use :

The ability of a user to successfully perform a task with an available system without the need for an advanced explanation and/or the instruction manual or kind of training .the system should be simplified and easy to utilize in order to perform tasks without referring to any external assistance

41

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

28.7 User Manuals or user documentation

It is a document that is given for new users accessing the website for the first time like the tenants ( new / current tenants ) .it is written procedures that identify how tenants can log in to the system, register , post comments and communicate with the landlord using the website .

Finally , it contains graphical snapshots with written instructions to help tenants and landlords use the system .

28.8 Date Formats

The system must conform to the Australian date format. As an example “ dd/mm/yyyy “

28.9 Language

The System will be written in Australian English Language

28.10 Network

The application will run over a wireless network or LAN by internet accessibility

28.11 Availability

The system should be available for the users at anytime and anywhere without any downtime

, availability must be of a percentage of 99% .If one part of the system is down , the system will be unavailable and complexity takes place .

So the greater reliability , the maximum availability of the system would be .

(System Availibility & Downtime , 2011)

42

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

29. Appendix A

The various tasks that must be performed by users of the system will be documented as Use Cases.

Each Use Case in this document will consist of a Use Case Diagram, and a Use Case Detailed

Description.

13.3.1 Current tenants

Log in to “

Truetenants.com

Current Tenants

SDD (Software Design Document)

43

ITECH 7602 – PROJECT 4/09/2013

13.3.1.1

Use Case Detailed Description

Below is the use case detailed description for the tenants already renting apartments

Use case name Example : “ Log in “

Scenario Log in to tenants section using user name and password already registered

Description

Participiants

Tenants are able to search through properties listed by landlords by spefciying the type of the property , the price needed and the suburbs place .Then , after that by clicking on the search buttons , the system direct the tenants to real destination on the maps and dislay the necessary properties .In addition , tenants can post any comments made to teh system in case any problems arise

Tenants

Flow of events Actors

Tenants access the system by loging in to “ truetenants.com.au “

Tenants are able to search through properties type listed by landlords

Systems

 the system direct the to his page called “ tenants page “ section

Tenants are able to specify the properties in specific places around Sydney new south wales

Tenants can also make comments about proplems arise at accommodation

System display the necessary properties for the tenants

The system display specifically the properties in

NSW , sydney

The system will display also the comments done by the tenants and also post the latest comment don eby tenants

SDD (Software Design Document)

44

ITECH 7602 – PROJECT 4/09/2013

13.3.2 New Tenants

Register to “

Truetenants.com

New Tenants

45

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

13.3.1.2

Use Case Detailed Description

Below is the use case detailed description for the tenants who would like to check about apartments and check about comments made by tenants already living in properties

Use case name Example : “ register “

Scenario registration to tenants section using user name and password

Description

Participiants

Registration processes takes place.User not being registered he/she has to fill in bottom part of the form. There is very drop down menu which user has to go through: choosing his/her role: whether user is TENANT, AGENT or

LANDLORD. According to this phase , the tenants are to be selected. After clicking the registration button , the user will be redirected to the particular form described later .

New Tenants

Flow of events

Actors

Tenants access the system by signing up to “ truetenants.com.au “ in the new tenants registration form

 the tenants enter details for registration process like the name , family name , email address .Then set a password , and password should be re-type in order to get confirmation

Systems

 the system direct the to his page called “ registration “ section

The system save the data entered into the registration section for the new tenants so that he/she able to access the system whenever necessary

SDD (Software Design Document)

46

ITECH 7602 – PROJECT 4/09/2013

13.3.1 Landlords

Register to the system

47

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

Use case name

Scenario

Example : “ register “ registration to tenants section using user name and password

Description

Participiants

Registration processes takes place.User not being registered he/she has to fill in bottom part of the form. There is very drop down menu which user has to go through: choosing his/her role: whether user is TENANT, AGENT or

LANDLORD. According to this phase , the landlords are to be selected. After clicking the registration button , the user will be redirected to the particular form described later .

Landlords

Flow of events Actors

Landlords access the system by signing up to “ truetenants.com.au “ in the new tenants registration form

 the landlords enter details for registration process like the name , family name , email address .Then set a password , and password should be re-type in order to get confirmation

After being registered into the system , the landlords could upload photos of properties to be checked by every tenants ( new or current )

The landlords click on the finalization button to be part of the registration system

Systems the system direct the landlords his page called “ registration “ section

The system save the data entered into the registration section for the landlords so that he/she able to access the system whenever necessary

The system save the data or the photos uploaded so that every one could access the system

The system save the whole data

48

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

13.3.1 Landlords “after registration “

Post advertisement of the properties, communication takes place

If user is a landlord and wants to post advertising of listed property, he/she is redirected to the form above called Listed Property Add Form. Field here are self-explanatory. After submitting the form, this content is stored in the database and can be searched and displayed as Listed Property Add .

Use case name

Scenario

Description

Participiants

Example : “communication process“

The landlords are able to communicate with the tenants , agents and fix problems that might arise among each others

Landlords are able to post advertisement of listed properties by specifying the suburbs of the properties , the Unit number , the photos of the apartments , price per week , post code and street number

Landlords

Flow of events Actors

Landlords access the system , already registered

Systems

 the system direct the landlords to his page called “ landlords sections

49

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

The landlords after being registered can upload the pictures of the necessary apartments , their locations , suburbs and so on

After the necessary data has been entered by the landlords , the landlords would be able to check what properties has been taken by tenants and what others have been left with no rent

To be continue in the final Report in the next stage

The system save the necessary data of the properties posted by the landlords

The system display the roperties taken or others left not being taken

50

SDD (Software Design Document)

ITECH 7602 – PROJECT 4/09/2013

30. Appendix B

SDD (Software Design Document)

51

ITECH 7602 – PROJECT 4/09/2013

31. Appendix C

SDD (Software Design Document)

52

ITECH 7602 – PROJECT 4/09/2013

32. Appendix D

SDD (Software Design Document)

53

ITECH 7602 – PROJECT 4/09/2013

33. Sign off Report

Name

Ayman Chalak

Grigory Punanov

Xiaofei Li

Pavel Semiklit

Ding Wei

Signature Date

04/09/13

04/09/13

04/09/13

04/09/13

04/09/13

SDD (Software Design Document)

54

ITECH 7602 – PROJECT 4/09/2013

34 References

Burge, D. S. (2011). The system Engenering toolbox . Retrieved 03 09, 2013, from Toolbox : http://www.burgehugheswalsh.co.uk/uploaded/documents/CD-Tool-Box-V1.0.pdf

Janssen, C. (2013). Entity-Relationship Diagram (ERD). Retrieved from http://www.techopedia.com/definition/1200/entity-relationship-diagram-erd

Pamela. (2012, 2 29). Project Management. Retrieved 2013, from Project Management: http://ist.uwaterloo.ca/is/Methodologies/Project%20Management%20Methodology.pdf

Project managment . (2013). Retrieved August 10, 2013, from Project Managment Institute : http://www.pmi.org/About-Us/About-Us-What-is-Project-Management.aspx

R, A. (2009, 02 17). Requirement modeling ( use case diagram + use case description ). Retrieved 09

03, 2013, from slideshare: http://www.slideshare.net/curiousEngine/use-case-diagram

System Availibility & Downtime . (2011). Retrieved 09 04, 2013, from Active server : http://www.active-server.com/pdf/SystemAvailabilityandDowntime.pdf

Technologies, E. (2009). UML 1.5 Use Case Diagram Definition. Retrieved 09 04, 2013, from use case definition: http://docs.embarcadero.com/products/rad_studio/delphiAndcpp2009/HelpUpdate2/EN/html/devc ommon/uml15usecasediagramdefinitionexample_xml.html

Yen, R. I. (2010, 10). FORMALIZATION OF THE DATA FLOW DIAGRAM. Retrieved 09 04, 2013, from

International Journal of Software Engineering & App: http://arxiv.org/ftp/arxiv/papers/1011/1011.0278.pdf

SDD (Software Design Document)

55

Download