IntelOps-SDD

System Design Document
Internship Project Name:
Client Intake System - IntlOps
Document Instructions:1. Text written in red fonts is instructions/information for corresponding
sections.
2. Modify any sections as required and upload the updated document as
artifact under specific task in WBS
System Design Document
Page 1
<Use the table below to maintain information about the document and author. The author is
usually the eIntern>
Current Version:
<current version number>
2.0
Date Last Updated:
<last update date>
10/17/15
Last Updated By:
<update author name>
Sy
Author:
<author name>
Sy
Date Created:
<creation date>
10.17/15
System Design Document
Page 2
Revision History
<The table below can be used to maintain revision history and major changes done on each
revision>
Version
Number
Date
Updated
System Design Document
Revision
Author
Summary of Major Changes Made
Page 3
Table of Contents
Contents
1
Document Overview ..................................................................................................................... 5
1.1
Scope .......................................................................................................................................... 5
1.2
Related Documentation ...................................................................................................... 5
1.3
Document Conventions ....................................................................................................... 5
2
Architecture Diagram .................................................................................................................. 6
3
High Level Class Diagram ........................................................................................................... 7
4
Database Design – Object Relational Mapping................................................................... 8
4.1
Database Table/Field to UI Field Mappings ................................................................ 9
5
Sequence Diagram...................................................................................................................... 10
6
Activity Diagram ......................................................................................................................... 12
System Design Document
Page 4
1
Document Overview
<This is a technical blueprint for the project.>
This document has been developed for the International Operations Enterprise project's Client
Intake System.
This document was developed from the IntlOps Software requirement
specification document and is intended to detail the





1.1
Technical Architecture
Class diagram
Activity Diagram
Sequence Diagram
Database Design.
Scope
<List summary of models and versions of servers and frameworks used to which this document
relates.>
Servers:- JBoss, Oracle Database
Languages and Framework:- Java, JDBC, Servlets, JSPs and Struts
1.2
Related Documentation
<List related documents to the internship project>
All documentation relating to the project can be found under project documents.
Other system documentation for this system should include:
System Requirement Specification
User Acceptance Test Cases
Work Breakdown Structure (Project Schedule)
1.3
Document Conventions
<Describe what diagrammatic notation has been used in this document to represent the
architectural views. Use of the Unified Modeling Language (UML) is strongly encouraged.>
All diagrams, charts, and tables are generated using standard UML guidelines.
System Design Document
Page 5
2
Architecture Diagram
WEB BROWSER
PRESENTATION LAYER
HTML
CSS
JAVASCRIP
T
JSP
STRUTS
BUSINESS LAYER
BUSINESS LAYER
DATA ACCESS LAYER
POJOS
DAO LAYER
DAO
OBJECTS
DATABASE MANAGEMENT
SYSTEM
System Design Document
Page 6
3
High Level Class Diagram
System Design Document
Page 7
4
Database Design – Object Relational Mapping
<List and describe tables, fields, and entity relationships (also known as data dictionary and
logical/ physical database design), schema, query language, key and indices, data management
functions.>
Usermanagement
Client
PK Client_ID:
FK Account_Name:
Street1:
Street2 :
State:
City:
Zip:
Number(8.0)
Varchar(1000)
Varchar(1000)
Varchar(1000)
Varchar(100)
Varchar(100)
Number(5.0)
PK Client_ID: Number(8.0)
Username: Varchar(100)
Password: Varchar(20)
Account
PK Client_ID:
Number(8.0)
FK Account_Name: Varchar(1000)
Account_Status: Varchar(100)
Credit_limit:
Number(10.0)
System Design Document
Page 8
4.1
Database Table/Field to UI Field Mappings
Client <Table>
UI Field Name
CompanyName_Input
AddressLine1_Input
AddressLine2_Input
State_DropDown
City_DropDown
Zip_Input
Submit
Login
Company Name
Has this company
applied before?
Company HQ
Address Line 1
Company HQ
Address Line 2
Company HQ State
Company HQ City
Company HQ Zip
Code
Do you already have
an account?
Field Type
Text Box: String
Text Box: String
Text Box: String
Drop Down Box
Drop Down Box
Text Box: String
Button
Button
label
Database Field
Account_Name
Street1
Street2
State
City
Zipcode
Page
Registration
Registration
Registration
Registration
Registration
Registration
Registration
Registration
Registration
label
Registration
label
Registration
label
label
label
Registration
Registration
Registration
label
Registration
label
Registration
UserManagement <Table>
UI Field Name
UserName
UserName_Input
Password
Password_Input
Login
Forgot Password?
System Design Document
Field Type
label
Text Box: String
label
Password Box :
String
Button
label
Database Field
username
password
Page
Login
Login
Login
Login
Login
Login
Page 9
Need to register?
Help
Register
label
Button
Button
Login
Login
Login
Account <Table>
UI Field Name
Client_ID
Account_Name_Input
Account_status_Input
Credit_Limit input
5
Field Type
Text Box: Integer
Text Box: String
Text Box : String
Text Box: String
Database Field
Client_ID
Account_name
Account_status
Credit_Limit
Page
Admin
Registration
Registration
Registration
Sequence Diagram
<The sequence diagram is used primarily to show the interactions between objects
in the sequential order that those interactions occur.>
System Design Document
Page 10
System Design Document
Page 11
6
Activity Diagram
<Activity diagrams are graphical representations of workflows of stepwise activities and actions
with support for choice, iteration and concurrency.>
System Design Document
Page 12