smart city srs

SMART CITY Version 1.0Software Requirement Specification 05/10/2010AUTONOMOUS

SWAMI KESHVANAND INSTITUTE OF TECHNOLOGY, MANAGEMENT & GRAMOTHAN, JAIPUR

SMART CITYSOFTWARE REQUIREMENT SPECIFICATION

Submitted To Team Name

DEPARTMENT OF PRASH

INFORMATION TECHNOLOGY Team Members

PRADEEP RATHI

Project Guide PRATEEK SOMANI

Ms. NEHA AGARWAL RASHID ANWAR

SHASHANK CHATURVEDI

AUTONOMOUS / SKIT, JAIPUR


INDEXS. No. Content Page No.

1. Introduction 3-6

1.1 Purpose 3

1.2 Scope 3

1.3 Definition, Acronyms, and Abbreviations 4

1.4 References 5

1.5 Technologies 5

1.6 Overview 6

2. Overall Description 6-23

2.1 Product Perspective 6

2.2 Software Interface 7

2.3 Hardware Interface 7

2.4 Communication Interface 7

2.5 Product Function 8

2.6 User Characteristics 8

2.7 Constraints 8

2.8 Architecture Design 9

2.9 Use-Case Model Description 10

2.10 Class Diagram 13

2.11 Entity-Relation Diagram 16

2.11 Database design 19

2.12 Assumptions and Dependencies 22

3. Specific Requirements 23-49

3.1 Use-Case Reports 23

3.2 Supplementary Requirements 49



1. INTRODUCTION

1.1 Purpose

Smart city provides a web-based platform to a city for the quality it has like the business opportunities, hot tourist destinations, a guide to an outsider about everything he wants, and also charge money from people for using some paid services.

If you are desirous to give a web based platform to your city to be showcased for all it has in terms of unique business, places to see, things to do, use local transport for new traveler – how would you structure this information and also try and make some money by changing people for atleast 4 services you may offer.

1.2 Scope

Create different system users and assign different roles with related permissions.

Manage all the account details such as user name, company, phone numbers, address, email addresses of the entire

customer from one central location. Track all the customers and their contact details. Maintain the services provided to the customer through

Service Level agreements. Complete Map of the city with key markets and places to see

Marked –preferably usage of static map and live map option. Complete History of the city – social, political. Complete overview of the businesses in the city. Secure registration of all users including a personal profile –

only at the time of transaction providence. Complete Search/Site Map of the entire site for easy access. Start at least 4 paid services like SMS alerts for city news,

market daily rates etc.



Local news, government notices, update. Facilitate communication between user, experts and general

public through discussion forums/chats/mails/polls. Local language support at user-interface and database level.

1.3 Definition, Acronyms, and Abbreviations

SLA: Service Level Agreement is a formal written agreement made between two parties the service provider and the service recipient. It defines the term of engagement-the fundamental rules that will govern the relationship.

Support Transaction: Communication between support manager and the customer regarding the service provided, query and feedback.

Payment Transaction: Transaction between account manager and the customer for all the services being used.

Personal Details: Details of customer such as username, company, Address, e-mail etc.

Contact Details: Details of contact persons associated with the customer.

HTML: Hypertext Markup Language is a markup language used to Design static web pages.

JSP: Java Server Pages is used to create dynamic web content. EJB: Enterprise Java Beans. J2EE: Java 2 Enterprise Edition is a programming platform, part

of the java platform, for developing and running distributed multi-tier architecture java applications based largely on modular software components.

DB2: DB2 DataBase is the database management system that delivers a flexible and cost effective database platform to build Robust on demand business applications.



WAS: WebSphere Application Server is an application server that Runs business applications and supports the J2EE and web services Standards.

WSAD: WebSphere Studio Application Developer is a toolkit which is designed for the creation of the more complex projects, providing fully dynamic web application using EJB’S.

HTTP: HyperText Transfer Protocol is a transaction oriented client/Server protocol between web browser and web server.

SHTTP: Secure Hypertext Transfer Protocol is a HTTP over SSL. TCP/IP: Transmission Control Protocol/Internet Protocol, the

suite of Communication protocols used to connect hosts on the Internet.TCP/IP uses several protocols - two main ones being TCP and IP.

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

Ajax: Asynchronous Java Script and XML are 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

IEEE SRS Format Problem Definition (Provided by IBM) CT Arrington. Enterprise Java with UML. OMG Press.

1.5 Technologies

J2EE:(JSP, JAXP, Java Beans) Application Architecture JAVA: Application architecture. WASCE: (WebSphere Application Server Community Edition)

Web Server DB2: IBM Database.



Ajax: Asynchronous Java Script and XML. XML: Extension Markup Language. Web 2.0: RSS Feed 2.0. RAD 7.0: Development tool.

1.6 Overview

SRS will include two sections:- Overall Description will describe major components of the

system, Interconnection and external interfaces. Specific Requirements will describe the functions of actors,

their role in System and constraints.

2. OVERALL DESCRIPTION

Describe the general factors that affect the product and its requirements.

2.1 Product Perspective

The web pages (XHTML/JSP) are present to provide the user interface on customer client side. Communication between customer and server is provided through HTTP/HTTPS protocols.

The Client Software is to provide the user interface on system user client side and for this TCP/IP protocols are used. On the server side web server is for EJB and database server is for storing the information.



2.2 Software Interface Client on Internet: Web Browser, Operating System (any).

Client on Intranet: Client Software, Web Browser, Operating System (any).

Application Server: Web Sphere Application Server 7.0

DataBase Server: DB2, Operating System (any).

Development End:

Front End: Web Browser

Back End: WSAD (J2EE, Java Bean, HTML), DB2, OS, Web Server.

2.3 Hardware Interface

CLIENT SIDE

Processor RAM Disk space

Internet explorer 6.0 Pentium II at 500MHz 64 MB 1GB

SERVER SIDE

WEBSPHERE APPLICATION SERVER

V5.0

Pentium III at 1GHz 512 MB 2 GB

DB2 V8.1 Pentium III at 1GHz 512 MB 1 GB(excluding data size)

2.4 Communication Interface

Client on Internet will be using HTTP/HTTPS protocol. Client on Intranet will be using TCP/IP protocol.



2.5 Product Function

Track Account Level Data: In this module, receivables from customer are maintained.

Service Level Agreements: It contains the agreements of providing the services provided for service and customer.

User Contact Information: It maintains all the details (Personal, Official, Contact, and company of customer).

Track Support Transactions: Maintenance of transactions related to the services provided to the customer.

Maintaining Logs: Activities of the System Users can be tracked through the logs, which are maintained by the system.

2.6 User Characteristics

Every user should be comfortable of working with computer and net browsing.

2.7 Constraints

GUI is only in English. Login and password is used for identification of customer and

there is no facility for guest. This system is working for single server. There is no maintainability of back up so availability will get

affected. Limited to HTTP/HTTPS.



2.8 Architecture Design

Figure: - High Level Architecture of Smart City



2.9 Use-Case Model Description

USE CASE DIAGRAM



(A) Administrator

Responsible for managing system users, viewing logs and managing standard groups of the system.

Manage System Users: The Administrator will create different roles. The system users will be created and will be assigned with the different roles. More than one task and permissions can be granted or revoked from the system users.

View Logs: Responsible for checking the logs of different system user for auditing and maintaining the integrity of the system.

Manage Standard Groups: Standard groups will be created and updated by the administrator, which will be visible to all the system users.

View All Details: View the customer details, payment details, purchase details, daily service transaction details.

Update the system: updating of the information on system will be done.

(B) Support Manager

Responsible for managing and updating paid services, providing information on website for access by customer.

View All Details: View the customer details, payment details, daily service transaction details.

Manage paid services: management of paid services will be done.

Updating paid services: updating of paid services will be done.

Provide information: information on website for access purpose will be provided by support manager.



(C) Account Manager

Manage all the payment details (of the services used).

Manage Payment Transaction: Store all the payment transactions made by the customer and update the payment information.

View All Details: View the customer details, payment details, daily service transaction details.

(D) Help Manager

Responsible for handling online help and management of discussion forums etc.

Manage online help: management of online help will be done.

Manage discussion forums: management of discussion forums and chats etc will be done.

(E) Customer

Person/Company who is facilitated by the system.

View Own Details: Customer can view his personal details, payment details, details about services provided and the transaction details for the services.

Access information: Customer will access information on website for his usage.

Access paid services: Customer will access the paid services provided by the system like sms alerts.

Pay for paid services: Customer will pay for the paid services which he has subscribed to.



2.10 Class Diagram

(A) Administrator



(B) Support Manager



(C) Account Manager

(D) Help Manager



(E) Report

2.11 Entity-Relation Diagram

(A) Administrator



(B) Support Manager

(C) Account Manager



(D) Help Manager

(E) Report



2.12 Database Design

(A) Customer

S. No. Field Name Data Type Key Description1. Customer ID Varchar(20) Foreign,

PrimaryId of the customer

2. Name Varchar(50) Name of the customer3. User Name Varchar(20) User name of the customer4. Password Varchar(20) Password of the customer5. Father’s Name Varchar(50) Father’s name of the customer

6. Street Varchar(50) Street of the customer

7. City Varchar(40) City of the customer

8. District Varchar(40) District of the customer

9. State Varchar(40) State of the customer

10. Contact No. BIGINT Contact no of the Customer

11. E-Mail id Varchar(70) Mail id of the customer

12. D.O.B. Date D.O.B. of the customer

13. Profession Varchar(30) Profession of the customer

(B) Manager

S. No. Field Name Data Type Key Description1. Manager ID Varchar(20) Primary,

ForeignUnique user id of the manager

2. Name Varchar(20) Foreign Name of the manager3. User Name Varchar(20) User name of the customer4. Password Varchar(20) Password of the customer5. Address Varchar(50) Address of the manager6. Contact No. BIGINT Contact no. of the manager7. E-Mail ID Varchar(70) Mail id of the manager



(C) Employee

S. No. Field Name Data Type Key Description1. Employee ID Varchar(20) Primary,

ForeignUnique user id of the employee

2. Name Varchar(20) Foreign Name of the employee3. User Name Varchar(20) User name of the customer4. Password Varchar(20) Password of the customer5. Address Varchar(50) Address of the employee6. Contact No. BIGINT Contact no of the employee7. E-Mail ID Varchar(70) Mail id of the employee8. Specification Varchar(50)

(D) Account

S. No.

Field Name Data Type Key Description

1. Account No. Varchar(30) Account no of the user2. Account ID Varchar(20) Foreign Unique User id4. Type Varchar(20) Account type

5. Balance Double Amount in account

6. User name Varchar(50) Primary User Identification name

7. Password Varchar(40) Password of the account

(E) Palace

S. No. Field Name Data Type Key Description1. Palace ID Varchar(10) Primary Unique Id of the palace2. Name Varchar(50) Name of the palace3. City Varchar(40) City of the palace

4. District Varchar(40) District of the palace

5. State Varchar(40) State of the palace



6. Type Varchar(20) Type of the palace

(F) City

S. No. Field Name Data Type Key Description1. City ID Varchar(20) Foreign Unique User id of the city2. Name Varchar(30) Name of the city3. Description Varchar(900) Describe about the city

(G) Service

S. No. Field Name Data Type Key Description1. Service ID Varchar(20) Unique id for the service2. Name Varchar(100) Name of the service2. Description Varchar(500) Description of the service3. Price Integer Total cost about the service4. Duration Integer Duration of the service5. Facility Varchar(500) Facility provide by the service

(H) Agreement

S. No. Field Name Data Type Key Description1. SLA ID Varchar(20) Foreign Unique User id of agreement2. Customer ID Varchar(20) Customer id with agreement3. Service ID Varchar(20) Service id for type of service4. Description Varchar(500) Description of the agreement5. Rule Varchar(500) Rule of the agreement6. Terms &

ConditionsVarchar(200) Terms & Conditions of

agreement7. Total amount BIGINT Total amount of agreement8. Issue Date Date Issue date of the agreement9. End Date Date End date of the agreement



10. Days Integer Days of the agreement

(I) Receipt

S. No. Field Name Data Type Key Description1. Receipt No. Varchar(20) Receipt No.2. Customer ID Varchar(50) Customer id for give receipt3. Receipt Date Date Generate date of receipt4. Receipt Time Time Generate receipt time5. Service Name Varchar(100) Name of service provide6. City Name Varchar(30) Name of city7. Service Start

DateDate Start date of the service

agreement8. Service End

DateDate End date of the service

agreement9. Total Amount BIGINT Total amount of service

10. Pay Amount BIGINT Pay amount for take service11. Left Amount BIGINT Left amount pay the next time

(J) Report

S. No. Field Name Data Type Key Description1. Report No. Integer Primary Unique no of the report2. Date Date Date of the report3. Specification Varchar(200) Specification of the reports

4. Service Name Varchar(100) Name of the service of which report is generated

2.13 Assumptions and Dependencies

The details related to the product, customer, payment and service transaction provided manually.

Administrator is created in the system already.



Roles and tasks are predefined.

3. SPECIFIC REQUIREMENTS

3.1 Use-Case Reports

Objective

Smart City is a full-service communications provider across the nation and one of the world's largest communications providers to convention centers and hospitality venues. Smart City is a full service communications service provider, having emerged from the convergence of several communication service providers. Smart City has deep roots in telephony, broadband data and cable television, with a significant presence in the convention, hospitality and master planned community markets. Our story is the story of two pasts.

Smart City offers a competitive compensation package commensurate with experience and performance. In addition to base salary, many positions offer additional incentives for outstanding team and individual contributions. We provide our full-time team members with the resources they need, both in and out of the workplace through health and dental insurance, medical spending and dependent care spending accounts, basic life and supplemental life insurance, long-term disability coverage and 401(k) savings plan.

Key Objectives Smart City is an Equal Opportunity Employer and a Drug &

Smoke-Free Workplace. These axes are: a smart economy; smart mobility; a smart

environment; smart people; smart living; and, finally, smart governance.

To improve economic and political efficiency and enable social, cultural and urban development



To increase local prosperity and competitivenessbased on multi-actor, multi-sector, and multi-level perspectives.

We are well on our way to becoming a smart city. Smart City provides technologies that make our cities smarter

places to work, live, and play.

Key Module

(A) Administrator(B) Account Manager(C) Help Manager(D) User(E) Support Manager

(A) Administrator

Responsible for managing system users, viewing logs and managing standard groups of the system.

Manage System Users: The Administrator will create different roles. The system users will be created and will be assigned with the different roles. More than one task and permissions can be granted or revoked from the system users.

View Logs: Responsible for checking the logs of different system user for auditing and maintaining the integrity of the system.

Manage Standard Groups: Standard groups will be created and updated by the administrator, which will be visible to all the system users.

View All Details: View the customer details, payment details, purchase details, daily service transaction details.

Update the system: updating of the information on system will be done.



Name of use-case: View system users

Description: view the list of system users in a role and view the details of roles, tasks, permissions assigned

Pre-conditions:

Administrator has already logged in

System users have been already created & assigned some rules, tasks & permissions

Post-condition: None

Normal flow of events:

System user or role will be selected

Query will be submitted

Corresponding o/p will be generated

Alternate flow of events: None



Name of use-case: Create system users

Description: to create system users

Pre-conditions: Administrator has logged in

Post-condition: a login –id is generated


New login name, password, permissions, roles, tasks will be entered

Save the details

Alternate flow of events:

A message appears for duplicate login name

Administrator has to fill details again



Name of use-case: update details of users

Description: to update the details of users

Pre-conditions:


System users have already been created



Select username

Assign or revoke roles ,tasks , permission



Name of use-case: View logs

Description: To view activities of the system users

Pre-conditions:


System users have already been created



Select username

Select date



Name of use-case: View all details

Description: To view customer details, payment details etc

Pre-conditions:

Administrator has logged in

Customer is already having account



Select customer name

Select date



Name of use-case: Update information

Description: update information on system regarding tourist destinations, business spots, paid services etc

Pre-conditions: Administrator has logged in

Post-condition: System updated successfully


Validate information

Select the system area to be updated

Save the information



(B) Account Manager

Responsible for management of payment transaction

Management of payment transaction

View details

Receive payment

Acknowledgement for payment received



Name of use-case: Add payment transaction details

Description: All payment transaction details are entered

Pre-conditions: Account manager has logged in



Select customer

Select service

Select bill no.

Enter details of receivables

Save receivables details

Update account of customer

Entry of this adding details event has been logged


If the receivables will left to fill then system ask for refilling all the blank details then save details & update account of customer.



Name of use-case: Edit payment transaction details

Description: previously entered payment transaction details are entered




Select customer

Select service

Select receipt no.

Select payment transaction no.



Make changes

Save new details

Update customer account

Entry of this editing event has been logged

Name of use-case: Acknowledgement for payment received

Description: Acknowledgement for payment given by customer






Select customer

Select service

Select receipt no.

Select receivables details

Give acknowledgment

Update customer account

Entry of this acknowledgement event has been logged


If the receivables details are not there then system reports an error and ask for recheck.



(C) Help manager

Responsible for management of online help, discussion forums, chats etc.

Online help

Discussion forums

Name of use-case: Online help

Description: management of online help

Pre-conditions: help manager has logged in

Post-condition: System updated successfully


Select area for updation

Make changes

Store changes

System help updated successfully



Name of use-case: manage discussion forums, chats etc

Description: management of discussion forums chats etc.

Pre-condition: Help manager has already logged in

Post-condition: none


Select customer for help

Ask for query

Answer query



(D) User

User is the main person who will access the system. He will access his own details, information on website; he will access paid services and pay for them.

View own details

Access information on website

Access paid services

Pay for paid services



Name of use-case: View own details

Description: user will view his own details

Pre-condition: user has already logged in



Select the detail

See the detail



Name of use-case: Access of information on website

Description: user will access information on website




Select area to see

Access information in area



Name of use-case: Access paid services

Description: user will access the paid services



Select the paid services area

Select the paid service to see

Access details of paid services

Name of use-case: pay for paid services

Description: user will pay for the paid services for which he has subscribed




Post-condition: customer account updated successfully


Select service

See the details

Give receivable information

Account updated



(E) Support Manager

He is responsible for managing and updating the paid services. He is also responsible for providing information for updation of system.

View all details

Manage paid services

Update paid services

Provide information for access on website



Name of use-case: View all details

Description: support manager can view all details of customers like customer name, payment details etc

Pre-condition: support manager has already logged in.



Select the customer name

Select and see the detail



Name of use-case: Create paid services

Description: Creation of paid services

Pre-condition: Support manager has already logged in

Post-condition: paid services created successfully


Create paid services

Paid services created successfully



Name of use-case: View paid services

Description: to view the paid services and their details

Pre-condition: Support Manager has already logged in



Select the service to view

View details of service



Name of use-case: update the paid service

Description: update paid services


Post-condition: system updated successfully


Create new paid service

Store the changes

System updated successfully

The log detail of this updation event has been saved



Name of use-case: provide information for access on website

Description: Support manager will provide information for access purpose on Website.




Select the area for which information is to be updated

Provide information for area selected



3.2 Supplementary Requirements

Have hours of operation that are 24 x 7 - Because system can be an automated process, so it can stay open for 24 hours a day. If the base is now the entire world, staying open 24 hours a day becomes critical. System is required to be available 24X7 so UPS support must be on server site for at least 8 hours in case of power failure. System will remain inaccessible to users at 2:00 to 4:00 am for backup and maintenance purpose.

Reduce the cost of a sales transaction - To the extent that one can automate the sales process through this system, one can start to reduce the cost of that sales transaction. This is particularly true of mundane sales transactions where the customer knows what they want.

Make the existing Web site more dynamic in nature - Many early Web implementations consisted of static HTML pages. This becomes very difficult to manage if the number of pages gets too large. An effective system should be largely dynamic taking advantage of technology that automates this process rather than relying on manual processes.

Tie the existing Web site into existing enterprise systems – Any existing Web site that relies on the manual duplication of data from another system is one that can be improved. Most of the business data in the world today exists in enterprise servers that can be connected to the Web servers to make this process far more effective.

Provide good performance and the ability to scale the server – The Web Application Server should provide good performance and the ability to manage performance with techniques, such as support for caching, clustering, and load balancing.

Providing session management capability - Web application developers should not spend valuable time worrying about how to maintain sessions within the application. The Web Application Server should provide these services.


smart city srs

Documents

autonomous

asynchronous

existing web

manage standard

managing standard

manage discussion

provide good

service level