srs-smartcity.v1.0.0

Smart City Version 1.0

Software Requirements Specification December 28, 2010

CIT GEEKS

CIT GEEKS / <Calcutta Institute Of Technology>

CIT GEEKS

Smart City

Software Requirement Specification

Version 1.0 Team Guide: Mr. Safikul Alam (Sr. Lecturer) Members: Ashish Ranjan; Kunal Goswami; Mukesh Kumar; Dipak Kumar College Name: CALCUTTA INSTITUTE OF TECHNOLOGY Department: COMPUTER SCIENCE AND ENGINEERING State: WEST BENGAL



CIT GEEKS


Revision History

Date Version Description Author

2nd DEC 2010 0.1 Synopsis CIT GEEKS

25th DEC 2010 0.2 Final Revision CIT GEEKS

28th DEC 2010 1.0 Sent For Approval CIT GEEKS



CIT GEEKS


Table of Contents

1. INTRODUCTION: ............................................................................................................................................4

1.1 Purpose: ....................................................................................................................................................4

1.2 Scope: ........................................................................................................................................................4

1.3 Definitions, Acronyms, and Abbreviations: ..........................................................................................5

1.4 References:...............................................................................................................................................5

1.5 Technologies to be used: .......................................................................................................................5

1.6 Overview: ..................................................................................................................................................6

2. OVERALL DESCRIPTION: ............................................................................................................................8

2.1 Product Perspective: ...............................................................................................................................8

2.2 Software Interface: ...................................................................................................................................9

2.2.1 Front End Client: ..............................................................................................................................9

2.2.2 Web Server: ......................................................................................................................................9

2.2.3 Data Base Server: ...........................................................................................................................9

2.2.4 Back End: ..........................................................................................................................................9

2.3 Hardware Interface: .................................................................................................................................9

2.3.1 Client Side: ........................................................................................................................................9

2.3.2 Server Side: ......................................................................................................................................9

2.4 Product Functions: ...................................................................................................................................9

2.5 User Characteristics: ............................................................................................................................ 13

2.6 Constraints: ............................................................................................................................................ 15

2.7 Architecture Design: ............................................................................................................................. 15

2.8 Use Case Diagram: .............................................................................................................................. 18

2.9 Class Diagram: ...................................................................................................................................... 19

2.10 Sequence Diagrams: ............................................................................................................................ 20

2.10.1 Database Design: ......................................................................................................................... 20

2.10.2 ER Diagram: .................................................................................................................................. 26

2.11 Assumptions and Dependencies: ....................................................................................................... 28

3. SPECIFIC REQUIREMENTS: .................................................................................................................... 29

3.1 Use Case Reports: ............................................................................................................................... 29

3.2 Supplementary Requirements: ........................................................................................................... 29



CIT GEEKS


Software Requirements Specification

1. INTRODUCTION: This Software Requirements Specification provides a complete description of all the functions and specifications of the Smart City Web Application (SCA).

1.1 Purpose: SCA solution provides web based platform to listed city to be showcased for all it has in terms of unique business, places to see, things to do, use local transport for a new traveler, different paid services which help to grow business in selected city. This solution is community based where different users can enter their City details which will further approved by site admin before publishing. They can even change other entries if they feels information is not accurate. This document is being shared between following audiences:

CIT Geeks

College Faculty (Mentor)

IBM Team

The expected users of this application are:

Anyone looking for information of your city

Tourists coming to your city

Businessmen coming to your city

People trying to get some help to do business remotely

1.2 Scope:

SCA is designed to fulfill following functional requirement:

City Map: Complete Map of the city with key markets and places to see marked – preferably usage of static map and live Map option

City History: Complete History of the city – social, political

Around the City: Restaurants, Clubs, Local Events, Attractions, Gallery

Shop & Business: Complete overview of the shopping centers and businesses in the city

SmartCity Users: Secure registration of all users including a personal profile – only at the time of a transaction providence

SmartCity Search: Complete Search/Site Map of the entire site for easy access

Paid Services: Paid services like SMS alerts for city news, market daily rates, advertises

News & Notices: Local news, government notices, update

SmartCity Connections: Facilitate communication between user, experts and general public through - Discussion forum/chat/mail/polls

Local language support at user-interface and database level

Downloadable guided city tour video/PPTs/animated movie

Engage local media and police and other government department like passport to make your portal more useful

Customizable color schemes or skins

Google Analytics to track traffic on portal



CIT GEEKS


1.3 Definitions, Acronyms, and Abbreviations:

SCA: Smart City Web Application

HTML 5.0 (Hyper Text Markup Language): It is used to create static web pages.

JSP (Java Server Pages): It is used to create dynamic web content.

J2EE (Java 2 Enterprise Edition): It is a programming platform, belonging to the Java platform, which is used for developing and running distributed java applications.

WASCE (WebSphere Application Server Community Edition): It is an application server that runs and supports the J2EE and the web service applications.

WSAD (WebSphere Studio Application Developer): It is a designer toolkit which is designed to develop more complex projects by providing a complete dynamic web service.

DB2 (IBM Database 2): It is a database management system that provides a flexible and efficient database platform to raise a strong "on demand" business applications.

HTTP (Hyper Text Transfer Protocol): It is a transaction oriented client/ server protocol between a web browser and a web server.

XML (Extensible Markup Language): It is a markup language that was designed to transport and store data.

Ajax (Asynchronous Java Script and XML): It is a technique used in java script to create dynamic web pages.

Web 2.0: It is commonly associated with web applications which facilitate interactive information sharing, interoperability, user-centered design and collaboration on the World Wide Web.

1.4 References:

Wikipedia (www.wikipedia.com)

The principal source of textbook material is “Software Engineering: An Object- Oriented Perspective” by Eric J. Bruade (Wiley 2001)

http://oreilly.com/web2/archive/what-is-web-20.html

http://validator.w3.org/

Different books on development tools

1.5 Technologies to be used:

J2EE: (Servlet, JSP, JAXP, Java Beans) Application architecture.

JAVA: Application architecture.

WASCE: (WebSphere Application Server Community Edition) Web Server

DB2: IBM Database.

MYSQL: MySQL database.

Ajax: Asynchronous Java Script and XML.

XML: Extension Markup Language. Web 2.0: RSS Feed 2.0.

RAD 7.0: Development tool.

LOCALIZATION: 2 Languages - Hindi and English

JASPER: Report Development

FUSIONCHARTS: Charting tools

ErStudio: Database designing tool

http://www.wikipedia.com/

http://oreilly.com/web2/archive/what-is-web-20.html

http://validator.w3.org/



CIT GEEKS


1.6 Overview:

Overall Description:

SCA will completely build on web based architecture. Functionally it is community based design where user can come and login and update their city details which will be further get approved by Admin. Once changes are approved from the admin, mail will be sent to the user and content will be published on the live site. Whole website will be accessed on the basis of selected city. User must have to personalize their city on the site and then they can get the further details of city. Those details include static/Dynamic map, history, things around the city, business etc. We can group following major component of the system: USER BASED INTERFACES (Public):

City Selection

City Map (Static & Dynamic)

City History (Social & Political)

Around the City (Restaurants, Clubs, Events, Attractions, Gallery)

Shopping & Businesses (Shopping Spots, Businesses)

News & Market (Local News, Government Notices, Market Rates)

Polls

Advertisements USER BASED INTERFACES (Logged/Paid):

Chat Engine(Logged Users)

Discussion Forum (Logged Users)

Content Suggestion(Logged Users)

Event Request (Logged Users)

Gallery Upload (Logged users)

Key Statistics of City (Logged Users)

Market Update (SMS Based – Paid Users)

News Update (SMS Based – Paid Users)

Client contacts (SMS Based – Paid Users)

Business Listing (For Paid Users)

News & Notice Manager (For Specific Users) ADMIN BASED INTERFACES:

User Manager

Global Configuration

Menu Manager (Main Menu/User Menu/Component Menu)

Section Manager

Category Manager

Article Manager (Update different details of City)

Gallery Manager

Event Manager

Statistics Manager

SMS Manager

Contact Manager

Chat Manager

Forum Manager

News & Notice Manager

Poll Manager



CIT GEEKS


Search Manager

Advertisement Manager

Shopping & Business Manager

Web Links Manager

Module Manager

Theme Manager

Language Manager

Mail Manager

Review Manager

Manage Inappropriate

Google Analytics

Specific Requirements: SCA system is majorly used by following types of users and their roles as listed:

1. General Public: Site browsing, User profile, City Search etc

2. Tourists: City Details, attractions, Pictures, City guide etc

3. Government Employees (Inc. Police): Public notices, news etc

4. Businessmen: Business opportunities around the city, Statistics etc

5. Admin Team: Site management

Reports: There are different statistics based reports which will be accessed by registered users and admin.

User Level: o Population Report o City Sex Ratio Report o Area Report o Health Report o Agriculture Report

Admin Level: o User Traffic Details o Banner Impression Report o Review Report o Payment Report



CIT GEEKS


2. OVERALL DESCRIPTION:

2.1 Product Perspective: SCA is unique idea which provides platform for each city where users can come and contribute the content of listed city. They will also be benefited with service offered by application. This application is completely based on web community. Mainly there will be three component of the system.

Client Interface

Admin Interface

Third Party Application integration High Level Product (Context level DFD):



CIT GEEKS


2.2 Software Interface:

2.2.1 Front End Client:

Front end of this application will be web interface which can be accessible on Internet Explorer 6.0+, Firefox 3.0+, Chrome, and Safari (HTTP/HTTPS). JQuery/HTML/AJAX

2.2.2 Web Server: WebSphere Application Server / JBoss / Tomcat

2.2.3 Data Base Server: DB2/MySQL

2.2.4 Back End:

J2EE/JSP/Servlet

2.3 Hardware Interface: Server will be hosted on the internet with 24*7 availability. Normal User can access website and admin will have access of both Web Admin as well as server access.

2.3.1 Client Side: Windows, Mac, Linux, Unix etc which ever support Web Browsers. Client should have minimum 64 MB RAM, 10 GB HDD.

2.3.2 Server Side: Server should LINUX (UBUNTU), RAM 8 GB, HDD 1 TB, INTEL SERVER Processor Family, High Internet Connection

2.4 Product Functions: Here we are explaining different modules of the whole system:



CIT GEEKS


USER BASED INTERFACES (Public):

City Selection: We will place city selection module on top of the site. So, that user can select and choose this first entry point. They may personalize this city as their default page.

City Map (Static & Dynamic): There will Map menu with two options “Static Map” and “Dynamic Map”. We will use Google Map for dynamic mapping of city. Static will also have some basic level of zoom in and zoom out facility. This static map will point all important places into it.

City History (Social & Political): City history menu will again have two options “Social history” and “Political History”. We will Put all detail in each page so that user can get idea of city they visiting. These content will be suggested by registered users which further approved by Admin.

Around the City (Restaurants, Clubs, Events, Attractions, Gallery): We will list following items under this menu.

Restaurants around the selected city Clubs around the selected city Different ongoing events in the city Attractions for the tourists in the city Photo galleries of the selected City

Shopping & Businesses (Shopping Spots, Businesses): This menu will focus on shopping spots around the city and Businesses available in the city. These two will be submenu of this category. Businesses will be listed by different businessman through the site.

News & Market (Local News, Government Notices, and Market Rates): In this category we will show following submenus with corresponding details.

Local News: All local news will be listed here with the option of date selection along with next/previous button. This will directly posted the local news providers.

Government Notices: This will be posted by the different government officials. In some cases admin will add those notice if received via mail.

Market Rates: This section will provide current local commodities market rates.



CIT GEEKS


Polls: Weekly polls (City wise) will be key factor to attract different level users. These statistics will help site user hits.

Advertisements: Once site will have enough regular user hits, we will show geographical specific advertisement. There will external providers of these ads (Like Google ads). This will one of source of revenue.

USER BASED INTERFACES (Logged/Paid):

Chat Engine (Logged Users): As this site will is kind of community based application so we will also provide City wise chat rooms where users can share their idea in real time.

Discussion Forum (Logged Users): Discussion forums will city + category specific where users can post their new idea and also others can comment on them.

Content Suggestion (Logged Users): This is one of the key features of the site. As it is hard and copyrights issues to collect data for different city, we will give unique feature to give access to users to suggest different content area which will further get approved by Admin. They can also upload different gallery with city images.

Key Statistics of City (Logged Users): We will provide customizable data statistics like population, area-wise, sex-wise, city health, business, Agriculture growth etc.

Event Request: User can ask to schedule and list events on the city of the specific city which will be approved by the admin.

Gallery Upload: Registered user can upload photo gallery for the specific city which will be further approved by the admin.

Market Update (SMS Based – Paid Users): We will provide market update via SMS to the subscribed users.

News Update (SMS Based – Paid Users): We will provide news update via SMS to the subscribed users.

Client contacts (SMS Based – Paid Users): We will provide contact hits details via SMS to the subscribed users once somebody click on their listed business.

Business Listing (For Paid Users): We will provide business listing facility under different category so that it can easily available to users when they need such information. They may click and contact those business owners via this site,

News & Notice Manager (For Specific Users): We will given authority to different government offices, sheriff/police department via this they can post different notices on the city.

ADMIN BASED INTERFACES:

User Manager: Site admin can manage different users registered via web admin feature.

Global Configuration: Site admin can manage global configuration of the site via this link on admin page.



CIT GEEKS


Menu Manager (Main Menu/User Menu/Component Menu): There will option to add/delete/modify different level of menus including modules menus.

Country/State/City Manager: Add/Modify/Delete different city of selected country. Add/Edit/Delete Country Add/Edit/Delete State Add/Edit/Delete City

Section Manager: This will be top level category of city details. Following section will be the part of this. City Map City History Around the city Shopping & Business News

Category Manager: This will be second level (Sub-category) category of articles. Following items will be the part of it (Marked with circle):

City Map o Static Map o Dynamic Map

City History o Social History o Political History

Around the city o Restaurants & Clubs o Events o Attractions o Gallery

Shopping & Business o Shopping Spots o Business Listings

News o Local News o Governments Notices o Market Updates

Article Manager: Update different details of City details according to their category. There will additional page with each article as suggested contents given by users. Admin needs to select/merge and publish as final content. All the processed contents will be notified to the user with making him star of the site and will be listed on the top of the page.

Gallery Manager: User can create different gallery which will be approved by the admin before posting it back to the site. There could be multiple galleries associated with the site.

Event Manager: There will be different event listing on the site basis of different day. It will be either suggested by the registered user or added by the admin.

Statistics Manager: Admin will keep updating different kind of statistics of the city. These statistics includes population, area-wise, sex-wise, city health, business, Agriculture growth etc.

SMS Manager: Admin will keep track of message sent to the users like market update, contacts, news etc.

Contact Manager: This admin feature will list all the contact us details. Admin can make their decision



CIT GEEKS


accordingly.

Chat Manager: This part is used to track all chat made by different users at different city levels. Other chat level configuration is also managed by admin.

Forum Manager: Admin will manage forum, topics on forum, users posting etc.

News & Notice Manager: All news and notices posted by different level of users will be reviewed and approved by admin. There could be some case where admin approval does not require.

Poll Manager: There will weekly poll hosted by the admin.

Search Manager: This will keep track of all searched made by the users and admin will use tis statistics for business purpose.

Advertisement Manager: Admin will manage different banner/ads and their impressions. These ads might be requested by different business owners.

Shopping & Business Manager: This is yellow pages kind of listing where admin will upload all shopping and business around the city.

Web Links Manager: Site will have different external web links which will be managed by the admin.

Module Manager: Every module like chat, forum, news etc will be managed and added by admin. Admin can activate/deactivate any of them any time. This will help in application scalability.

Theme Manager: There will be different kind themes which admin can activate for different city levels.

Language Manager: Site will have language intelligence which help to serve different regions in their local languages.

Mail Manager: This module will used to manage mass mails, user request etc.

Review Manager: This module will keep track of every kind of reviews provides by the users on each separate items.

Manage Inappropriate: Users can mark any content as inappropriate which will be further managed by admin.

Google Analytics: Site will be Google analytics enabled which help to check site traffic and help for business decision.

Payment Gateway: Payment gateway integration with Paypal.

2.5 User Characteristics: There will be various kinds of users on the site. Majorly they belongs to these groups.

1. General Public:

Details of city

Maps

Events



CIT GEEKS


Attractions

Gallery

Reviews

Polls

Forum & Chat

News & Notice

Payment for Services availed

Different Statistics of City

2. Tourists

Details of city

Maps of the city

Events list

Attractions

Gallery

News

3. Government Employees (Inc. Police)

News

General Public Notices


4. Local Businessmen

Market Updates

Business Listings


Payment for Services availed

Reviews

5. Remote Businessmen

Local Business details


Admin Team

Manage different level of User

Global configuration of the site

Menu management

Different sections management of site

Category management of contents

Article approval posted by different users

Article Management (Update different details of City)

Gallery Management and approval

Event Management and publishing

Statistics entry and Management

SMS Management for different services provided by the site

Contact Management sent by different users

Chat Management and tracking

Forum Management and tracking

News & Notice posting managements

Poll Management and posting

Search analysis and Management

Advertisement approval and Management



CIT GEEKS


Shopping & Business Management

Web Links Managements

Module creation and Management

Theme Management

Language Management

Mail Management and mass mailing

Review Management

Google Analytics Management

2.6 Constraints: We tried to solve all potential constraints but every system does have some limitation/dependency/constraints. Here we mentioned few of them:

Data entry for different cities is one if constraints which needs to address correctly. Current we kept user will suggest their City details. If it works properly. We May need to collect data from different source.

SEO of the site is one of the key constraints which make this business successful.

Loads of Admin approval needed in order to publish the content. We may introduce some automated process in future.

Multilingual Site is one of the challenges as there is wide range of Language in the world. India itself has loads of language.

Future Scope:

Automation of approval process

iPhone/Android application for SCA

User Profile and friend listing

2.7 Architecture Design: SCA application is MVC based architecture where we will separate out user view, business logic controller and backend model. Whole application User interface will be developed separate and then it will be connected with controller and Model. Model will be responsible for database level jobs.

Here we mentioned some second level DFD for major functions in the site.



CIT GEEKS


DFD (For General Users):

DFD (For Logged users):



CIT GEEKS


DFD (For Admin):



CIT GEEKS


2.8 Use Case Diagram:



CIT GEEKS


2.9 Class Diagram:



CIT GEEKS


2.10 Sequence Diagrams:

2.10.1 Database Design: Core Site level configurations:

Site Modules/Menu configurations:



CIT GEEKS


Site Modules/Menu configurations:

Site Poll Tables:



CIT GEEKS


Site City and Content Tables:



CIT GEEKS


Site banner and ad management Tables:



CIT GEEKS


Forum Management Tables:



CIT GEEKS


Business/Shopping Listing Management Tables:



CIT GEEKS


2.10.2 ER Diagram:

Here we important entity relations for SCA application: High Level:

User Level:



CIT GEEKS


City Level:

Configuration Level:



CIT GEEKS


2.11 Assumptions and Dependencies: Following assumptions has been made for SCA development:

No Assumptions To Be Validated By

Status Comment

1 There will be large amount of users/registered users will be of SCA application after year of successful live. Application has been designed as per this assumption.

Mentor Open

2 Whole system is assumed on the basis of free/community based software. In case of there will be any licensing issue we may change development tool.

Mentor Open

3 There will be different layout for initial page. Once user will select their city main city page will get loaded.

Mentor Open

4 Code should be checked in some CVS software Mentor Open

5 Testing Strategy needs to be decided Mentor Open

Following dependencies has been identified for SCA development:

No Owner Dependency Comment

1 Team SMS software which needs to be plugged in Needs to purchase

2 Team Initial data entry to make site live Needs to be gathered

3 Team Site Design Will be decided

4 Team Payment Gateway Integration May Be Paypal



CIT GEEKS


3. SPECIFIC REQUIREMENTS:

3.1 Use Case Reports: Index of Use-Cases (Added high level use case report):

UseCase UC #

Add City and Details UC1.1

Register user UC1.2

Browse City UC1.3

Suggest Content UC1.4

Admin Approval UC1.5

UC 1.1 (Add City and Details):

Description: Admin needs to add city and it’s content. Actor: Admin Pre Condition: There should be valid state and country and new city should not exist before. Non-Functional Requirement: NA

UC 1.2 (Register User):

Description: Anybody can come and join SCA app. Actor: General Public Pre Condition: There should be valid mail id. Non-Functional Requirement: NA

UC 1.3 (Browse City):

Description: User can browse city and its content. Actor: General Public Pre Condition: There should be valid session of the user and they must select desired city. Non-Functional Requirement: NA

UC 1.4 (Suggest Content):

Description: User can come and suggest contents for City. They can upload photo gallery. Actor: Registered User Pre Condition: There should be valid user id and password. Non-Functional Requirement: NA

UC 1.5 (Admin Approval):

Description: All contents added by users must be validated and approved by admin. Actor: Admin Pre Condition: There should be valid details. Non-Functional Requirement: NA

3.2 Supplementary Requirements: We have tried to list the entire requirement above. However, there are few point which need to be added along with above:

Testing Strategy o Unit Level o System Testing o Performance Testing

Security Level decision

Site implementation Server

srs-smartcity.v1.0.0

Documents