You are on page 1of 16

Project Design Document

Smart City System


(SCS)

Software Requirement Specification Document V 1.0

Smita Vaze
smitvaze@in.ibm.com

IBM CEIS Confidential


Project Design Document

Table of Contents
Disclaimer...............................................................................................................4
1. Scope..................................................................................................................5
2. Assumptions........................................................................................................5
3. Management Summary.......................................................................................6
5. Functional Requirements....................................................................................8
6. Use Case Diagram..............................................................................................9
6.1. Detail Description of Use Cases...........................................................10
6.1.1. To Login..............................................................................................10
6.1.1.1 Input..................................................................................................10
6.1.1.2 Process.............................................................................................10
6.1.1.3 Output...............................................................................................10
6.1.2 Upload feedback surveys....................................................................10
6.1.2.1 Input..................................................................................................10
6.1.2.2 Process.............................................................................................10
6.1.2.3 Output...............................................................................................10
6.1.3 Enter Feedback functional requirement:.............................................11
6.1.3.1 Input..................................................................................................11
6.1.3.2 Process.............................................................................................11
6.1.3.3 Output...............................................................................................11
6.1.4 Upload City News functional requirement...........................................11
6.1.4.1 Input..................................................................................................11
6.1.4.2 Process.............................................................................................11
6.1.4.3 Output...............................................................................................11
6.1.5 Search for City Information functional requirement:............................11
6.1.5.1 Input..................................................................................................11
6.1.5.2 Process.............................................................................................11
6.1.5.3 Output...............................................................................................12
6.1.6 Payment process.................................................................................12
6.1.5.1 Input..................................................................................................12
6.1.5.2 Process.............................................................................................12
6.1.5.3 Output...............................................................................................12
6.1.7 Get Analytical Reports.........................................................................12
6.1.7.1 Input..................................................................................................12
6.1.7.2 Process.............................................................................................12
6.1.7.3 Output...............................................................................................13
6.1.8 Maintain Advertisement details functional requirement:.....................13
6.1.8.1 Input..................................................................................................13

IBM CEIS Confidential


Project Design Document

6.1.8.2 Process.............................................................................................13
6.1.8.3 Output...............................................................................................13
7. Database Schema............................................................................................13
8. Test Cases........................................................................................................14

IBM CEIS Confidential


Project Design Document

Disclaimer

This Software Requirements Specification document is a guideline. The document details


all the high level requirements. The document should be used as a guideline by the
students to design the Solution Architecture for the project. The document also describes
the broad scope of the project and high level DB requirements are captured in the DB
specification. But while developing the solution if the developer has a valid point to add
more details being within the scope specified then it can be accommodated after
consultation.

IBM CEIS Confidential


Project Design Document

1. Scope
This document describes the scope of the requirements for the Smart City System
(SCS). The document details all the high level requirements with intent to validate the
portals requirements. This document should be used by the Architect and the developers
to design the Solution Architecture for the project. In addition to this, the document also
describes the broad scope of the project. The scope of the project involves the integration
of a subset of all the components of current IT environment.

The purpose is to create and managing a web portal to showcase your city for all it has in
terms of unique business, places to see, things to do, local transport for a new traveler,
best time to visit, road map, restaurants and hotels, shopping tips, properties for sale / rent
-etc. The site is expected to be revenue earner as well by charging the Advertisers and
customers for various services provided.

2. Assumptions
The following are the assumptions for this document
1. Any user accessing the site will be net savvy enough to create account on his/ her own.
2. Only Registered user can browse / search for information.

IBM CEIS Confidential


Project Design Document

3. Management Summary

A web portal is to be developed which will serve as essential local guide for living bigger,
better and smarter in your city. Covering various locations citywide, combine in-the-
know editorial recommendations, candid user comments and expert advice from local
businesses, and the portal will keep users connected to the most popular and
undiscovered places.

The portal will allow nominating and voting for various polls. Also, various campaigns
run throughout the year, including Best Restaurants, Best Nightlife, Best Spa & Beauty,
Best Shopping, Best Hotels and Best Services would be available on the portal. Member
can get registered by paying annual membership fees online. They should be able to
create profile and avail paid services like message alerts, information on good deals on
property, business, hotels -etc. They should be able to provide online feedback on
services provided.

IBM CEIS Confidential


Project Design Document

4. System Objectives / Overview

Figure 1 System Context Diagram

The diagram above explains the main conceptual elements in the solution and their
relationships with the architecture. Users will use Smart City to get information on key
markets and places to see, History of the city social, political, Overview of the
businesses in the city, Best time to Visit, Restaurants and Hotels-etc through the site.
Also, Advertisers would be able to Pay annual fees online and maintain Advertise details.
Smart City System (SCS ) Smart city system which is to be developed. It
manages to provide role based access to users.
Create profile and avail paid services like message
alerts, information on good deals on property,
business, hotels -etc.
DBMS Centralized Repository that need to be maintained

IBM CEIS Confidential


Project Design Document

to enable SCS to operate efficiently to provide


accuracy and swift response

5. Functional Requirements

The high level functional requirement for the Smart City System (SCS) is represented in
the Use Case diagram shown below. The remaining sections in the document describe the
major use cases.
Following are the identified functional requirements of the SC System
Provide role based access to the system (Authentication and Authorization)
1. Administrator To be able to Maintain City Details, Upload feedback surveys and
get analytical reports and Upload city news.
2. Registered User To search / browse city information.
3. Member- To get registered, to create profile and avail paid services, to provide
online feedback, to Participate in discussion.
4. Advertisers - To be Advertisers be able to pay annual fees online and Maintain
Advertise details.

IBM CEIS Confidential


Project Design Document

6. Use Case Diagram

IBM CEIS Confidential


Project Design Document

6.1. Detail Description of Use Cases

6.1.1. To Login functional requirement:

6.1.1.1 Input
User, Administrator, Member and Advertisers of the portal feed in UserName and
Password

6.1.1.2 Process
The system on receiving the details validates it with the database and provides role based
access to the SCS.
6.1.1.3 Output: System provides role based access to the SCS.

Administrator To be able to Maintain City Details, Upload feedback surveys and get
analytical reports and Upload city news.
Registered User To search / browse city information.
Member- To get registered, to create profile and avail paid services, to provide online
feedback, to Participate in discussion.
Advertisers - To be Advertisers be able to pay annual fees online and Maintain
Advertise details.

6.1.2 Upload feedback surveys functional requirement:

6.1.2.1 Input
Valid login by Administrator of Portal.

6.1.2.2 Process
Administrator of the Portal will upload feedback surveys received from the public.

6.1.2.3 Output
The system saves and updates the feedback.

IBM CEIS Confidential


Project Design Document

6.1.3 Enter Feedback functional requirement:

6.1.3.1 Input
Member valid login and enter / read feedback

6.1.3.2 Process
Members should be able to provide online feedback on services provided.

6.1.3.3 Output
The system updates the database.

6.1.4 Upload City News functional requirement

6.1.4.1 Input

Administrator valid login and the city news content for portal.

6.1.4.2 Process
Administrator uploads daily city news on the site. Thus, enabling users to get latest
updates about the city.

6.1.4.3 Output
The system updates the database.

6.1.5 Search for City Information functional requirement:

6.1.5.1 Input
Registered User valid login and request for city information.

6.1.5.2 Process
End user should be able to search for key markets and places to see, History of the city
social, political, Overview of the businesses in the city, Best time to Visit, Restaurants
and Hotels-etc through the site. System should be able to suggest Best Nightlife, Best Spa

IBM CEIS Confidential


Project Design Document

& Beauty, Best Shopping, Best Hotels and Best Services programs near to the user's
residence.

6.1.5.3 Output
The system displays the required information.

6.1.6 Payment process functional requirement:

6.1.5.1 Input
Administrator and Member valid login and transfer payment.

6.1.5.2 Process
Members get themselves registered by paying annual membership fees online. They
should be able to create profile and avail paid services like message alerts, information on
good deals on property, business, hotels etc. Advertisers should be able to pay annual
fees online to maintain advertisements on the site.
The system prompts for a fee, once the request is fulfilled. The member transfers the
payment to site bank account. The system enables the administrator retrieves the contact
details of the user and notifies immediately after the payment is completed.

6.1.5.3 Output
The system updates the database.

6.1.7 Get Analytical Reports functional requirement:

6.1.7.1 Input
Administrator valid login and get various analytical reports.

6.1.7.2 Process
System allows the user to get various Analytical Reports on services provided like list of
message alerts, information on good deals on property, business, and hotels. Admin
should be able to view payment due details of members and advertisers.

IBM CEIS Confidential


Project Design Document

6.1.7.3 Output
The system displays various Analytical Reports as requested.

6.1.8 Maintain Advertisement details functional requirement:

6.1.8.1 Input
Valid login by Advertisers registered on the Portal.

6.1.8.2 Process
Advertisers would be able to login and upload latest advertisements for which payment is
already done.

6.1.8.3 Output
The system saves and updates the data.

7. Database Schema
The proposed database schema is as follows:

1. User Details:
a) User ID (uniquely assigned by the system)
b) User Name
c) User Type
d) User Address
e) User Qualification
f) User Marital Status

2. Member Details:
a) Member ID (uniquely assigned by the system)
b) Member Name
c) Member Address

IBM CEIS Confidential


Project Design Document

d) Member Qualification
e) Member Marital Status

3. Advertisers Details:
a) Advertisers ID (uniquely assigned by the system)
b) Advertisers Name
c) Advertisers Type
d) Advertisers Address

4. Fees Payment Details:


a) User / Member Id
b) Amount Due
c) Due date
d) Payment Type

8. Test Cases
Sample Test cases for the login by Registered User and Administrator are as under based
on the following inputs:
UserID 6 digits (mandatory)
Password - 6-10 characters (mandatory)
1. After accepting these inputs, the user will be provided with access role based access to
the system ( Authentication and Authorization)
1. Administrator To be able to Maintain City Details, Upload feedback surveys and
get analytical reports and Upload city news.
2. Registered User To search / browse city information.
3. Member- To get registered, to create profile and avail paid services, to provide
online feedback, to Participate in discussion.
4. Advertisers - To be Advertisers be able to pay annual fees online and Maintain
Advertise details.

IBM CEIS Confidential


Project Design Document

Some of the test cases for the above Test Scenario:

Test Case No. Reference for Traceability Test Case Description and Expected Result
Test Data

1 Login screen
User ID < 6 digits Should not proceed
ahead, Please enter a 6
digit no

2
User ID = 6 digits Should proceed to the
next filed

3
User ID > 6 digits Should not permit entry
of more than 6 digits

4
User ID is Char data Should not permit entry
of character data

5
User ID is Alphanumeric Should not permit entry
of alphanumeric data

6
User ID is Blank Should not permit

7
Password < 6 char Should not be allowed

8
Password > 10 char Should not be allowed

9
Password is between 6 to Should be allowed
10 char

10
Password is Numeric data Should not permit entry
of Numeric data

11
Password is Blank Should not permit

12
User ID and Password Should be allowed
match

IBM CEIS Confidential


Project Design Document

13
User ID and Password does Should not be allowed
not match

IBM CEIS Confidential