Urban Science Web Reporting Tool
Urban Science
Web Reporting Tool
Software Design Specification
Senior Design Team Fall 2005
Tuesday, November 10, 2005
Todd Pugh
Josh Squillets
Martha R. Casing
Steve Myslinski
2/12/2016
Urban Science Web Reporting Tool
SOFTWARE DESIGN SPECIFICATION ......................................................................................... 1
1.0 Introduction ...................................................................................................................................... 1
1.1 Goals and objectives ..................................................................................................................... 1
1.2 Statement of scope ........................................................................................................................ 1
1.4 Major constraints .......................................................................................................................... 1
2.0 Data design ....................................................................................................................................... 1
2.1 Internal software data structure .................................................................................................... 1
2.2 Global data structure ..................................................................................................................... 2
2.3 Temporary data structure .............................................................................................................. 2
2.4 Database description ..................................................................................................................... 2
3.0 Architectural and component-level design ....................................................................................... 3
3.1 Program Structure ......................................................................................................................... 3
3.1.1 Architecture diagram ................................................................................................................. 3
3.2 Description of Components .......................................................................................................... 3
3.2.1 Description for Dealer Search.................................................................................................... 3
3.2.2 Description for Dealer Profile.................................................................................................... 4
3.2.3 Description for Dealer Census ................................................................................................... 4
3.2.4 Description for Dealer Activity ................................................................................................. 4
3.2.5 Description for Export Report ................................................................................................... 5
3.3 Software Interface Description ..................................................................................................... 5
3.3.1 External machine interfaces ....................................................................................................... 5
3.3.2 Human interface ........................................................................................................................ 5
4.0 User interface design ........................................................................................................................ 5
4.1 Description of the user interface ................................................................................................... 5
4.1.1 Screen Images ............................................................................................................................ 6
4.1.2 Objects and Actions ................................................................................................................... 8
4.2 Interface design rules .................................................................................................................... 8
4.3 Components available ................................................................................................................... 8
4.4 UIDS description .......................................................................................................................... 8
5.0 Restrictions, limitations, and constraints .......................................................................................... 8
6.0 Testing Issues ................................................................................................................................... 8
6.1 Classes of tests .............................................................................................................................. 8
6.2 Expected software response .......................................................................................................... 9
6.3 Performance bounds ..................................................................................................................... 9
6.4 Identification of critical components ............................................................................................ 9
7.0 Appendices ......................................................................................................................................10
7.1 Requirements traceability matrix .................................................................................................10
7.2 Packaging and installation issues.................................................................................................10
7.3 Design metrics to be used ............................................................................................................10
7.4 Supplementary information (as required) ....................................................................................10
7.4.1 Detailed Table Information.......................................................................................................10
7.4.2 Test Plan ...................................................................................................................................11
2/12/2016
i
Urban Science Web Reporting Tool
Figure 1 - Relationships.................................................................................................................................. 2
Figure 2 - Architecture Diagram .................................................................................................................... 3
Figure 3 - Main Menu..................................................................................................................................... 7
Figure 4 - Dealer Search ................................................................................................................................. 7
2/12/2016
ii
Urban Science Web Reporting Tool
SOFTWARE DESIGN SPECIFICATION
1.0 Introduction
This section provides an overview of the entire design document. This document
describes all data, architectural, interface and component-level design for the
software.
1.1 Goals and objectives
To create a front-end for a set of relational databases that provides service through
the Internet.
1.2 Statement of scope
The software will retrieve data from an SQL server upon user defined queries.
The users should have quick response time to the data. This will be used by the
software to create reports. These reports can be viewed from Internet Explorer
and/or printed and/or exported.
1.3 Software context
This end product will be provided via the Intranet to Urban Science employees to
access data that will provide up to date information on dealership locations around
the country, dealer profile information and a census by manufacturer by
geographical location. (I.e. Added, terminated, relocated, bought/sold)
1.4 Major constraints

No Java language can be used.

Tool must operate in Microsoft environment.

Must work in Internet Explorer 6

The information store will be an SQL database.
2.0 Data design
A description of all data structures including internal, global, and temporary data
structures.
2.1 Internal software data structure
When SQL returns the results of the query sent to it by ASP, the results of the
query will be passed back to ASP using the built in data structures.
2/12/2016
1
Urban Science Web Reporting Tool
2.2 Global data structure
We are not using any global data structures at this time.
2.3 Temporary data structure
We will be using a cookie saved on the user’s machine to temporarily store the
user’s query entry. This is so the user can go back to the query page and easily
modify their last query to refine or widen their search as needed.
2.4 Database description
A database will be used to store all of the dealer data used to create the reports
needed. The database is made up of five tables. BestLocCodes, Composite,
Franchise, Manuf and Changes. The relationships for these tables are shown
below. Changes has no relationships to the other four tables.
Figure 1 - Relationships
The database will be implemented using SQL.
For detailed descriptions of tables and fields refer to Appendix A.
2/12/2016
2
Urban Science Web Reporting Tool
3.0 Architectural and component-level design
3.1 Program Structure
A data-centered architecture is the obvious choice for the software. The database
will be stored using SQL Server 2000 and accessed using ASP.NET. Almost
every component of the software will interact with the database in some way.
The data that is retrieved will be returned to be displayed in a user friendly format
within the user’s web browser or exported for use in Microsoft Excel.
3.1.1 Architecture diagram
Dealer Census
Dealer Search
Dealer Activity
Dealer Profile
Export Report
Dealer Database
Figure 2 - Architecture Diagram
3.2 Description of Components
3.2.1 Description for Dealer Search
3.2.1.1 Processing narrative (PSPEC) for Dealer Search
Dealer Search will display a page with a form allowing the user to enter
information to search for the dealer of their choice. They must at least
enter the State, select a time period, and select at least one Manufacturer.
A list of dealers that match the information the user enters will be
displayed. The user can then select any of these dealers to continue to the
Dealer Profile page.
3.2.1.2 Dealer Search interface description.
The user will input data using their web browser. An SQL query will be
generated using their selections and sent to SQL Server. The data from
the query will then be returned and processed using ASP.NET before
being sent back and displayed to the user.
2/12/2016
3
Urban Science Web Reporting Tool
3.2.2 Description for Dealer Profile
3.2.2.1 Processing narrative (PSPEC) for Dealer Profile
The Dealer Profile will provide a summary of data available for one
particular dealer. The user can continue from this page to look at the
Dealer Activity reports for the county where the dealer is located.
3.2.2.2 Dealer Profile interface description.
An SQL query will retrieve all data on the dealer from SQL Server. The
data from the query will then be returned and processed using ASP.NET
before being sent back and displayed to the user.
3.2.3 Description for Dealer Census
3.2.3.1 Processing narrative (PSPEC) for Dealer Census
Dealer Census will allow the user to access reports that cover greater
geographical regions than those accessed using the Dealer Profile page.
The user will be presented with various options to select from and fields to
enter to get the data they need. They will then be able to continue to the
Dealer Activity reports associated with that data.
3.2.3.2 Dealer Census interface description.
The user will input data using their web browser. An SQL query will be
generated using their selections and sent to SQL Server. This information
will be used once they proceed to the Dealer Activity page.
3.2.4 Description for Dealer Activity
3.2.4.1 Processing narrative (PSPEC) for Dealer Activity
The Dealer Activity reports will vary based on what data group the user
has selected. If the user comes from the Dealer Profile page data from the
surrounding county will be displayed, if they come from the Dealer
Census page the data will span whatever geographical region they have
selected. The data will be retrieved using an SQL query and then bound
an ASP.NET Data Grid control to be displayed to the user.
3.2.4.2 Dealer Activity interface description.
Using information from the previous page a query will be sent to SQL
Server to retrieve all data needed by the activity report. The data will be
returned and processed using ASP.NET before being sent back and
displayed to the user.
2/12/2016
4
Urban Science Web Reporting Tool
3.2.5 Description for Export Report
3.2.5.1 Processing narrative (PSPEC) for Export Report
Export Report will be available to users while viewing any dealer reports.
The data from the report that is currently displayed on the screen will be
exported to a format that is compatible with Microsoft Excel for further
use.
3.2.5.2 Export Report interface description.
The data will be converted by ASP.NET and sent to the user.
3.3 Software Interface Description
3.3.1 External machine interfaces
The software will interface with a machine running SQL Server 2000
where all of the dealer information will be stored.
3.3.2 Human interface
The software will be available on the Intranet where users will have access
to it using Microsoft Internet Explorer 6.0 or higher. Details of the
implementation of this interface are available in Section 4.0.
4.0 User interface design
A description of the user interface design of the software is presented.
4.1 Description of the user interface
The user interface (UI) is web-based and provides a visual front-end to our client's
databases and queries.

Main Menu Page
The main menu page allows a user to navigate to either the dealer search or dealer
census pages.

Dealer Search Page
The dealer search page contains fields for the user to fill in with information to
search for specific dealers or a more generalized area containing multiple dealers.
It also contains a navigation menu on the side that will allow the user to quickly
get from the search page to wherever they want within the site. At the bottom
there is a box in which the search results will be displayed. In the results box, a
user can choose a dealer and go to the dealer profile or the dealer activity page for
more info on the dealer they choose.
2/12/2016
5
Urban Science Web Reporting Tool

Dealer Activity Page
The dealer activity page has information on the activity of dealerships around the
dealership that the user has chosen. Activities such as dealerships being added to,
relocated to or away from, closed and bought or sold in the area. This page also
has the navigation menu along the side of the page; except this navigation bar also
has links to certain parts of the page. Due to the possible length of each report on
activity, this was added.

Dealer Profile Page
The dealer profile page contains information on the location, phone number, when
it was opened, brands at the facility and other dealerships closely located. This
page also contains an image of the dealership, navigation bars to cycle through
dealership profiles that came up in the original search and the navigation menu on
the side with a new option to go to the dealer activity page of the currently
selected dealership.

Dealer Census Page
The dealer census page will be similar to the main menu, except that it's the main
menu for all the reports. From this page, you can access the dealer activity
summary report and the franchise report. Again the navigation menu is along the
side.

Dealer Activity Summary Report Page
The dealer activity summary report page will have the options to choose a state,
manufacturer and a dealer census to generate a region based report for dealership
activity. This would include add, relocate, close, and buy/sell information on
dealerships within the region the user selects.
4.1.1 Screen Images
Shown here are the interface screens of the web application.
2/12/2016
6
Urban Science Web Reporting Tool
Figure 3 - Main Menu
Figure 4 - Dealer Search
2/12/2016
7
Urban Science Web Reporting Tool
4.1.2 Objects and Actions
The main object on all of the pages is the navigation menu that will allow
the user to get to the main menu, the dealer search and the dealer census
portion of the site. Depending on what page you are on there may be more
options in the navigation menu. There is also a search button that
commences searching of the databases based on criteria, and displays the
results in a result box on the dealer search page. The same page also has a
reset button that will clear all the fields so that the user can start with a
clean slate of search criteria. On the dealer profile page, there will be
navigation buttons allowing the user to move through the list of results
provided by the search that the user makes.
4.2 Interface design rules
The only standards that we are currently following are to conform to the general
color scheme of the Urban Science web site, www.urbanscience.com
4.3 Components available
There are none at this time.
4.4 UIDS description
We are going to be developing this website with ASP.net and using SQL to query
the database.
5.0 Restrictions, limitations, and constraints

No Java language can be used.

Tool must operate in Microsoft environment.

Must work in Internet Explorer 6

The information store will be an SQL database
6.0 Testing Issues
Test strategy and preliminary test case specification are presented in this section.
Additional test cases are located in the Appendix section in spreadsheet format.
6.1 Classes of tests

2/12/2016
Performance Test – ensure that the response time for information
retrieval is within an acceptable range.
8
Urban Science Web Reporting Tool

Accuracy Test – determine if queries return the expected results.

User Interface Test – make sure the user interface is clear and easy to use
with all types of users

Security test – ensure that users can only perform the tasks specified for
their user group

Repeatability Test – The software returns the same result for repeated
queries.
6.2 Expected software response

Performance Test – all activities should respond within 30 seconds.

Accuracy Test – Returned report matches manual report.

User Interface Test – Unfamiliar user can use the interface with minimal
instruction and achieve the desired results.

Security Test – Users are restricted to activities in their class.

Repeatability Test – If an identical query is repeated the same response is
given each time.
6.3 Performance bounds

Must be compatible with Internet Explorer and work on Microsoft IIS

Search process should not take longer than 30 seconds.

Page request process should not take longer than 30 seconds.

All activities done by the software should respond within 30 seconds.
6.4 Identification of critical components

2/12/2016
Database connectivity
9
Urban Science Web Reporting Tool
7.0 Appendices
7.1 Requirements traceability matrix
Because of the small size and rapid development of this application, a traceability
matrix is not needed.
7.2 Packaging and installation issues
There are none at this time.
7.3 Design metrics to be used
For the interface, the user must be able to use 90% of the system functionality
after a 1 hour training session.
7.4 Supplementary information (as required)
7.4.1 Detailed Table Information
2/12/2016
10
Urban Science Web Reporting Tool
7.4.2 Test Plan
Shown below are test plans for General tests and the different web
pages, which are Log In, Main Menu, Dealer Search, Dealer Profile,
Dealer Activity, Dealer Census and Activity Summary Report.
Test condition
No.
Expected Result
Log In
1
2
Enter web address.
Enter web address and user name and
password.
User should be shown the log in screen.
A valid user should be able to enter username and password and
then be shown the main screen upon successful log in.
General
Tests
Test all links on each web page from the site
map
For each link selected, the link should change color, so the user
knows what was previously selected. The user should also be
taken to the correct and corresponding link.
Test numeric in text box fields on web pages
Where applicable, the user should be allowed to enter numeric
data into the text box fields.
The user should be shown the correct and corresponding web
page with performance time considered.
Where applicable, the user should be allowed to enter
alphanumeric data into text box fields.
The user should be shown reports, without error. Else an error
message will be shown.
The user should be able to export all reports without error. Else
an error message will be shown.
The user should be able to navigate using the previous and next
buttons on the page.
Test that the report being viewed is the correct report has the
correct data displayed.
Test that the web site loads.
Test that there is a database connection.
3
4
Test opening each web page
5
6
Test alphanumeric in text box fields on web
pages
Test viewing reports
7
Test exporting reports
8
9
10
11
12
Test previous and next buttons on Profile
page.
Test the Reports
Test the web site from the server end.
Test the database connection
Main Page
Notice the main web page
The user should see the site map on the left side of the screen.
The user should see two available options to select from in the
center of the page (dealer search and dealer census), the title of
the page should be on the top of the screen. There should also be
a way to log out link. The links that appear in the site map should
include Dealer Search, Reports, main menu, and Urban Science
home page.
The user should be taken to the corresponding web page of the
link selected.
The user should be able to log out of the web site.
Each link should take the user to the corresponding web page.
13
14
15
16
Notice the main web page and select the two
links on the center of the page.
Notice the main web page and select log out.
From the main web page, notice the links on
the left side in the site map, test each link.
2/12/2016
11
Urban Science Web Reporting Tool
Dealer
Search
From the main web page, select Dealer Search,
notice the web page that appears.
17
18
19
20
21
22
23
Enter numeric characters into the text box
fields.
From the Dealer Search page, select census,
manufacturer and state (these are required fields
for the report to be shown), and then Search
button.
From the Dealer Search page, select census,
manufacturer and state (these are required fields
for the report to be shown), and then Search
button. Select a check box in the results section
The user should be shown the Dealer Search page. The site map
should be on the left side of the screen. The text boxes and drop
down boxes should be set to default values. The Dealer Profile and
Dealer Activity buttons should be hidden until state, census, and
manufacturer are selected. Search button should be dimmed until
manufacturer is selected, state, and census are selected. "All" should
be included as an option in the manufacturer list. The links that
appear in the site map should be main menu, dealer search, dealer
census, and Urban Science home page.
The user should only be allowed to enter numeric characters into
zip field, all others should be alpha characters.
The user should be shown the search results in the lower portion of
the screen.
The user should be able to select the check box next to a dealer.
Only one box should be able to be checked at one time, and the
rest disabled and/or shaded out.
From the Dealer Search page, select census,
manufacturer and state (these are required fields
for the report to be shown), and then Search
button. Next select the Dealer Profile button.
The user should be shown the Dealer Profile page.
From the Dealer Search page, select census,
manufacturer and state (these are required fields
for the report to be shown), and then Search
button. Next select the Dealer Activity button.
The user should be shown the Dealer Activity Page.
From the Dealer Search page, select census,
manufacturer and state (these are required fields
for the report to be shown), and then Reset
button.
The user should be able to select the Reset button and then the text
boxes and the drop down boxes are set to default values.
Dealer
Profile
From the Dealer Search page, select Dealer
Profile, notice the web page that appears.
From the Dealer Search page, select Dealer
Profile, enter data into the text boxes and
other fields.
The User should be shown the site map on the left side of the
screen. The site map links should include main menu, Dealer
Search, Dealer Census, Dealer Activity, and Urban Science home
page. The user should also be shown text boxes and drop down
boxes populated with data that was previously selected. The user
should see the dealer image, as well as, previous dealer, change
dealer and next dealer buttons.
The user should not be allowed to enter or change any of the text
boxes or other fields shown on the screen, they should be locked.
This is view only screen.
From the Dealer Profile page, test the links on
the site map.
From the Dealer Profile page, test the
previous, next and change dealer buttons.
The user should be able to view and go to all of the links on the
web site map.
The user should be taken to the corresponding page for each
button selected.
24
25
26
27
2/12/2016
12
Urban Science Web Reporting Tool
Dealer
Activity
From the Dealer Search page, select
Dealer Activity, notice the web page.
28
From the Dealer Activity page, scroll
down to view the entire page.
29
The user should see the site map on the left side of the screen. The site
map should include Reports and list each (add, relocate, close, buy/sell),
main menu, Dealer Search, Dealer Census, Dealer Profile, and Urban
Science home page. There should also be print and export buttons. The
user should be shown data grids for each report (add, relocate, close,
but/sell) with the criteria selected.
The user should be shown all of the report data grids. The user should
be able to select the links in the site map to view the same data grids on
the web page.
Dealer
Census
From the Main menu page, select the
Dealer Census option. Notice the web
page that appears.
The user should be shown the Dealer Census page. The Census page
should have a title, site map, which includes main menu, Dealer Search,
Dealer Census, and Urban Science home page. There should be an
option to select the Dealer Activity Summary Report.
From the Dealer Census page, select the
link Dealer Activity Summary Report.
Notice the web page that appears.
The user should be shown the Dealer Activity Summary Report page.
The page should have a web site map, which includes main menu, and
urban science home page. There should also be a Generate button,
options to select state, manufacturer, and dealer census date.
From the Dealer Activity Summary
Report page, select state, manufacturer,
and census, and then the Generate
button.
The user should be shown the summary report for the options selected
from the Dealer Activity Summary Report page.
30
Dealer
Activity
Summary
Report
31
32
2/12/2016
13