Srs Smart City Edit

Published on March 2017 | Categories: Documents | Downloads: 39 | Comments: 0 | Views: 205
of 53
Download PDF   Embed   Report

Comments

Content

SRM UNIVERSITY

SMART CITY
SOFTWARE REQUIREMENT
SPECIFICATION (DEPARTMENT OF SWE)
BY :
SAGAR VIRMANI
(1201310080)
KISHAN PADARIYA
(1201310122)

Page 1

INDEX
S. 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

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

6-23

3.

Specific Requirements

3.1

Use-Case Reports

23

3.2

Supplementary Requirements

49

Page 2

23-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 at least 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.

Page 3

 Complete Search/Site Map of the entire site for
easy access.
 Start at least 4 paid services like S.M.S 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
 S.L.A: 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.
 J.S.P: 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 multitier architecture java

Page 4


















Page 5

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: Web sphere Application Server is an
application server that Runs business applications
and supports the J2EE and web services
Standards.
WSAD: Web sphere 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 Intenet. 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, inter-operatibility, usercentered design and collaboration on the World
Wide Web.

1.4

References




1.5

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

Technologies
 J2EE:(JSP, JAXP, Java Beans) Application
Architecture
 JAVA: Application architecture.
 WASCE: (Web sphere 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

Page 6

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

Page 7

Hardware Interface

CLIENT SIDE

Internet explorer
6.0

Processor

RAM

Disk space

Pentium II at
500MHz

64 MB

1GB

Pentium III at
1GHz

512
MB

2 GB

Pentium III at
1GHz

512
MB

1 GB(excluding
data size)

SERVER SIDE
WEB SPHERE
APPLICATION
SERVER V5.0
DB2 V8.1

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.

Page 8

2.6

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

2.7

Constraints






2.8

Page 9

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.

Architecture Design

Figure: - High Level Architecture of Smart City

2.9

Page 10

Use-Case Model Description

USE CASE DIAGRAM

Page 11

(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:
services will be done.

management

of

paid

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

Page 12

 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
discussion forums and chats etc will be done.

of

(E) Customer
Person/Company who is facilitated by the system.

Page 13



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
information on website for his usage.



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

will

access



2.10

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

Class Diagram
(A) Administrator

Page 14

(B) Support Manager

Page 15

(C) Account Manager

Page 16

(D) Help Manager

(E) Report
Page 17

2.11

Entity-Relation Diagram
(A) Administrator

(B) Support Manager

Page 18

(C) Account Manager

(D) Help Manager
Page 19

(E) Report

2.12
Page 20

Database Design

(A) Customer
S.
No.
1.

Field Name
Customer ID

2.

Name

3.

User Name

4.

Password

5.
6.

Father’s
Name
Street

7.

City

8.

District

9.

State

10.

Contact No.

11.

E-Mail id

12.

D.O.B.

13.

Profession

Data
Type
Varchar(2
0)

Varchar(5
0)
Varchar(2
0)
Varchar(2
0)
Varchar(5
0)
Varchar(5
0)
Varchar(4
0)
Varchar(4
0)
Varchar(4
0)
BIGINT

Key

Description

Foreign Id of the customer
,
Primar
y
Name of the customer
User
name
of
the
customer
Password
of
the
customer
Father’s name of the
customer
Street of the customer
City of the customer
District of the customer
State of the customer
Contact
no
of
the
Customer
Mail id of the customer

Varchar(7
0)
Date

D.O.B. of the customer

Varchar(3
0)

Profession
customer

of

the

(B) Manager
S.
No.
1.

Field Name
Manager ID

Page 21

Data
Type
Varchar(2

Key

Description

Primar

Unique user id of the

0)
2.

Name

3.

User Name

4.

Password

5.

Address

6.

Contact No.

7.

E-Mail ID

Varchar(2
0)
Varchar(2
0)
Varchar(2
0)
Varchar(5
0)
BIGINT

y,
manager
Foreign
Foreign Name of the manager
User
name
of
the
customer
Password
of
the
customer
Address of the manager
Contact
no.
of
the
manager
Mail id of the manager

Varchar(7
0)

(C) Employee
S.
No.
1.

Field Name
Employee ID

2.

Name

3.

User Name

4.

Password

5.

Address

6.

Contact No.

7.

E-Mail ID

8.

Specification

Page 22

Data
Type
Varchar(2
0)
Varchar(2
0)
Varchar(2
0)
Varchar(2
0)
Varchar(5
0)
BIGINT
Varchar(7
0)
Varchar(5
0)

Key

Description

Primar Unique user id of the
y,
employee
Foreign
Foreign Name of the employee
User
name
of
the
customer
Password
of
the
customer
Address of the employee
Contact no of
the
employee
Mail id of the employee

(D) Account
S.
No.
1.

Field Name
Account No.

2.

Account ID

4.

Type

5.

Balance

6.

User name

7.

Password

Data
Type
Varchar(3
0)
Varchar(2
0)
Varchar(2
0)
Double
Varchar(5
0)
Varchar(4
0)

Key

Description
Account no of the user

Foreign Unique User id
Account type
Amount in account
Primar
y

User Identification name
Password of the account

(E) Palace
S.
No.
1.

Field Name
Palace ID

2.

Name

3.

City

4.

District

5.

State

6.

Type

Data
Type
Varchar(1
0)
Varchar(5
0)
Varchar(4
0)
Varchar(4
0)
Varchar(4
0)
Varchar(2
0)

Key
Primar
y

Description
Unique Id of the palace
Name of the palace
City of the palace
District of the palace
State of the palace
Type of the palace

(F) City
S.

Field Name

Page 23

Data

Key

Description

No.
1.

City ID

2.

Name

3.

Description

Type
Varchar(2
0)
Varchar(3
0)
Varchar(9
00)

Foreign Unique User id of the city
Name of the city
Describe about the city

(G) Service
S.
No.
1.

Field Name
Service ID

2.

Name

2.

Description

3.

Price

4.
5.

Duration
Facility

Data
Type
Varchar(2
0)
Varchar(1
00)
Varchar(5
00)
Integer

Key

Description
Unique id for the service
Name of the service
Description
of
the
service
Total cost about the
service
Duration of the service
Facility provide by the
service

Integer
Varchar(5
00)

(H) Agreement
S.
No.
1.

Field Name
SLA ID

2.

Customer ID

3.

Service ID

4.

Description

5.

Rule

Page 24

Data
Type
Varchar(2
0)
Varchar(2
0)
Varchar(2
0)
Varchar(5
00)
Varchar(5

Key

Description

Foreign Unique
User
id
of
agreement
Customer
id
with
agreement
Service id for type of
service
Description
of
the
agreement
Rule of the agreement

7.

Terms &
Conditions
Total amount

00)
Varchar(2
00)
BIGINT

8.

Issue Date

Date

9.

End Date

Date

Days

Integer

6.

10.

Terms & Conditions of
agreement
Total
amount
of
agreement
Issue
date
of
the
agreement
End
date
of
the
agreement
Days of the agreement

(I) Receipt
S.
No.
1.

Receipt No.

2.

Customer ID

3.
4.
5.

Receipt Date
Receipt Time
Service
Name
City Name

6.
7.
8.
9.
10.

Field Name

Service Start
Date
Service End
Date
Total Amount
Pay Amount

Page 25

Data
Type
Varchar(2
0)
Varchar(5
0)
Date
Time
Varchar(1
00)
Varchar(3
0)
Date
Date
BIGINT
BIGINT

Key

Description
Receipt No.
Customer id for give
receipt
Generate date of receipt
Generate receipt time
Name of service provide
Name of city
Start date of the service
agreement
End date of the service
agreement
Total amount of service
Pay amount for take
service

11.

Left Amount

BIGINT

Left amount pay the next
time

(J) Report
S.
No.
1.

Field Name
Report No.

2.
3.

Date
Specification

4.

Service
Name

2.13

Data
Type
Integer

Key
Primar
y

Date
Varchar(20
0)
Varchar(10
0)

Description
Unique no of the report
Date of the report
Specification
of
the
reports
Name of the service of
which
report
is
generated

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
Page 26

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 fulltime 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 competitiveness
based on multi-actor, multi--sector, and multilevel 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
Page 27

(B)
(C)
(D)
(E)

Account Manager
Help Manager
User
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.

Page 28

 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
Preconditions:
 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

Page 29

 Name of use-case: Create system users
Description: to create system users
Preconditions: Administrator has logged in
Post-condition: a login –id is generated
Normal flow of events:
 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

Page 30

 Name of use-case: update details of users
Description: to update the details of users
Preconditions:
 Administrator has already logged in
 System users have already been created
Post-condition: None
Normal flow of events:
 Select username
 Assign or revoke roles ,tasks , permission

Page 31

 Name of use-case: View logs
Description: To view activities of the system users
Preconditions:
 Administrator has already logged in
 System users have already been created
Post-condition: None
Normal flow of events:
 Select username
 Select date

Page 32

 Name of use-case: View all details
Description: To view customer details, payment details etc
Preconditions:
 Administrator has logged in
 Customer is already having account
Post-condition: None
Normal flow of events:
 Select customer name
 Select date

Page 33

 Name of use-case: Update information
Description: update information on system regarding
tourist destinations, business spots, paid services etc
Preconditions: Administrator has logged in
Post-condition: System updated successfully
Normal flow of events:
 Validate information
 Select the system area to be updated
 Save the information

Page 34

(B) Account Manager
Responsible for management of payment transaction
 Management of payment transaction
 View details
 Receive payment
 Acknowledgment for payment received

Page 35

 Name of use-case:
details

Add payment transaction

Description: All payment transaction details are entered
Preconditions: Account manager has logged in
Post-condition: None
Normal flow of events:
 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
Alternate flow of events:
 If the receivables will left to fill then system ask for
refilling all the blank details then save details &
update account of customer.
Page 36

 Name of use-case:
details
Description: previously
details are entered

Edit payment transaction
entered

payment

Preconditions: Account manager has logged in
Post-condition: None
Normal flow of events:
 Select customer
 Select service
 Select receipt no.
 Select payment transaction no.
Page 37

transaction

 Make changes
 Save new details
 Update customer account
 Entry of this editing event has been logged

 Name of use-case: Acknowledgment for payment
received
Description: Acknowledgment for payment given by
customer
Preconditions: Account manager has logged in
Post-condition: None
Normal flow of events:
Page 38

 Select customer
 Select service
 Select receipt no.
 Select receivables details
 Give acknowledgment
 Update customer account
 Entry of this Acknowledgment event has been logged
Alternate flow of events:
 If the receivables details are not there then system
reports an error and ask for recheck.

(C) Help manager
Page 39

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
Preconditions: help manager has logged in
Post-condition: System updated successfully
Normal flow of events:
 Select area to update
 Make changes
 Store changes
 System help updated successfully

Page 40

 Name of use-case: manage discussion forums,
chats etc
Description: management of discussion forums chats etc.
Preconditions: Help manager has already logged in
Post-condition: none
Normal flow of events:
 Select customer for help
 Ask for query
 Answer query

Page 41

(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

Page 42

 Name of use-case: View own details
Description: user will view his own details
Preconditions: user has already logged in
Post-condition: None
Normal flow of events:
 Select the detail
 See the detail

Page 43

 Name of use-case: Access of information on
website
Description: user will access information on website
Preconditions: user has already logged in
Post-condition: none
Normal flow of events:
 Select area to see
 Access information in area

 Name of use-case: Access paid services

Page 44

Description: user will access the paid services
Preconditions: user has already logged in
Normal flow of events:
 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
Preconditions: user has already logged in
Post-condition: customer account updated successfully
Normal flow of events:
Page 45

 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
update of system.
Page 46

 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

Page 47

Preconditions: support manager has already logged
in.
Post-condition: none
Normal flow of events:
 Select the customer name
 Select and see the detail

Name of use-case: Create paid services
Description: Creation of paid services
Preconditions: Support manager has already logged
in
Page 48

Post-condition: paid services created successfully
Normal flow of events:
 Create paid services
 Paid services created successfully

Name of use-case: View paid services
Description: to view the paid services and their details
Preconditions: Support Manager has already logged in
Post-condition: none
Normal flow of events:
Page 49

 Select the service to view
 View details of service

Name of use-case: update the paid service
Description: update paid services
Preconditions: Support manager has already logged in
Post-condition: system updated successfully
Normal flow of events:
 Create new paid service

Page 50

 Store the changes
 System updated successfully
 The log detail of this update 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.
Preconditions: Support manager has already logged in
Post-condition: None
Normal flow of events:

Page 51

 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.

Page 52

 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.

Page 53

Sponsor Documents

Or use your account on DocShare.tips

Hide

Forgot your password?

Or register your new account on DocShare.tips

Hide

Lost your password? Please enter your email address. You will receive a link to create a new password.

Back to log-in

Close