SkyNet Online Shopping Mall Software Requirements Specification

http://osmlite.googlecode.com

SkyNet, 2008

Page 1

Revision History
Date <dd/mmm/yy> Version <x.x> <details> Description <name> Author

http://osmlite.googlecode.com

SkyNet, 2008

Page 2

Table of Contents
1. Introduction 1.1 1.2 1.3 1.4 1.5 1.6 2. Purpose Scope Definitions, Acronyms and Abbreviations References Technologies to be used Overview 4 4 4 4 5 6 6 6 8 13 15 15 15 Error! Bookmark not defined. Error! Bookmark not defined. Error! Bookmark not defined.

Overall Description 2.1 Use-Case Model Survey 2.2 Architecture diagram & database design 2.3 Assumptions and Dependencies Specific Requirements 3.1 3.2 Use-Case Reports Supplementary Requirements

3.

4. 5.

Supporting Information Concerns / Queries / Doubts if any:

http://osmlite.googlecode.com

SkyNet, 2008

Page 3

Software Requirements Specification

Introduction
Purpose

The Online Shopping Mall (OSM) web application is intended to provide complete solutions for vendors as well as customers through a single get way using the internet as the sole medium. It will enable vendors to setup online shops, customer to browse through the shop and purchase them online without having to visit the shop physically. The administration module will enable a system administrator to approve and reject requests for new shops and maintain various lists of shop category This document is meant to delineate the features of OSM, so as to serve as a guide to the developers on one hand and a software validation document for the prospective client on the other.
1.2 Scope

Initial functional requirements will be: j Secure registration and profile management facilities for Customers j Browsing through the e-Mall to see the items that are there in each category of products like Apparel, Kitchen accessories, Bath accessories, Food items etc. j Adequate searching mechanisms for easy and quick access to particular products and services. j Creating a Shopping cart so that customers can shop n no. of items and checkout finally with the entire shopping carts j Regular updates to registered customers of the OSM about new arrivals. j Uploading Most Purchased Items in each category of products in the Shop like Apparel, Kitchen accessories, Bath accessories, Food items etc. j Strategic data and graphs for Administrators and Shop owners about the items that are popular in each category and age group. j Maintaining database of regular customers of different needs. j Shop employees are responsible for internal affairs like processing orders, assure home delivery, getting customer's delivery-time feedback, updating order's status and answering client's queries online. j Feedback mechanism, so that customers can give feedback for the product or service which they have purchased. Also facility rating of individual products by relevant customers. Also feedback can be given on the performance of particular vendors and the entire mall as well. j Adequate payment mechanism and gateway for all popular credit cards, cheques and other relevant payment options, as available from time to time.

http://osmlite.googlecode.com

SkyNet, 2008

Page 4

For the previous paragraph, depicting the functions of the system, from the perspective of the various users of the system, the following colour codes has been used :
y y y RED for administrator BLUE for customer of the shopping mall GREEN for the employees.

Initial non functional requirements will be: j Secure access of confidential data (users details). SSL can be used. j 24 X 7 availability j Better component design to get better performance at peak time j Advertisement space where it will effectively catch the customers attention and as a source of revenue. In addition to the above mentioned points, due to the highly evolving nature of the project, the following are planned to be delivered if deemed necessary: j Warehousing within the very ambits of the project j More payment gateways. j Dynamic price model by which prices can be changed based on demand and supply j Dynamic Storefront: Each customer will have a web page personalized based on his or her recent purchases. This is the equivalent of having a unique storefront for each customer in hopes of drawing in as many return customers as possible. This list is by no means, a final one. The final list will be dictated by implementation constraints, market forces and most importantly, by end user demands for whom this is being built.
1.3 Definitions, Acronyms and Abbreviations

j SLA: Service Level Agreement or SLA is a formal written agreement made between two parties, the service provider & the service recipient. It defines the term of engagement - the fundamental rules that will govern the relationship. j EJB: Enterprise Java Beans. j JAVA EE: Java Enterprise Edition 5 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 running on an application server. j HTTP: Hypertext Transfer Protocol is a transaction oriented client/server protocol between a web browser & a Web Server.
j HTTPS: Secure Hypertext Transfer Protocol is a HTTP over SSL (secure socket layer).

j TCP/IP: Transmission Control Protocol/Internet Protocol, the suite of communication protocols used to connect hosts on the Internet. TCP/IP uses
http://osmlite.googlecode.com SkyNet, 2008 Page 5

several protocols, the two main ones being TCP and IP.
1.4 References

IEEE SRS Format

Programming languages: j JAVA EE: Java 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 running on an application server. j HTML, XML: Hyper Text Markup Language and Extensible markup Language are the predominant markup languages for web pages. It provides a means to describe the structure of text-based information in a document and to supplement that text with interactive forms, embedded images, and other objects. j JavaScript: A client side scripting language used to create dynamic web content and user interface. Tools & Development Environment j Apache Tomcat 6.0.18 Server: Apache Tomcat is a Servlet container developed by the Apache Software Foundation (ASF). Tomcat implements the Java Servlet and the JavaServer Pages (JSP) specifications from Sun Microsystems, and provides a "pure Java" HTTP web server environment for Java code to run. j ECLIPSE J2EE: Eclipse is a toolkit which is designed for the creation of complex projects, providing fully dynamic web application utilizing EJBs. This consist of EJB tools , CMP ,data mapping tools & a universal test client that is designed to aid testing of EJBs.
1.6 Overview

The rest of this SRS is organized as follows: Section 2 gives an overall description of the software. It gives what level of proficiency is expected of the user, some general constraints while making the software and some assumptions and dependencies that are assumed. Section 3 gives specific requirements which the software is expected to deliver. Functional requirements are given by various use cases. Some performance requirements and design constraints are also given. 2.
2.1

Overall Description
Product perspective

OSM is aimed towards the vendors who want to reach out to the maximum cross-section of customer and common people who can be potential customer. This project envisages bridging the gap between the seller, the retailer and the customer. OSM should be userfriendly, quick to learn and reliable software for the above purpose. OSM is intended to be a stand-alone product and should not depend on the availability of other software. It should run on both UNIX and Windows based platform.
http://osmlite.googlecode.com SkyNet, 2008 Page 6

2.2

Product functions

User: Mall Administrator Functions: The Mall Administrator is the super user and has complete control over all the activities that can be performed. The application notifies the administrator of all shop creation requests, and the administrator can then approve or reject them. The administrator also manages the list of available product categories. The administrator can also view and delete entries in the guestbook. User: Shop Owner Functions: Any user can submit a shop creation request through the application. When the request is approved by the Mall Administrator, the requester is notified, and from there on is given the role of Shop Owner. The Shop Owner is responsible for setting up the shop and maintaining it. The job involves managing the sub-categories of the items in the shop. Also, the shop owner can add or remove items from his shop. The Shop Owner can view different reports that give details of the sales and orders specific to his shop. The Shop Owner can also decide to close shop and remove it from the mall. User: Mall Customer/Guests Functions: A Mall Customer can browse through the shops and choose products to place in a virtual shopping cart. The shopping cart details can be viewed and items can be removed from the cart. To proceed with the purchase, the customer is prompted to login. Also, the customer can modify personal profile information (such as phone number and shipping address) stored by the application. The customer can also view the status of any previous orders, and cancel any order that has not been shipped yet. User: Employees j Functions: Purchase department under a Purchase manager to overlook purchasing activities if warehousing needs arise. j Functions: Sales department under a Sales manager who will look after the sale of products and services, the most important activity. j Functions: Accounts department under an Accounts manager to look after the accounting activities of the enterprise
2.3 User characteristics

j The user should be familiar with the Shopping Mall related terminology like Shopping cart/Checking out/Transaction etc. j The user should be familiar with the Internet.
2.4 Constraints

j Limited to HTTP/HTTPS. j Real-life credit card validation and Banking system is not implemented. j No multilingual support

http://osmlite.googlecode.com

SkyNet, 2008

Page 7

2.5

Use-Case Model Survey

Figure 1: User hierarchy

http://osmlite.googlecode.com

SkyNet, 2008

Page 8

Figure 2: Use case diagram for Customer & Visitor

Figure 3: Use case diagram for Shop owner

http://osmlite.googlecode.com

SkyNet, 2008

Page 9

Figure 4: Use case diagram for Employees

Figure 5: Use case diagram for Administrator

http://osmlite.googlecode.com

SkyNet, 2008

Page 10

Given below is an overall picture of the system, as depicted in the above use-case diagrams:

1. Administrator:
    Database Management: Control the database and keep track of all records of customers and employee details. Contact and Giving Permission to Vendors: Contact with the vendors and give permission to sell their product under the site after testing the products quality. View all details: View the details of all employees and control the whole site. Advertising the Site: Responsible for making advertisements for the site.

2. Customers:
       Login: Customers must have a valid login id to enter into the site. Registration: New users can sign up by creating new ID. View and edit Own Details: Can view/edit his personal details, payment details, and details about services provided. Choosing and comparing products: Can view all available products and can compare them and make a choice for purchasing products. Purchasing: Can purchase any product through valid credit card. Giving Feedback to Customer Care: Can give feedback to the 24X7 Customer Care Service center about their impression for the site and services. Logout: Customer must logout of the site after purchasing products.

3. Visitors:
  Visiting the Site: Can only visit the site without registration. Register :

4. Shop Owner:
 Taking Permission from Administrator: Vendors must take permission from the Administrator for selling their products under the site. Administrator will test products quality according to its market price to permit vendor for selling purpose.

http://osmlite.googlecode.com

SkyNet, 2008

Page 11

 

Consulting with Administrator: Can consult with the Administrator regarding products quality and advertisements. Advertising Vendors Own Products: Responsible for making advertisements of his products, but the site will not be responsible for any kind of advertisements about products.

5. Sales Manager:
    View customer details: View the personal details of the customer. Managing Sales to Customers: Responsible for properly allocating the selected product according to the customers choice and delivering product to the customer. View Product Stocks: Keep track of each product items stocks for selling purpose. Contacting with Administrator: Responsible for informing administrator when any product items stock goes under the minimum level.

6. Purchase Manager:
  Consulting with Administrator: Taking permission from the Administrator for the product to be purchased from vendor. Product Stock Management: Responsible for managing stocks of each product items.

7. Accounts Manager:
   Regulating Payments: Keep track of all the payment transactions made by the customers and update the payment information. Consulting with Banks: Responsible for contacting the banks for the validation of the a/c number provided by the customer while purchasing and make the transaction from the given a/c. Consulting with Administrator: Consult with the Administrator about the payment details of the customers for the updating of the database.

8. Customer Care:
  Getting Feedback from the Customers: Responsible for receiving complaints, queries and feedback from the customers. Providing Solutions to Customers: Provide feasible solutions to the customers on their complaints and queries.

http://osmlite.googlecode.com

SkyNet, 2008

Page 12

2.6 Architecture diagram

http://osmlite.googlecode.com

SkyNet, 2008

Page 13

2.7 Database design

http://osmlite.googlecode.com

SkyNet, 2008

Page 14

2.8

Assumptions and Dependencies

j The details related to the product, customer, payment and service transaction provided manually. j Administrator is created in the system already. j Roles and tasks are predefined.

3.
3.1

Specific Requirements
Use-Case Reports

i) Administrators:
 Database Management: Control the database and keep track of all records of customers and employee details.
 Preconditions: Administrator is already logged in.

 Normal flow of events: 1) Normal check of the database by the Administrator. 2) Updating the database (if required).  Alternate flow of events: None.  Post Condition: Always updated database.  Contact and Giving Permission to Vendors: Contact with the vendors and give permission to sell their product under the site after testing the products quality.

 Preconditions: 1) Administrator is already logged in.

2) Vendor contacts with Administrator.  Normal flow of events: Negotiation is successful.  Alternate flow of events: Negotiation is failed.  Post Condition: possibilities of new product items  Contacting Business Partners: Responsible for contacting with Business Partners who will sponsor the site and help in conducting the business process.

 Preconditions: 1) Administrator is already logged in.

2) Business Partner contacts with Administrator.  Normal flow of events: Negotiation is successful.  Alternate flow of events: Negotiation is failed.
http://osmlite.googlecode.com SkyNet, 2008 Page 15

 Post Condition: possibilities of new sponsors and raise in

investments.  Advertising the Site: Responsible for making advertisements for the site.


 Preconditions: Administrator is already logged in.

 Normal flow of events: 1) Contacting different media. 2) Making advertisements for the site.  Alternate flow of events: None.  Post Condition: popularizing the site.    View all details: View the details of all employees and control the whole site.
 Preconditions: Administrator is already logged in.

 Normal flow of events: 1) Administrator views the details of all employees. 2) Controls the whole site.  Alternate flow of events: None.  Post Condition: Everything is completely under control.

http://osmlite.googlecode.com

SkyNet, 2008

Page 16

ii) Customers: 
 Preconditions: Customer must have a valid user ID.

 Normal flow of events: 1) 2) 3) 4) 5) Log in. View and edit Own Details Choosing and comparing products Purchasing Logout

 Alternate flow of events: 1) New customer registration 2) Complaining to Customer Care  Post Condition: A happy Customer!

http://osmlite.googlecode.com

SkyNet, 2008

Page 17

iii) Visitors:
 Preconditions: Administrator is already logged in.

 Normal flow of events:Visiting the Site  Alternate flow of events: None.  Post Condition: Proper separation between customers and windowshoppers.  

iv)Vendor:
 Preconditions: Can consult with the Administrator regarding products quality and advertisements.  Normal flow of events: Can consult with the Administrator regarding products quality and advertisements.  Alternate flow of events: Can leave the project.  Post Condition: Various attractive items for customers.

http://osmlite.googlecode.com

SkyNet, 2008

Page 18

v) Sales Manager: Sales Manager can view customer details and responsible for managing
sales to customers, viewing product stocks and contacting with the administrator.     View Customer Details: View personal details of the customers. Managing Sales to Customers: Responsible for properly allocating the selected product according to the customers choice and delivering product to the customer. View Product Stocks: Keep track of each product items stocks for selling purpose. Contacting with Administrator: Responsible for informing administrator when any product items stock goes under the minimum level.

Name of the use case: View customer details. Description: View the personal details of the selected customer. Precondition: Sales manager is already logged in. Normal flow of events: Select customer. The details of customer viewed. Alternate flow of events: None Post condition: None.

Ask for customer

Select customer

Customer details

http://osmlite.googlecode.com

SkyNet, 2008

Page 19

MANAGING SALES TO CUSTOMERS:

<<include>>

Add purchase details <<include>> Update purchase

<<extend>>

Manage purchase details

<<include>> View purchase details

<<extend>> Managing sales <<include>> Create an SLA <<include>>

Manage service level agreement    

<<include>> View an SLA



Update SLA

 Name of the use case: Add/update and view purchase details. Description: Store the details of the product sold, customer id, supply details and any changes in product details can be made and view purchase details. Precondition: Sales Manager is already logged in. The customer is registered and the products are already present. Normal flow of events: Select a customer. Select a product. Enter/update purchase details. Save new data. Alternate flow of events: If the customer is not registered, ask for registration. If the product is out of stock, send error message. Post condition: Sale id is generated.  

http://osmlite.googlecode.com

SkyNet, 2008

Page 20

Select customer

Ask for registration

Not registered

Validation

Registered Select product

Send error message

Not available

Availability

 Available   Sale product     Add/update data     View purchase details        Name of the use case: Create/update a service level agreement. Description: Store the details of the services provided to a customer, duration of the services and details of the terms and conditions

Precondition: Sales manager is already logged in. The product and the services to be provided are already present. Normal flow of events: Select product. Select services Enter details of the service level agreements. Add / update the data.
http://osmlite.googlecode.com SkyNet, 2008 Page 21

Alternate flow of events: If the product is not present, send error message. Post condition: SLA is created / updated.

Select product

Send error message

Not available

Availability

Available Ask for services Select service Ask for SLA Details

  Add / update data         Name of the use case: View service level agreement. Description: To see the details of the agreement. Precondition: Sales manager is already logged in. The product and the services to be provided are already present. Normal flow of events: Select product. Select date. The details of the SLA are shown to the sales manager.
http://osmlite.googlecode.com SkyNet, 2008 Page 22

Alternate flow of events: If the product is not present, send error message. Post condition: None.

Select product

Send error message

Not available

Availability

Available Ask for services

Select service View SLA Details

     Name of the use case: View product stock and contact with the administrator. Description: View stock of a specific product and if stock is low contact with the administrator. Precondition: Sales manager is already logged in. Normal flow of events: Select product View stock. Alternate flow of events: If the product is not present, send error message. If stock is low report to administrator. Post condition: None.  
http://osmlite.googlecode.com SkyNet, 2008 Page 23

Select product

Send error message

Not available

Availability

Available View stock

Report administrator

Stock low

Check

    

vi) Purchase Manager: Purchase Manager is responsible for receiving products from vendors ,
managing product stocks and consulting with the administrator.

  

Consulting with Administrator: Taking permission from the Administrator for the product to be purchased from vendor. Purchase Order: Responsible for requesting the Vendors to supply required product items of required amount within time. Product Stock Management: Responsible for managing stocks of each product items.

Name of the use case: Consulting with the administrator, requesting the vendors for required products and updating stocks. Description: Consult with the administrator the products required to be purchased from the vendors, order the products and update stock. Precondition: Purchase Manager is already logged in. Normal flow of events: Take permission from administrator. Place order to vendors. Manage stock. Alternate flow of events: None. Post condition: None.
http://osmlite.googlecode.com SkyNet, 2008 Page 24

Take permission from administrator Granted Place order to Vendors Received Update stock

vii) Accounts Manager: Accounts Manager is responsible for receiving customer payments ,
managing customer payment details and consulting with the administrator.

 

Regulating Payments: Keep track of all the payment transactions made by the customers and update the payment information. Consulting with Banks: Responsible for contacting the banks for the validation of the a/c number provided by the customer while purchasing and make the transaction from the given a/c. Consulting with Administrator: Consult with the Administrator about any payment transaction problems.

http://osmlite.googlecode.com

SkyNet, 2008

Page 25

REGULATING PAYMENTS:

<<include>>

Add payment details

<<extend>>

Manage payment <<include>> transaction details

Edit payment details

<<extend>> Regulating payments

View history Name of the use case: Add / edit payment transaction details Description: All the payment transaction details are entered or edited. Precondition: Accounts manager has logged in. Normal flow of events: Select the customer. Select the product . Select transaction id. Enter / edit the details of payment. Save the payment details. Alternate flow of event: None. Post condition: None. 

http://osmlite.googlecode.com

SkyNet, 2008

Page 26

Select customer

Select product

Select Transaction id

Enter / edit Payment details

Save Payment details

   Name of the use case: View history. Description: View the payment details of the selected customer. Precondition: Accounts manager is already logged in. Normal flow of events: Select customer. The payment details of customer is viewed. Alternate flow of events: None Post condition: None.

http://osmlite.googlecode.com

SkyNet, 2008

Page 27

Ask for customer

Select customer

Customer payments details

Name of the use case: Consulting with bank and consulting with administrator. Description: Consulting the bank for the customer payment and in case of any problem consulting with the administrator. Precondition: Accounts manager is already logged in. Normal flow of events: Select transaction id. View transaction details. Contact bank. Receive payment. Manage payment Alternate flow of events: If any problem contact with administrator. Post condition: None. 

http://osmlite.googlecode.com

SkyNet, 2008

Page 28

Select Transaction id

View Transaction details

Contact bank

Contact administrator

Problem Success Receive payment

Manage payment

vii) Customer Care: Responsible for getting feedback from customers and providing
solutions to them.   Getting Feedback from the Customers: Responsible for receiving complaints, queries and feedback from the customers. Providing Solutions to Customers: Provide feasible solutions to the customers on their complaints and queries.

Name of use case : Getting feedback and providing solutions. Description : To get feedback from customers about products and services provided and giving
http://osmlite.googlecode.com SkyNet, 2008 Page 29

solutions accordingly. Normal flow of event : Select customer. Get feedback. Provide solutions.

Alternate flow of events: If customer is not registered ask for registration at first. Post condition: None.

Select customer

Send error message

Not registered

Check

Registered Get feedback / Query Select service Provide solutions


3.2 Software System Attributes

Since, there are a number of attributes of software that can serve as requirements; the following items provide a partial list. These are also known as non-functional requirements or quality attributes. These are characteristics the system must possess, but that might pervade through the design.

http://osmlite.googlecode.com

SkyNet, 2008

Page 30

3.2.1

Availability

The system should be available at all times, meaning the user can access it using a web browser, only restricted by the down time of the server on which the system runs. In case of a of a hardware failure or database corruption, a replacement page will be shown. Also in case of a hardware failure or database corruption, backups of the database should be retrieved from the server and saved by the administrator. Then the service will be restarted. 3.2.2
Reliability

The reliability of the overall program depends on the reliability of the separate components. The main pillar of reliability of the system is the backup of the database which is continuously maintained and updated to reflect the most recent changes. Also the system will be functioning inside a container (since the implementation is J2EE oriented). Thus the overall stability of the system depends on the stability of container and its underlying operating system. 3.2.3
y y y y y Security

Passwords will be saved encrypted in the database in order to ensure the user's privacy. The user's IP will be logged. Sensitive data will be encrypted before being sent over insecure connections like the internet. Certain functions will be assigned to certain modules only. Data integrity will be checked for critical variables.
Maintainability

3.2.4

A commercial database is used for maintaining the database and the application server takes care of the site. In case of a failure, a re-initialization of the program will be done. Also the software design is being done with modularity in mind so that maintainability can be done efficiently. 3.2.5
Portability

The application is J2EE based and should be compatible with all other systems which have a native Java implementation. The end-user part is fully portable and any system using any web browser should be able to use the features of the application, including any hardware platform that is available or will be available in the future.

http://osmlite.googlecode.com

SkyNet, 2008

Page 31