Professional Documents
Culture Documents
Project Documentation
Project Documentation
1. Document Control
Document History
Ver. Date Author Changes from previous Version
1. 20/03/07 Jojo John Danial -
Document Objective
Srl. Description
1. The purpose of this document is to give the complete information about the
complete system we have been developing. The main objective of this document is
to identify the purpose, scope and boundary of the system being developed. This
document also specifies the functional, non-functional or any other requirements of
the system.
Actions to be taken
Srl. Description
1. Reviewing
2. Approval
2. Introduction
2.1. Purpose
The purpose of developing this Supply Chain Management System is to create part of the
backend and GUI of a virtual market space which will be used by Business enterprise,
Customers, Manufacturers and Suppliers.
2.2. Scope
The scope of the Supply Chain Management as an application could be briefly specified on
the basis of different module:
User Management:
User are been given the access to the system based on the different user roles
provided by the access control module.
User can also get access to the different product even with out registration which are
basically the product that don’t require registered user.
OIP Module:
It accepts the order from the shopping cart calculates the final cost and
generates a Performa Invoice for the customer.
After the order is confirmed, an invoice is generated which is displayed to the customer
and then the payment details are passed to the Payment Gateway, which approves or
rejects the payment after account verification.
question-answer, birth date, postal code and alternate e-mail. He also accepts
to the terms and conditions in order to complete the registration.
Once the profile is submitted the system maintains profiles of the registered
users.
A registered user can directly login through the login screen using his Login id
and Password.
The other options that a registered user can avail:
Edit Profile and Change Password
Forgotten username/password can also be retrieved by a simple and
secure process.
The registration process sets an expiry date for every user being
registered. A notification through email is sent to the user when
expiry date approaches.
Re-activation before expiry is also an easy process for the user.
Catalogue Management:
The catalogue can contain products, product accessories, information or
services.
Supplier can enter their items and its details. The interface is designed such a
manner that supplier can enter their list of items and define their set of
parameters for respective items.
Supplier can add his product in available categories and also add his own
categories and keep his products in that category.
For each and every item, a supplier can specify if he wants the customer to be
registered in order to purchase that particular item.
Supplier can maintain relation between the items so that user can be given
relative options.
Market Place:
In the B2B market place, suppliers or the sellers are trying to sell their product
using the reverse auctioning which means that the product is available to the
buyer at the cost he had quoted. Here the load factor, which is different for
each product, is also taken into consideration while selecting the winning bid.
The lowest amount of the different prices quoted by the different buyers wins
the product.
In the C2C market place, consumers acting as seller are trying to sell their
using the forward auctioning. Here the highest amount of the different prices
quoted by the other buyers wins the product. Each bid increases by the
predefined multiplicity factor.
In the B2C market place, suppliers or the seller are trying to sell there product
using the forward auction or direct selling. In direct selling product is available
to the buyer at the cost fixed by the supplier in product’s price tag.
Auction Sniff ring means the anonymous users participate in the bidding process
and thus restrict the interested user to purchase/sell the product at that max/min bid
and thus the interested consumer gets the product at some higher range than it
should be.
Load Factor means the extra expenses incurred to the system are counted and they
are added to the total cost of the product in reverse auctioning.
Multiplying Factor means the factor using which the consumer has to bid in
forward auctioning.
Catalogue where the different products are being displayed and where in they are
categorized.
Product could basically be any thing that can be considered for sale.
Supplier is the one whole is been registered to our application for outing his
products on our application.
Consumer/Visitor/User is basically the one who is coming to our application and
requesting for the product to be shown to him and w\even the one who just come to
our application for viewing purpose.
RMS: Rights Management System
REQ: Code for Requirement
Roles: Specific set of rights and privileges.
Special Users: A user who has additional rights as compared to general user.
OIP – Ordering, Invoicing and Payment
REQ: Requirement. Code for Requirement
COD- Cash on Delivery
POD – Payment on Delivery
E-Mail – Electronic Mail
2.6. References
For reference we have gone through many websites who maintain a catalogue section.
Some of them like
www.eBay.in
www.amazon.com
www.wikipedia.com
www.nokia.com
www.pantaloon.com
www.prenhall.com
www.wikipedia.com
www.xsag.com
www.Wikipedia.org
www.getahead-direct.com
www.dn.codegear.com
www.portal.acm.org/citation.cfm
www.seimens.com
www.lgelectronics.com
www.motorola.com
www.shopping.com
Software Engineering by Pankaj Jalote, Roger Pressmen
E-Business 2.0 Roadmap for Success, by Ravi
3. Overall Description
The system will inhabit the backend of a huge internet web site.
Each and every user of this system will be assigned a role by the Access Control
Module.
User can move freely in the catalogue. He can also search for his specific item on
Version : 1.0 Date : 20/04/07
Composed By : Jojo John Danial Page 9 of 62
Rishabh Software Pvt. Ltd. Document Category :External
Project : Virtual Market Document Type :Project Documentation
the web site and our product will display the correct matches.
Any supplier/manufacturer/retailer can associate with our product and attach his
catalogue or put his items for sale/auction in the marketplace.
If a supplier wants the customer to be registered to buy his item, then our User
Management module handles the registration process and maintains a record of all
registered users.
All items selected by the users are placed in a shopping cart and then ordering,
invoicing and payment is done.
After every confirmation action, the customer is given an option to take a print,
email or save the data view (reports).
The product features of our system can be categorized based on the sub-systems.
User Classes:
Organizations/Business Enterprises in the form of buyer/seller
Suppliers
Manufacturers
Retailers
Types of Users:
Subscribed Users – Special facilities selected by user are offered to the
subscribed user
Registered Users – Special discounts, Offers and other few privileges are
given to registered users
Visitors – Visitors can just view the site and leave without making any kind
of transaction with the system
Client Side:
Operating System: Windows 98, 2000, ME, XP, NT
Browsers: Internet Explorer , Netscape Navigator, Mozilla Firefox
Design Constraints:
The design of the system should be flexible to be displayed in the
resolution of the monitor (i.e. specified in %).
Implementation Constraints:
The display of the different categories of the product will be based on the
application’s view.
The different attribute that a supplier want to specify has to follow certain
data type and basic properties.
Auction sniff ring cannot be handled.
Complex distributed transactions are not handled by our system.
Cannot integrate with the other Market Place following different standards
and protocols.
The invoice generation does not depend on the delivery of the product.
There is a fixed generic format for invoice.
Only COD and Credit card payment modes are supported.
Assumptions:
Dependency:
1. Privileges and roles are directly dependent on type of user that has logged
in.
4. Functionality Description
Activation
Registration
Deactivation
Add
User Subscription
Edit
Delete
Subscription
Add
Subscription Policy Edit
Delete
Login Logout
User
Search User
Edit Profile
Forgot Password
Change Password
Add
Select
Action1
Manage Transaction
Action21
Action n
Manage Roles
Transaction1
Defining Rights
User Transaction2
Transaction n
View
Manage User Rights
Delete
Rights1
Create Roles
Rights2
Add
Organization Structure
Edit
Delete
Add
Products Edit
Delete
Search a Product
Add
Delete
View Products
Add
User Category/Classification Edit
Delete
Add
Delete
Manage Ads
Add
Delete
Add
Delete
Make Payment
Add
User Delete
Add
Delete
Close Auction
Edit Order
Receive Order
Cancel Order
Marketplace
Generate Performa
Generate Invoice
Generate Reports
Payment Gateway
Search Order
User
Execute Payment
Preconditions -
Post Conditions Start time ,end time, duration, multiplicity factor,
minimum bid
Priority Essential
(Essential, Expected, Desired,
Optional)
Frequency of Use Often
(Always, Often, Sometime,
Rarely, Once)
Normal Course Actor Actions System Responses
1. User tries to sell 1. System gives him the
a product. purchaser’s bids
Alternative Course Actor Actions System Responses
- -
Exceptions Actor Actions System Responses
- -
Includes -
Special Requirements -
Assumptions -
Notes & Issues -
Make Payment
product
Alternative Course Actor Actions System Responses
- -
Exceptions Actor Actions System Responses
- -
Includes -
Special Requirements -
Assumptions -
Notes & Issues -
Special Requirements -
Assumptions -
Notes & Issues -
Use Case ID : UC-35 Use Case Name Bid for reverse Auction
Created By : Jojo Last Update By -
Created On : 22/02/2007 Last Update On -
Actor User
Description It helps the user to bid for a product put for reverse
auction
Preconditions Start time ,end time ,duration, multiplicity factor,
minimum bid
Post Conditions -
Priority Essential
(Essential, Expected, Desired,
Optional)
Frequency of Use Often
(Always, Often, Sometime,
Rarely, Once)
Normal Course Actor Actions System Responses
1. User tries to bid 1. System prompts the user
for a product. whether to bid lower from
his current bid
Alternative Course Actor Actions System Responses
- -
Exceptions Actor Actions System Responses
- -
Includes -
Special Requirements -
Assumptions -
Notes & Issues -
Close Auction
Receive Order
Edit Order
Optional)
Frequency of Use Sometime
(Always, Often, Sometime,
Rarely, Once)
Normal Course Actor Actions System Responses
1. With the 1. The user is shown an
Performa editable page.
Invoice, Edit
Order option is
shown.
2. User clicks on
Edit Order
button.
Alternative Course Actor Actions System Responses
- -
Exceptions Actor Actions System Responses
- -
Includes -
Special Requirements -
Assumptions -
Notes & Issues -
Cancel Order
Generate Performa
Generate Invoice
Generate Report
Preconditions -
Post Conditions -
Priority Desired
(Essential, Expected, Desired,
Optional)
Frequency of Use Often
(Always, Often, Sometime,
Rarely, Once)
Normal Course Actor Actions System Responses
1. A user will 1. The system will ask the user
request for in which format the report is
report by needed.
clicking on the 2. The system will then
Get Report generate appropriate report.
button.
Search Orders
Includes -
Special Requirements -
Assumptions -
Notes & Issues -
Execute Payment
Includes -
Special Requirements -
Assumptions -
Notes & Issues -
5. System Design
5.1. Class Diagram
6. Data Dictionary
scd_branch_name
2.02 varchar (500)
scd_contact_name
2.03 varchar (500)
scd_address
2.04 varchar (4000)
scd_city
2.05 varchar (500)
scd_postal_code bigint
2.06
scd_state
2.07 varchar (500)
scd_country
2.08 varchar (500)
scd_official_phone
2.09 varchar (500)
scd_residential_phone
2.10 varchar (500)
scd_mobile_number
2.11 varchar (500)
scd_fax_number
2.12 varchar (500)
scd_cmpny_email_id
2.13 varchar (500)
scd_remarks
2.14 varchar (4000)
2.15 scd_status_id bigint FK 33.01 Status Master
2.16 scd_created_by bigint FK User Master
2.17 scd_created_dt datetime sysdate
2.18 scd_updated_by bigint FK User Master
2.19 scd_updated_dt datetime sysdate
3.00 Subscription Rule (scm_subscr_rule)
Srl Col. Name Data Type Constraints Remarks Ref. Table
Identity
3.01 ssr_subscr_id bigint PK Seed
3.02 ssr_subscr_for varchar (500)
3.03 ssr_subscr_from datetime
3.04 ssr_subscr_upto datetime
bigint
3.05 ssr_qty
bigint
3.06 ssr_dur
bigint
3.07 ssr_cost
3.08 ssr_status_id bigint FK 33.01 Status Master
srtm_action_id bigint
8.03 Action Master
8.04 srtm_status_id bigint FK 33.01 Status Master
8.05 srtm_created_by bigint FK User Master
8.06 srtm_created_dt datetime sysdate
8.07 srtm_updated_by bigint FK User Master
8.08 srtm_updated_dt datetime sysdate
9.00 Role Detail (scm_role_detail)
Srl Col. Name Data Type Constraints Remarks Ref. Table
srd_srm_role_id
9.01 bigint FK Role Master
srd_srtm_right_id
9.02 bigint FK Right Master
srd_status_id
9.03 bigint FK 33.01 Status Master
9.04 srd_created_by bigint FK User Master
9.05 srd_created_dt datetime sysdate
9.06 srd_updated_by bigint FK User Master
9.07 srd_updated_dt datetime sysdate
User Profile (scm_user_profile)
10.00
Srl Col. Name Data Type Constraints Remarks Ref. Table
sup_sum_user_id bigint Identity
10.01 FK Seed User Master
sup_srtm_right_id bigint
10.02 FK Right Master
10.03 sup_status_id bigint FK 33.01 Status Master
10.04 sup_created_by bigint FK User Master
10.05 sup_created_dt datetime sysdate
10.06 sup_updated_by bigint FK User Master
10.07 sup_updated_dt datetime sysdate
13.00 Catalog Structure Master (scm_cat_str_mst)
Srl Col. Name Data Type Constraints Remarks Ref. Table
Identity
13.01 sscm_prod_id bigint PK Seed
Auction Details
20.00 ScopeofWork(scm_auc_dtl_sw)
Srl Col. Name Data Type Constraints Remarks Ref. Table
sads_scopeofwrk_id int
20.01 PK
sads_sam_auction_id int
20.02 FK 18.01 Auction Master
sads_scopeofwrk_desc varchar(50)
20.03
sads_remark varchar(50)
20.04
sads_scopeofwrk_type bit
20.05
20.06 sads_status_id bigint FK 33.01 Status Master
20.07 sads_created_by bigint FK User Master
20.08 sads_created_dt datetime sysdate
20.09 sads_updated_by bigint FK User Master
20.10 sads_updated_dt datetime sysdate
21.00 Auction Details LoadFactor(scm_auc_dtl_lf)
Srl Col. Name Data Type Constraints Remarks Ref. Table
sadl_loadfactr_id bigint
21.01 PK
sadl_sam_auction_id bigint
21.02 FK 18.01 Auction Master
sadl_loadfactr_desc varchar(50)
21.03
sadl_remark varchar(50)
21.04
sadl_loadfactr_amt money
21.05
21.06 sadl_status_id bigint FK 33.01 Status Master
21.07 sadl_created_by bigint FK User Master
21.08 sadl_created_dt datetime sysdate
21.09 sadl_updated_by bigint FK User Master
21.10 sadl_updated_dt datetime sysdate
22.00 Auction Details Bidder(scm_auc_dtl_bdr)
Srl Col. Name Data Type Constraints Remarks Ref. Table
sadb_user_id int
22.01 FK
sadb_sam_auction_id int
22.02 FK 1.01 Auction Master
sadb_sam_loadfactr_id int Auction Detials
22.03 FK 3.02 LoadFactor
22.04 sadb_status_id bigint FK 1.01 Status Master
22.05 sadb_created_by bigint FK User Master
22.06 sadb_created_dt datetime sysdate
22.07 sadb_updated_by bigint FK User Master
22.08 sadb_updated_dt datetime sysdate
23.00 Auction Details Attachments(scm_auc_dtl_attch)
Srl Col. Name Data Type Constraints Remarks Ref. Table
sada_record_id int
23.01 PK
sada_sam_auction_id int
23.02 FK 1.01 Auction Master
sada_attach_file varchar(20)
23.03
sada_attach_filedesc varchar(50)
23.04
sada_path varchar(30)
23.05
23.06 sadb_status_id bigint FK 1.01 Status Master
23.07 sadb_created_by bigint FK User Master
23.08 sadb_created_dt datetime sysdate
23.09 sadb_updated_by bigint FK User Master
23.10 sadb_updated_dt datetime sysdate
24.00 Auction Bids(scm_auc_bids)
Srl Col. Name Data Type Constraints Remarks Ref. Table
sab_bid_id Int
24.01 PK
sab_sam_auction_id int
24.02 FK 1.01 Auction Master
sab_sadb_bidder_id int Auction Details
24.03 FK 4.02 Bidders
sab_bid_amt money
24.04
Version : 1.0 Date : 20/04/07
Composed By : Jojo John Danial Page 49 of 62
Rishabh Software Pvt. Ltd. Document Category :External
Project : Virtual Market Document Type :Project Documentation
sab_bid_datetime datetime
24.05
sab_loadfactr_amt money
24.06
sab_winner_flag bit
24.07
24.08 sab_status_id bigint FK 1.01 Status Master
24.09 sab_created_by bigint FK User Master
24.10 sab_created_dt datetime sysdate
24.11 sab_updated_by bigint FK User Master
24.12 sab_updated_dt datetime sysdate
25.00 Shopping Cart(scm_shop_cart)
Srl Col. Name Data Type Constraints Remarks Ref. Table
ssc_shoppingcart_id bigint
25.01 PK
bigint
25.02 ssc_scsm_id FK
ssc_added_on datetime
25.03
ssc_qty bigint
25.04
ssc_prod_status_flag bit
25.05
25.06 ssc_status_id bigint FK 1.01 Status Master
25.07 ssc_created_by bigint FK User Master
25.08 ssc _created_dt datetime sysdate
25.09 ssc_updated_by bigint FK User Master
26.00 User Shopping Cart Link(scm_usr_shop_cart_lnk)
Srl Col. Name Data Type Constraints Remarks Ref. Table
bigint
26.01 suscl_sum_user_id FK 1.01 User Master
suscl_ssc_shoppingcart_id bigint
26.02 FK 25.01 Shopping Cart
26.03 suscl_status_id bigint FK 1.01 Status Master
26.04 suscl_created_by bigint FK User Master
26.05 suscl _created_dt datetime sysdate
26.06 suscl_updated_by bigint FK User Master
27.00 Order Master (scm_order_mst)
Srl Col. Name Data Type Constraints Remarks Ref. Table
som_order_id bigint Identity
27.01 PK Seed
bigint
27.02 som_ssr_subscr_id FK
27.03 som_scpd_supp_id FK User Master
som_shoppingcart_id bigint
27.04
som_order_Date datetime
27.05
som_order_given_by varchar(20)
27.06 FK User Master
som_order_given_to_supplier varchar(20)
27.07 FK User Master
som_payment_mode bit
27.08
som_creditcard_type varchar(20)
27.09
som_creditcard_no bigint
27.10
som_creditcard_holdernm varchar(20)
27.11
som_creditcard_expiry datetime
27.12
som_order_amnt bigint
27.13
som_remarks varchar(20)
27.14
27.15 som_status_id bigint FK 33.01 Status Master
27.16 som_created_by bigint FK User Master
27.17 som_created_dt datetime sysdate
27.18 som_updated_by bigint FK User Master
27.19 som_updated_dt datetime sysdate
28.00 Order Detail (scm_order_detail)
Srl Col. Name Data Type Constraints Remarks Ref. Table
sod_ssc_shppingcart_id bigint
28.01 FK Shopping Cart
sod_sscm_prod_id Catalog
Structure
28.02 FK Master
sod_order_date datetime
28.03
sod_price_on_order money
28.04
sod_order_quantity bigint
28.05
28.06 sod_status_id bigint FK 33.01 Status Master
28.07 sod_created_by bigint FK User Master
28.08 sod_created_dt datetime sysdate
28.09 sod_updated_by bigint FK User Master
28.10 sod_updated_dt datetime sysdate
29.00 Sub-Order Detail (scm_suborder_detail)
Srl Col. Name Data Type Constraints Remarks Ref. Table
ssd_suborder_id bigint Identity
29.01 PK Seed
ssd_som_order_id bigint
29.02 FK Order Master
ssd_suborder_supplier_id bigint
29.03 FK User Master
29.04 ssd_status_id bigint FK 33.01 Status Master
29.05 ssd_created_by bigint FK User Master
29.06 ssd_created_dt datetime sysdate
29.07 ssd_updated_by bigint FK User Master
29.08 ssd_updated_dt datetime sysdate
Sub-Product Details (scm_subproduct_details)
30.00
Srl Col. Name Data Type Constraints Remarks Ref. Table
sspd_suborder_id bigint
30.01 FK Sub-Order Detail
sspd_scsm_prod_id bigint Catalogue
Structure
30.02 FK Master
sspd_prod_price money
30.03
sspd_prod_quantity bigint
30.04
30.05 sspd_status_id bigint FK 33.01 Status Master
7. System Features
7.1. Registration Feature
If a user is a registered user, then he’ll be taken to the login screen and
asked for login id and password. If a user is a new user then he’ll be taken to
the registration page where he will provide his personal details. He will also be
provided with the option of editing his profile, changing his password etc.
Priority: 3
Priority: 2
assigned.
of say previous searched item say any product and categories name seems to
be matching will be given as a prompt to get the user with the certain facility.
For certain details the result will be displayed on the other page, showing
different product matching the search criteria.
5.6. Auctioning
5.6.1. Description & Priority
An Auction is the process of buying and selling things by offering them up for
bid, taking bids, and then selling the item to the highest bidder. Auctions can
also be with minimum bid, if the bidding does not reach the minimum, there
is no sale.
Priority: High
In forward auctioning the consumers enter the Auction Engine through his
unique register id. The Auction is based on parameters such as Start date,
End date, and Duration and Multiplicity factor. So thus the consumer who bids
the maximum at that time is allowed to purchase the product.
After order is processed, all the details in the order and entered into the invoice
and invoice is generated.
8. Screen Shots
8.1. Home Page
9. Test Cases
9.1. What are test cases?