and System Software Architecture Description (SSAD)
NFS Database
Team No 11
TEAM MEMBERS:
PROJECT MANAGER: Muhammad Amer PROTOTYPE: Muhammad Zaki ARCHITECT: Salman Rafique PLAN: Jacob Everist REQUIREMENT: Ran Wang CONCEPT: Limei Wang
11/21/04
SSAD_LCA_F04a_T11_v06.doc
i
Version Date: 11/21/2004
Version no 0.6
Version History
Date 09/30/2004 10/07/2004 10/09/2004 10/19/2004 10/24/2004 11/21/2004 Author Salman Rafique Salman Rafique Salman Rafique Salman Rafique Salman Rafique Salman Rafique Version 0.1 0.2 0.3 0.4 0.5 0.6 Changes made Original template for use with MBASE 2.4.0 New Risks were added in the process tables. Section 3.1.1 is added. Section 2.2 and Section 2.3 has been reviewed. Section 2 reviewed and section 3 completed. Section 4 is added.
SSAD_LCA_F04a_T11_v06.doc
ii
Version Date 11/21/2004
Version no 0.6
Table of Contents
SYSTEM AND SOFTWARE ARCHITECTURE DESCRIPTION (SSAD) ........................ I VERSION HISTORY ....................................................................................................... II TABLE OF CONTENTS................................................................................................. III TABLE OF TABLES ......................................................................................................IV TABLE OF FIGURES ....................................................................................................IX 1. Introduction..................................................................................................................... 1 1.1 Purpose of the SSAD Document............................................................................. 1 1.2 Standards and Conventions..................................................................................... 1 1.3 References............................................................................................................... 2 1.4 Change Summary.................................................................................................... 2 2. System Analysis.............................................................................................................. 3 2.2 Artifacts & Information .......................................................................................... 7 2.3 Behavior................................................................................................................ 12 2.4 L.O.S. Goals.......................................................................................................... 38 2.5 Rules ..................................................................................................................... 40 3. Architecture Design & Analysis ................................................................................... 41 3.1 Structure................................................................................................................ 41 3.2 Analysis Classes.................................................................................................... 57 3.3 Behavior................................................................................................................ 62 3.4 L.O.S., Projected................................................................................................... 76 3.5 Architectural Styles, Patterns & Frameworks....................................................... 76 4. Implementation Design................................................................................................. 77 4.1 Structure................................................................................................................ 77 4.2 Behavior................................................................................................................ 82 4.3 L.O.S. .................................................................................................................... 82 4.4 Patterns & Frameworks......................................................................................... 82 4.5 Project Artifacts .................................................................................................... 82 5. Glossary for System Analysis and Design.................................................................... 83 6. Appendices.................................................................................................................... 84
SSAD_LCA_F04a_T11_v06.doc
iii
Version Date 11/21/2004
Table of Tables
Table 1...........................................................................................................................................................................4 Table 2...........................................................................................................................................................................5 Table 3...........................................................................................................................................................................5 Table 4...........................................................................................................................................................................6 Table 5...........................................................................................................................................................................6 Table 6...........................................................................................................................................................................7 Table 7...........................................................................................................................................................................8 Table 8...........................................................................................................................................................................8 Table 9...........................................................................................................................................................................8 Table 10 .........................................................................................................................................................................9 Table 11 .........................................................................................................................................................................9 Table 12 .......................................................................................................................................................................10 Table 13 .......................................................................................................................................................................10 Table 14 .......................................................................................................................................................................10 Table 15 .......................................................................................................................................................................11 Table 16 .......................................................................................................................................................................13 Table 17 .......................................................................................................................................................................15 Table 18 .......................................................................................................................................................................17 Table 19 .......................................................................................................................................................................18 Table 20 .......................................................................................................................................................................20 Table 21 .......................................................................................................................................................................22 Table 22 .......................................................................................................................................................................24 Table 23 .......................................................................................................................................................................26
SSAD_LCA_F04a_T11_v06.doc
iv
Version Date: 11/21/2004
Table of Contents
Table 24 .......................................................................................................................................................................28 Table 25 .......................................................................................................................................................................30 Table 26 .......................................................................................................................................................................32 Table 27 .......................................................................................................................................................................34 Table 28 .......................................................................................................................................................................36 Table 29 .......................................................................................................................................................................38 Table 30 .......................................................................................................................................................................39 Table 31 .......................................................................................................................................................................39 Table 32 .......................................................................................................................................................................40 Table 33 .......................................................................................................................................................................45 Table 34 .......................................................................................................................................................................46 Table 35 .......................................................................................................................................................................46 Table 36 .......................................................................................................................................................................47 Table 37 .......................................................................................................................................................................47 Table 38 .......................................................................................................................................................................48 Table 39 .......................................................................................................................................................................48 Table 40 .......................................................................................................................................................................48 Table 41 .......................................................................................................................................................................49 Table 42 .......................................................................................................................................................................49 Table 43 .......................................................................................................................................................................49 Table 44 .......................................................................................................................................................................50 Table 45 .......................................................................................................................................................................50 Table 46 .......................................................................................................................................................................51 Table 47 .......................................................................................................................................................................51 Table 48 .......................................................................................................................................................................52
SSAD_LCA_F04a_T11_v06.doc
v
Version Date 11/21/2004
Table of Contents
Table 49 .......................................................................................................................................................................53 Table 50 .......................................................................................................................................................................53 Table 51 .......................................................................................................................................................................54 Table 52 .......................................................................................................................................................................54 Table 53 .......................................................................................................................................................................54 Table 54 .......................................................................................................................................................................55 Table 55 .......................................................................................................................................................................55 Table 56 .......................................................................................................................................................................55 Table 57 .......................................................................................................................................................................56 Table 58 .......................................................................................................................................................................56 Table 59 .......................................................................................................................................................................57 Table 60 .......................................................................................................................................................................58 Table 61 .......................................................................................................................................................................58 Table 62 .......................................................................................................................................................................58 Table 63 .......................................................................................................................................................................58 Table 64 .......................................................................................................................................................................59 Table 65 .......................................................................................................................................................................59 Table 66 .......................................................................................................................................................................59 Table 67 .......................................................................................................................................................................59 Table 68 .......................................................................................................................................................................60 Table 69 .......................................................................................................................................................................60 Table 70 .......................................................................................................................................................................60 Table 71 .......................................................................................................................................................................60 Table 72 .......................................................................................................................................................................61 Table 73 .......................................................................................................................................................................61
SSAD_LCA_F04a_T11_v06.doc
vi
Version Date 11/21/2004
Table of Contents
Table 74 .......................................................................................................................................................................61 Table 75 .......................................................................................................................................................................61 Table 76 .......................................................................................................................................................................63 Table 77 .......................................................................................................................................................................64 Table 78 .......................................................................................................................................................................65 Table 79 .......................................................................................................................................................................66 Table 80 .......................................................................................................................................................................67 Table 81 .......................................................................................................................................................................68 Table 82 .......................................................................................................................................................................69 Table 83 .......................................................................................................................................................................70 Table 84 .......................................................................................................................................................................71 Table 85 .......................................................................................................................................................................72 Table 86 .......................................................................................................................................................................73 Table 87 .......................................................................................................................................................................74 Table 88 .......................................................................................................................................................................75 Table 89 .......................................................................................................................................................................76 Table 90 .......................................................................................................................................................................76 Table 91 .......................................................................................................................................................................78 Table 92 .......................................................................................................................................................................78 Table 93 .......................................................................................................................................................................79 Table 94 .......................................................................................................................................................................79 Table 95 .......................................................................................................................................................................80 Table 96 .......................................................................................................................................................................80 Table 97 .......................................................................................................................................................................80 Table 98 .......................................................................................................................................................................81
SSAD_LCA_F04a_T11_v06.doc
vii
Version Date 11/21/2004
Table of Contents
Table 99: <Table Name> ............................................................................................................................................84
SSAD_LCA_F04a_T11_v06.doc
viii
Version Date 11/21/2004
Table of Figures
Figure 1 .........................................................................................................................................................................3 Figure 2 .........................................................................................................................................................................4 Figure 3 .........................................................................................................................................................................7 Figure 4 .......................................................................................................................................................................12 Figure 5 .......................................................................................................................................................................13 Figure 6 .......................................................................................................................................................................15 Figure 7 .......................................................................................................................................................................16 Figure 8 .......................................................................................................................................................................18 Figure 9 .......................................................................................................................................................................20 Figure 10 .....................................................................................................................................................................22 Figure 11 .....................................................................................................................................................................24 Figure 12 .....................................................................................................................................................................26 Figure 13 .....................................................................................................................................................................28 Figure 14 .....................................................................................................................................................................30 Figure 15 .....................................................................................................................................................................32 Figure 16 .....................................................................................................................................................................34 Figure 17 .....................................................................................................................................................................36 Figure 18 .....................................................................................................................................................................38 Figure 19 .....................................................................................................................................................................41 Figure 20 .....................................................................................................................................................................42 Figure 21 .....................................................................................................................................................................43 Figure 22 .....................................................................................................................................................................43
SSAD_LCA_F04a_T11_v06.doc
ix
Version Date: 11/21/2004
Table of Contents
Figure 23 .....................................................................................................................................................................43 Figure 24 .....................................................................................................................................................................44 Figure 25 .....................................................................................................................................................................44 Figure 26 .....................................................................................................................................................................45 Figure 27 .....................................................................................................................................................................57 Figure 28 .....................................................................................................................................................................63 Figure 29 .....................................................................................................................................................................63 Figure 30 .....................................................................................................................................................................64 Figure 31 .....................................................................................................................................................................65 Figure 32 .....................................................................................................................................................................66 Figure 33 .....................................................................................................................................................................67 Figure 34 .....................................................................................................................................................................68 Figure 35 .....................................................................................................................................................................69 Figure 36 .....................................................................................................................................................................70 Figure 37 .....................................................................................................................................................................71 Figure 38 .....................................................................................................................................................................72 Figure 39 .....................................................................................................................................................................73 Figure 40 .....................................................................................................................................................................74 Figure 41 .....................................................................................................................................................................75 Figure 42: <Figure Title> ..........................................................................................................................................84
SSAD_LCA_F04a_T11_v06.doc
x
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
1. Introduction
The system and software architecture description of the NFS database system is introduce below
1.1 Purpose of the SSAD Document
The Purpose of SSAD is to define high-level description of architecture of the system to be implemented using various model diagrams. This document provides architecture analysis and design of the NFS database system. The project architecture is define to meet the project goals of the NFS Database system, project constraints of the NFS Database system and also to meet the Organizational Goals of the Biomechanics Lab.
1.2 Standards and Conventions
The standard UML notations have been used for the SSAD. It follows the CS 577a Guidelines for the LCO and LCA deliverables for MBASE documentation standards. Analysis and Design Standards o IEEE Notation o UML o Rational Rose 2002.05.20 Naming Conventions o Every component and Object name is Noun. o Every Behavior and Operation name is Verb o Label for every relation is Noun.
SSAD_LCA_F04a_T11.doc
1
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
1.3 References
MBASE Guidelines v2.4 http://sunset.usc.edu/classes/cs577a_2004/guidelines/MBASE_Guidelines_v2.4. 1.pdf Operational Concept Description http://seacliff.usc.edu/~team11/LCO/OCD_LCO_F04a_T11.doc http://seacliff.usc.edu/~team11/LCO/OCD_LCO_F04a_T11_V07.doc http://seacliff.usc.edu/~team11/LCO/OCD_LCO_F04a_T11_V08.doc System and Software Requirements Definition http://seacliff.usc.edu/~team11/LCO/SSRD_LCO_F04a_T11_V02.doc http://seacliff.usc.edu/~team11/LCO/SSRD_LCO_F04a_T11_V03.doc Win Win Negotiation Report http://seacliff.usc.edu/~team11/LCO/EWW_LCO_F04a_T11.doc Client Meetings http://seacliff.usc.edu/~team11/CMN/MeetingMinClient.html
1.4 Change Summary
In this version of SSAD document section 2 and 3 are reviewed and section 4 is added.
SSAD_LCA_F04a_T11.doc
2
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2. System Analysis
2.1 Structure
This section describes the workers of the organization and the outside actors with which the NFS Database System interacts. The role and attributes of actor are defined in this system.
Student
(f rom Use-Case Model)
<<com mu nicate>>
Faculty
(f ro m B usi ne ss Us e-C .) ..
<<communicate>>
<<system >> NFS Database System
(f rom Use-Case Model)
<<communicate>> Update Videos <<communicate>> maintains
workers
(f ro m Us e- Cas e Mode l)
Administrator
(f rom Business Use-Case Model)
Figure 1
SSAD_LCA_F04a_T11.doc
3
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
: Administrator
: Faculty
: NFS Database System
: Student : Worker
Figure 2
2.1.1
NFS Database System
The system holds the entire information relating the authentication of users, searching of videos from the database, playing of two videos simultaneously for comparison, capturing of images and annotation of images.
Table 1
Name Role Purpose Responsibilities
Services
NSF Database System Perform the functionalities of NSF Database System The basic purpose of NSF Database System is to provide user to compare and analyze different videos to enhance their learning. System is responsible for providing a set video clips to compare clips, to generate image and to annotate the image. System is also responsible for maintaining information regarding users authentication etc. User Authentication Managing Videos Snapshot Image Video Search Simultaneous Video Playback Edit Image Mange User Profile 4 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD)
Version 0.6
2.1.2
Actors
2.1.2.1 Administrator
The system administrator is responsible for the management of the entire system relating to defining the roles with which the system will be interacting and the assignment of level of access to each role.
Table 2
Name Role Purpose
Administrator Manage the System The basic purpose of Administrator is to manage the overall system. Responsibilities Administrator is responsible for adding and deleting user profiles and videos. Administrator is also responsible for updating and adding searching criteria. Attributes None Processes Process-01, Process-02, Process-03, Process-04, Process-05, Process-06, Process-07, Process-08, Process-09, Process-10, Process-11, Process-12, Process-13 Services Maintain System
2.1.2.2 Student
Student are the users who will be using system for searching a subset of videos which is visible to them, displaying videos, comparing videos, capturing image and then annotating image.
Table 3
Name Role Purpose Responsibilities Attributes Processes Services
Student Uses the System The basic purpose of Student actor is to use the system with limited privileges to the services. Responsible for using system None Process-01, Process-03, Process-04, Process-05, Process-06, Process-07, Process-12 None
SSAD_LCA_F04a_T11.doc
5
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.1.2.3 Faculty
Faculty is also user who will be having much more access to the system then the student as they will be able to see all the videos present in the database and do use all other function as a student will be doing
Table 4
Name Role Purpose Responsibilities Attributes Processes Services
Faculty Uses the system. The basic purpose of Student actor is to use the system with limited privileges to the services but these privileges are more then the privileges as assigned to the student. Responsible for using system None Process-01, Process-03, Process-04, Process-05, Process-06, Process-07, Process-12 None
2.1.2.4 Worker
Worker is user who will be given access to the system to add videos.
Table 5
Name Role Purpose Responsibilities Attributes Processes Services
Worker Manage Videos The basic purpose of the Worker is to provide the system with videos, which will be used by other users of the system. Responsible for managing videos None Process-01, Process-03, Process-04, Process-05, Process-06, Process-07, Process-12 Add Videos
SSAD_LCA_F04a_T11.doc
6
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.2 Artifacts & Information
<<busi ness entity>> Search Query generates> identifies> Generates>
<<busi ness entity>> Search Result
<<busi ness entity>> Video Fi les
<<business entity>> Image File
<<busi ness entity>> Vid eo Catalog
<<busi ness entity>> Worker Profile
<<business entity>> Database
<<business entity>> Administrator Profile
<<busi ness entity>> Student Profile
<<business entity>> Faculty Profile
Figure 3
2.2.1 Administrator Profile
The administrator profile consists of administrator login and password, which is used for authentication of administrator and it, also contains personal information of the administrator.
Table 6
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Administrator Profile Use for Authentication The basic purpose of administrator profile is to provide system information about administrator for authentication. Login None User Authentication OCD 2.3 SC-05 OCD 4.3.5 7 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD)
Version 0.6
2.2.2 Faculty Profile
The Faculty profile consists of login and password for authentication and their personal information, it also contains information about level of access to them.
Table 7
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Faculty Profile Use for Authentication The basic purpose of faculty profile is to provide system information about faculty for authentication. Login None User Authentication OCD 2.3 SC-05 OCD 4.3.5
2.2.3 Student Profile
The Student profile consists of login and password for authentication and their personal information, it also contains information about level of access to them.
Table 8
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Student Profile Use for Authentication The basic purpose of student profile is to provide system information about student for authentication. Login None User Authentication OCD 2.3 SC-05 OCD 4.3.5
2.2.4 Worker Profile
The worker profile consists of worker login and password for authentication and their personal information; it also contains the definition of level access to the system.
Table 9
Name Worker Profile Role Use for Authentication SSAD_LCA_F04a_T11.doc 8
Version Date 11/21/2004
System and Software Architecture Description(SSAD) Purpose Responsibilities Attributes Operations System Capabilities
Version 0.6
The basic purpose of Worker profile is to provide system information about worker for authentication. Login None User Authentication OCD 2.3 SC-05 OCD 4.3.5
2.2.5 Database
Database contains all the information regarding profiles and videos i.e. it contain all the information regarding system.
Table 10
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Database Use for Storage The purpose of database is to store all the information regarding videos and users. Storage Info None Video Archive OCD 2.3, User Authentication OCD 2.3 SC-02 OCD 4.3.2, SC-05 OCD 4.3.5
2.2.6 Video Catalog
Video catalog is the part of the database, which contains videos and all the information regarding the videos in the database.
Table 11
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Video Catalog Maintain Info Regarding Videos The purpose of video catalog is to store all information regarding the video files. Maintain Videos None Video Archive OCD 2.3 SC-02 OCD 4.3.2
SSAD_LCA_F04a_T11.doc
9
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.2.7 Search Query
A collection of criteria assigned to a particular search that will yield on search result.
Table 12
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Search Query Search Videos on user criteria. The basic purpose of Search Query is to search the video files on the criteria, which the user has assigned to query. Search videos None Video Search OCD 2.3, Video Archive OCD 2.3 SC-03 OCD 4.3.3, SC-02 OCD 4.3.2
2.2.8 Search Result
It is set of video file names generated by a particular combination search criteria.
Table 13
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Search Result Display file names based on Search query The purpose of search result is to retrieve all the results relevant to the search query entered by the user. Display video file names None Video Search OCD 2.3, Video Archive OCD 2.3 SC-03 OCD 4.3.3, SC-02 OCD 4.3.2
2.2.9 Video Files
It is the actual data file selected by system to be displayed as video.
Table 14
Name Role Purpose
Video Files To compare video files The purpose of the Video Files is to display two videos simultaneously, to compare them. Responsibilities Display and comparison SSAD_LCA_F04a_T11.doc 10 Version Date 11/21/2004
System and Software Architecture Description(SSAD) Attributes Operations System Capabilities
Version 0.6
None Simultaneous playback OCD2.3, Snap Shot Image OCD 2.3 SC-01 OCD 4.3.1, SC-04 OCD 4.3.4
2.2.10
Image File
System generates image file from a frame within the selected video file.
Table 15
Name Role Purpose Responsibilities Attributes Operations System Capabilities
Image File Used for Annotation The purpose of image file is to annotate it so that desired features in it can be highlighted. Annotation None Edit Image OCD 2.3 SC-04 OCD4.3.4
SSAD_LCA_F04a_T11.doc
11
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3 Behavior
2.3.1Processes
Add Vid eos
Add Criteria
Delete Videos
Login worker Change Password
Update Video Info
Faculty
(f rom Business Use-Case Model)
Save Administrator Add User Profile
(f rom Business Use-Case Model)
User Delete User Profile Student Search
Display 2 Videos
Capture frame
Annotate
Fil e Server
Figure 4
SSAD_LCA_F04a_T11.doc
12
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.1 Process-01: Login
This process is used by the system to authenticate the user system will ask the user to enter the login name and password, user will enter the information and system will validate it and allow the user to access the system.
User: User System: NSF Database
System not accessable
Provide Login Informaton
Authenticate User
[ Invalid User ] Error Page Returned [ Valid User ]
System Accessable
Figure 5
Table 16 Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: Process-01 Login No To login user in system. Administrator, Worker, Student and faculty Primary SC-05 OCD 4.3.5 RQ-05 OCD 3.2.1.1 Client may want to integrate with authentication or use LDAP of ISD in future. No Yes
widows
High-Risk? Architecturally Significant? LCO Development Status SSAD_LCA_F04a_T11.doc
13
Version Date 11/21/2004
System and Software Architecture Description(SSAD) Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points: User must enter proper and correct information Login Screen User has login screen. User will be able to use system. None None None N/A
Version 0.6
Typical Course of Action Seq. # 1. 2 3 Alternate Course of Action Seq. # 1. 2 3 Actor Actions System Response User enters login name and password. System Invalidates the information. System is not accessible. Actor Actions System Response User enters login name and password. System validates the information. System allow user to enter in the system.
No Exceptional Course of Action
2.3.1.2 Process-02: Update Video Info
Administrator to add or update search criteria of movies in the database uses this process.
SSAD_LCA_F04a_T11.doc
14
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
User: Administrator
System: NSF Database System
Update Criteria for Video
System Assign to Video
Figure 6
Table 17
LCO User wants to update database to delete obsolete videos and add new videos and to set the searching criteria. Uploading Screen. User Interface User must have new video to add and some video to Precondition: delete. Database will be updated Post-condition: None Specializes: None Includes: SSAD_LCA_F04a_T11.doc 15 Version Date 11/21/2004
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant? Development Status Overview:
Process-02 Update Video Info No To add or update search criteria for the movies Administrator. Primary SC-02 OCD 4.3.2 RQ-04 SSRD 3.2.1.1 TBD No Yes
System and Software Architecture Description(SSAD) Extends: Extension Points: None N/A
Version 0.6
Typical Course of Action Seq. # 1. 2 Actor Actions System Response Administrator chooses video and set of criteria from list. System Assign the criteria to the video.
No Alternate Course of Action No Exceptional Course of Action
2.3.1.3 Process-03: Search Videos
This process is used by users to search the video clips, which they want to display concurrently.
User: User System: NSF Database System
System Accessible
Enter Search Criteria
System Search
[ Result not found ] Result Found Return Results
Figure 7
SSAD_LCA_F04a_T11.doc
16
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Table 18
Version 0.6
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant? Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points:
Process-03 Search Videos No To Search the specific videos on certain criteria. Student, Faculty, Administrator. Primary SC-04 OCD 4.3.3 RQ-01 SSRD 3.2.1.1 User may require a new set of criteria not already present in the system. No Yes LCO User want to search movie file to play. Searching Page. User must have certain films in the database. User will have some clips to play. None None None N/A
Typical Course of Action Seq. # 1. 2 Actor Actions System Response User enter certain criteria to search. System search the criteria database and display the result
in
Alternate Course of Action: Wrong Search criteria
Seq. # Actor Actions System Response
1. 2 3 4
User Enter the certain criteria to search the clips. System performs the search and found no clips in database. User changes the search criteria. System again search in the database and display the result.
No Exceptional Course of Action SSAD_LCA_F04a_T11.doc
17
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.4 Process-04: Display 2 Videos
This process is used by the system to display two videos concurrently, user see two videos side by side and makes comparison of both.
User: User
Browser: Website
Select 2 Videos
Stream Videos
View 2 Videos Simultaneously
Figure 8
Table 19
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks:
Process-04 Display 2 Videos. No To display two videos concurrently to compare them. Student, faculty, Administrator. Primary SC-01 OCD 4.3.1 RQ SSRD 3.2.1.1 Corrupted Video files. 18 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) High-Risk? Architecturally Significant? Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points: No Yes
Version 0.6
LCO User wants to see two movies concurrently to compare them and make some result from them. Display page. User must have 2 or more search results. Two movies will be displayed concurrently. None None None N/A
Typical Course of Action Seq. # 1. 2 3 Actor Actions User selects two clips to play. User gets the film displayed. System Response System stream video.
Alternate Course of Action: None Exceptional Course of Action: None
2.3.1.5 Process-05: Capture Frame
This process is used to capture the frame after the comparison of the video clips. After capturing the image user can annotate the image file to highlight its necessary parts.
SSAD_LCA_F04a_T11.doc
19
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
User: User
Browser: Website
Video Display mode
Select Frame to capture
Display frame as Image file
Not Desired Image [ Desired Image ] Image annotation mode
Figure 9
Table 20
Process-05 Identifier: Capture Frame. Use-Case Name: No Abstract: To get an image after the comparison of clips. Purpose: Student, faculty, Administrator. Actors: Primary Importance SC-04 OCD 4.3.4 Capability: RQ-03 SSRD 3.2.1.1 Requirements: COTS for capturing of image not available. Risks: No High-Risk? Yes Architecturally Significant? SSAD_LCA_F04a_T11.doc 20 Version Date 11/21/2004
System and Software Architecture Description(SSAD) Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points:
Version 0.6
LCO User wants an image to capture after he has compared the films. Display page. User must have 2 videos playing side by side. User will get an image. None None None N/A
Typical Course of Action Seq. # 1. 2 3 Actor Actions User selects frame to capture. System Response System display film as image. System captures image.
Exceptional Course of Action: Wrong Selection of frame
Seq. # Actor Actions System Response
1. 2 3
User selects frame to capture. System capture image. User may repeat capturing process if does not get the desire image.
Alternate course of Action: None
2.3.1.6 Process-06: Annotate Image
Users edit the image using this process, after the capturing of frame user want the result be edited on the image, which they have analyzed.
SSAD_LCA_F04a_T11.doc
21
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
User: User
Browser: Website
Select annotation tool
Annotate Image
Figure 10
Table 21
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant? Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points:
Process-06 Annotate Image. No To edit image. Student, faculty, Administrator. Primary SC-04 OCD 4.3.4 RQ-04 SSRD 3.2.1.1 COTS not available for annotation. No Yes LCO User wants edit to the image to write the result he found on the image. Annotation page. User must have a captured image. User will have an annotated image. None None None N/A 22 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) Typical Course of Action Seq. # 1. 2 3 Actor Actions System Response User selects select annotation tool. System annotate image. User save image.
Version 0.6
Alternate Course of Action: None Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
23
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.7 Process-07: Change Password
User will enter the specific information in the required by the system, system will authenticate the information and if the information is authenticated users password will change.
User: User
System: NSF Database
Enter Required Info
Validate Info
[ Info Validated ] [ Info not Validated ] Change Password
Figure 11
Table 22
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk?
Process-07 Change Password. No To Change the password. Student, faculty, Administrator, Worker. Primary SC-06 OCD 4.3.6 RQ-06 SSRD 3.2.1.1 No No 24 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) Architecturally Significant? Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points: Yes
Version 0.6
LCO User want to change the password of his/her account. User Interface.. User must be registered with the system. User will have new password None None None N/A
Typical Course of Action Seq. # 1. 2 Actor Actions System Response User enter the information required by the system System will validate the information. System will change the password.
Alternate Course of Action: None Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
25
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.8 Process-08: Add User Profile
Administrator will use this process to assign role to the user of the system so that they can access to the specific part of the system for which they have privileges.
Administrator: User
Sys te m: NSF Dat abase Sys te m
Enter User Info Validate Info
[ Info Validated ] [ Info Not Validated ] Save Info
Figure 12
Table 23
Process-09 Identifier: Add User Profile Use-Case Name: No Abstract: To Assign the role to user. Purpose: Administrator. Actors: Primary Importance SC-08 OCD 4.3.8 Capability: RQ-08 SSRD 3.2.1.1 Requirements: No Risks: SSAD_LCA_F04a_T11.doc 26
Version Date 11/21/2004
System and Software Architecture Description(SSAD) High-Risk? Architecturally Significant? Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points: No Yes
Version 0.6
LCO Administrator will use this process to assign the role so that user can access system. Administrator Interface. User must be registered with the system. User will be able to access the system. None None None N/A
Typical Course of Action Seq. # 1. 2 3 Actor Actions System Response Administrator enters the user information. System will validate the information. System will store information in database.
Alternate Course of Action: None Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
27
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.9 Process-9: Delete User Profile
Administrator will use this process to delete the role of the user of the system so that they cannot access system.
Adminstrator : User
System: NSF Database Syste
Enter Info
Valiate Info
[ Info Not Validated ] [ Validated Info ] Delete User
Figure 13
Table 24
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant? Development Status
Process-9 Delete User Profile. No To delete role to user. Administrator. Primary SC-08 OCD 4.3.8 RQ-08 SSRD 3.2.1.1 No No Yes LCO 28 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points:
Version 0.6
Administrator deletes the users role so that he/she cannot access the system. Administrator Interface. User must be assigned a role by the administrator. User will be not be able to access the system. None None None N/A
Typical Course of Action Seq. # 1. 2 3 Actor Actions System Response Administrator enters the user information. System will validate the information. System will delete information from database.
Alternate Course of Action: None Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
29
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.10 Process-10: Add Video
Administrator and worker will use this process to add videos in the database and to set its search criteria.
Administrator/Worker: User
System: N SF Da ta base
Select Video
Validate Video
[ Video Not Validate ]
[ Video Validated ]
Add in Database
Figure 14
Table 25
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant?
Process-10 Add Video. No To add video in the database. Administrator, Worker. Primary SC-02 OCD 4.3.2 RQ-04 SSRD 3.2.1.1 No No Yes 30 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points:
Version 0.6
LCO Administrator and worker will use this process to add videos in the database. Add Video Interface. Administrator and worker must be login in the system and they must have video to add. New video will be available in the database. None None None N/A
Typical Course of Action Seq. # 1. 2 3 Actor Actions System Response Administrator or worker will select the video to add. System validates video. System will add the video in database.
Alternate Course of Action: None Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
31
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.11 Process-11: Delete Video
Administrator will use this process to delete movies from the database.
Adminstrator/ Worker: User
System: NSF Database System
Select Video Validate Video
[ Video Validated ] [ Video Not Validated ] Delete Video
Figure 15
Table 26
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant? Development Status Overview:
Process-11 Delete Video. No To Delete the video. Administrator. Primary SC-02 OCD 4.3.2 RQ-04 SSRD 3.2.1.1 No No Yes LCO Administrator will delete the video from the system. 32 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points:
Version 0.6
Administrator Interface. Video to be deleted must be present in the database. Video will be removed from the system. None None None N/A
Typical Course of Action Seq. # 1. 2 3 Actor Actions System Response Administrator or worker will select the video to delete. System will validate video. System will delete video from database
Alternate Course of Action: None Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
33
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.12 Process-12: Save Image
Administrator, faculty and student will use this process to save the annotated image.
User: User
System: N SF Da ta base Sy stem
Select Image
Save
Figure 16
Table 27
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant? Development Status Overview: User Interface Precondition: Post-condition:
Process-12 Save Image No To Save the clip after the annotation. Administrator, Student, Faculty. Primary SC-04 OCD 4.3.4 RQ-04 SSRD 3.2.1.1 No No Yes LCO Administrator, faculty and student will use this process to save the annotated image. Image must be present. User will have and image file at the system. 34 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) Specializes: Includes: Extends: Extension Points: None None None N/A
Version 0.6
Typical Course of Action Seq. # 1. 2 Actor Actions User will click annotation. System Response save after System will save it.
Alternate Course of Action: None Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
35
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.1.13 Process-13: Add Criteria
Administrator will use this process to add new criteria for searching.
Administrator: User
Sys te m: NSF Datab as e Sys te m
Enter Criteria
Check in Database
[ Not already present ] Already Present Add in Database
Figure 17
Table 28
Identifier: Use-Case Name: Abstract: Purpose: Actors: Importance Capability: Requirements: Risks: High-Risk? Architecturally Significant?
Process-13 Add Criteria. No To add new criteria for search. Administrator. Primary SC-07 OCD 4.3.7 RQ-07 SSRD 3.2.1.1 No No Yes 36 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD) Development Status Overview: User Interface Precondition: Post-condition: Specializes: Includes: Extends: Extension Points:
Version 0.6
LCO Administrator will use this process to add new criteria for search in the system. Particular criteria must not be present in the system. A new criteria will be added in the system. None None None N/A
Typical Course of Action Seq. # 1. 2 3 Alternate Course of Action 1. 2 3 Administrator will enter new criteria. System will check it in database. If present in database system will not store it in database. Actor Actions System Response Administrator will enter new criteria. System will check it in database. If not present in database system will store it in database.
Exceptional Course of Action: None
SSAD_LCA_F04a_T11.doc
37
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.3.2Modes of Operation
Administrator Mode
Student Mode
Figure 18
2.3.2.1 Mode 01 Student Mode
Table 29
Capability
SC-03 Search Video Clips
Process Process-04: Search
Model Impact LR-02 SSRD 5.2 applies to this mode. Student will have limited access to the system. Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
38
System and Software Architecture Description(SSAD)
Version 0.6
2.3.2.2 Mode 02 Administrator Mode
Table 30
Capability
SC-03 Search Video Clips SC-02 Update Archive SC-02 Update Archive SC-02 Update Archive
Process Process-04: Search Process-02: Update Criteria Process-02: Add video Process-02: Delete Video Process-02: Add User Role Process-02: Delete User Role
Model Impact LR-04 SSRD 5.4 Search the video files. LR-01 SSRD 5.1 Update Search criteria LR-01 SSRD 5.1 Add video file. LR-01 SSRD 5.1 Delete Vide file. LR-01 SSRD 5.1 Add new user. LR-01 SSRD 5.1 Delete Existing user.
2.4 L.O.S. Goals
This section maps the LOS requirements to specific system processes.
Table 31
L.O.S requirement LR-1 [SSRD 5.1]: Easy To Maintain
LR-2 [SSRD 5.2]: Searching Response Time LR-3 [SSRD 5.3]: System Security LR-4 [SSRD 5.4]: System Scalability
Applies to Process-10: Add Video Process-11: Delete Video Process-02: Update Video Info Process-08: Add User Profile Process-09: Delete User Profile Process-13 : Add Criteria Process-03: Search Process-01: Login Process-07: Change Password Process-12: Save Process-03: Search Process-04: Display 2 Videos Process-05: Capture Frame Process-06: Annotate
How Equally
Equally Equally Equally
SSAD_LCA_F04a_T11.doc
39
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
2.5 Rules
2.5.1 User must be registered with system to access system OCD 4.5.4.1 2.5.2 User must login in system to use the system OCD 4.5.4.1
Table 32
Organization Rule OR2 OCD 3.3.4 OR1 OCD 3.3.4
System Rule OCD 4.5.4.1.1 OCD 4.5.4.1.2
Applies To Process-08 Mode 01 Process-01 Mode-02, 01
SSAD_LCA_F04a_T11.doc
40
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3 Architecture Design & Analysis
3.1 Structure
The system is basically in the form of a 3-tier architecture consisting of a client-server model between the users and the application server, and another client server model between the application server and the file server. The basic purpose of the 3-tier architecture is separation of user- interface-control and data presentation from application logic.
3.1.1Topology
<<layer>> Application
<<layer>> Business
<<layer>> Database
<<layer>> Hardware
Figure 19
3.1.1.1 Application Layer
The purpose of this layer is to provide the interface to the external actor to interact with the system. This layer provide three different interfaces fro three different actors and this SSAD_LCA_F04a_T11.doc 41 Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
layer is meant to take the actor information and pass it to the lower layers or to display the information collected from the lower layer to the actors.
<<Partiti on>> Faculty
<<Partiti on>> Student
<<Pa rtiti on>> Worker
<<Partiti on>> Admi ni strator
Figure 20
3.1.1.1.1
Faculty
Faculty is the partition of the Client layer this layer provide the interface to the actor of the system whose role is faculty. 3.1.1.1.2 Student
Student is the partition of the Client layer this layer provide the interface to the actor of the system whose role is student. 3.1.1.1.3 Workers
Worker is the partition of the Client layer this layer provide the interface to the actor of the system whose role is student worker. 3.1.1.1.4 Administrator
Administrator is the partition of the Client layer this layer provide the interface to the actor of the system whose role is Administrator.
3.1.1.2 Business Layer
This is the main layer of the system, which interconnect the client layer and the database layer. This layer provides different functionalities, which the actor can use at the client layer to interact with the database layer.
SSAD_LCA_F04a_T11.doc
42
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
<<Partition>>
Video Server
Figure 21
3.1.1.2.1
Video Server
Video server is responsible for taking file out of database and sending it to user to perform different functionalities on the server. Video server contains the main functionalities of the system and user accesses the video server to do different functionalities.
3.1.1.3 Database Layer
This is the layer that contain whole set of information for the video archives, which the user at the client layer will be demanding, this layer is in connection with the application layer.
<<Partition>>
Database Management System
Figure 22
3.1.1.3.1
Database Management System
Database management system is used to maintain database system containing
3.1.1.4 Hardware Layer
Hardware Layer will contain the server on which Database, file server and application server will run, also Hardware Layer will contain the workstations on which the user will run the application which will be accessing the server via network.
<<Partition>>
Server
(from Configurati...)
<<Partition>>
Workstation
Figure 23
3.1.1.4.1
Server
Server is the hardware component where the application and file server will reside.
SSAD_LCA_F04a_T11.doc
43
Version Date 11/21/2004
System and Software Architecture Description(SSAD) 3.1.1.4.2 Workstation
Version 0.6
Workstation is the hardware component from where the user will access the system.
3.1.2Hardware Classifier Model
Hardware classifier model shows the hardware component i.e. workstation and server on which NSF Database system will run and show the connector which connect the component of the system which is Network.
<<conne ctor>> Network <<node>> Server
<<node>> Workstation
+client 0..*
+server 1
Figure 24
3.1.3Software Classifier Model
Software classifier model shows the software components user interface, which depend on video server and video server depends on database server.
<<component>>
User Interface
<<component>>
Video Server
<<component>>
Database Server
Figure 25
SSAD_LCA_F04a_T11.doc
44
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3.1.4Deployment Model
In this section, a configuration of the system is presented to describe how the instances of software components and instances of hardware components interact with each other, and how connectors relate the components to each other. The configuration is shown as the following diagram
<<component>> Web Browser: User Interface <<component>> The Video Server: Video Serv er <<component>> The Database Server: Database Server
resides on
resides on
<<connector>>
resides on
resides on
<<node>> User_Station : Workstation
+client
0..*
LAN : Network
+server
1
<<node>> Biomechanics Lab Server : Server
Figure 26
3.1.5Hardware Component Classifiers
3.1.5.1 Server
3.1.5.1.1 Purpose The hardware component classifier Server represents the physical place where all the software component classifiers are allocated 3.1.5.1.2 L.O.S. Goals
System Security, Easy to maintain: Application Server, file server and database server will be placed on the server so that security can be provided and it should be easily maintain.
Table 33
The system should be accessed by different users and the main database server is not directly accessed by users. Measurable: The students cannot modify the archives in database. Relevant: OCD 4.4, SSRD 5.3 Specific: The system will provide different user interface to different users. SSAD_LCA_F04a_T11.doc 45 Version Date 11/21/2004
Level of Project requirement: Description:
LR-03 System Security
System and Software Architecture Description(SSAD)
Version 0.6
Table 34
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
3.1.5.2 Workstation
3.1.5.2.1 Purpose The hardware component classifier workstation represents the physical place from where the user will access the system and will use the system. 3.1.5.2.2 L.O.S. Goals
System Scalability: System will run on LAN so that it should provide scalability.
Table 35
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
3.1.6Hardware Connector Classifiers
3.1.6.1 Network
Network connector between client machines and application server. This is a network that connects the various client machines to the central server.
SSAD_LCA_F04a_T11.doc
46
Version Date 11/21/2004
System and Software Architecture Description(SSAD) 3.1.6.1.1 Purpose
Version 0.6
This is the network connection on which all the clients are able to submit keywords, issue requests and all other things to the application server. 3.1.6.1.2 L.O.S. Goals
System Scalability, System Security: This network connector connects the client machines to the server; hence it is responsible for the performance of the system. It is also responsible for the security of the data, to prevent unauthorized or illegal transfers of data over it.
Table 36
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users.
Table 37
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
3.1.7Software Component Classifiers
This section describes the details of software component classifiers as shown in section 3.1.3s component diagram.
SSAD_LCA_F04a_T11.doc
47
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3.1.7.1 User Interface
3.1.7.1.1 Purpose User accesses system by using the user interface, all user of the system have the same user interface but the options available on the interface may be different based on the privileges assigned to the user. 3.1.7.1.2 LOS Goals
Table 38
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
Table 39
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
Table 40
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users.
SSAD_LCA_F04a_T11.doc
48
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3.1.7.2 Video Server
3.1.7.2.1 Purpose The software component classifier video server is main component of system; it is consisted of all the main functionalities provided by the system like authentication, searching, displaying, annotation and saving etc. This video server receives the user request and to full fill the user request it accesses Database server which contains the user profiles and video files. 3.1.7.2.2 L.O.S. Goals
System Security, System scalability, Easy to maintain, Searching Response Time: Application server will contain whole system so it should provide security, scalability, it should be easy to maintain and it should use efficient method to reduce response time.
Table 41
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
Table 42
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
Table 43
The system should be able to respond to the user search within 10-15 seconds, Measurable: Users get search result within 15 seconds. Relevant: OCD 4.4, SSRD 5.2 SSAD_LCA_F04a_T11.doc 49 Version Date 11/21/2004
Level of Project requirement: Description:
LR-2: Searching response time
System and Software Architecture Description(SSAD) Specific:
Version 0.6
The response time to user searching should not be more than 15 seconds.
3.1.7.3 Database Server
3.1.7.3.1 Purpose The software component classifier database server is repository of video files, video file information and users profile. This information is used by the system during the process. 3.1.7.3.2 L.O.S. Goals
System Security, Easy to maintain: Database server will contain the whole information regarding videos and user so it should provide security and it should be easy to maintain.
Table 44
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users.
Table 45
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
SSAD_LCA_F04a_T11.doc
50
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3.1.8Software Connector Classifiers
There are no software connector classifiers as it is shown in software classifier model.
3.1.9Hardware Components
3.1.9.1 Server
3.1.9.1.1 Purpose The hardware component classifier Server represents the physical place where all the software component classifiers are allocated 3.1.9.1.2 Classifier
This hardware component is a instance of the classifier Server 3.1.9.1.3 L.O.S.
System Security, Easy to maintain: Application Server, file server and database server will be placed on the server so that security can be provided and it should be easily maintain.
Table 46
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users.
Table 47
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
SSAD_LCA_F04a_T11.doc
51
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3.1.9.2 Workstation
3.1.9.2.1 Purpose The hardware component classifier workstation represents the physical place from where the user will access the system and will use the system. 3.1.9.2.2 Classifier
This hardware component is a instance of the classifier Workstation 3.1.9.2.3 L.O.S.
System Scalability: System will run on LAN so that it should provide scalability.
Table 48
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
3.1.10
Hardware Connectors
3.1.10.1 Network
3.1.10.1.1 Purpose This is the network connection on which all the clients are able to submit keywords, issue requests and all other things to the application server. 3.1.10.1.2 Classifier This hardware connector is a instance of the classifier Network 3.1.10.1.3 L.O.S. System Scalability, System Security: This network connector connects the client machines to the server; hence it is responsible for the performance of the system. It is also responsible for the security of the data, to prevent unauthorized or illegal transfers of data over it. SSAD_LCA_F04a_T11.doc 52 Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Table 49
Version 0.6
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
Table 50
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users.
3.1.11
3.1.11.1
Software Components
User Interface
3.1.11.1.1 Purpose User accesses system by using the user interface, all user of the system have the same user interface but the options available on the interface may be different based on the privileges assigned to the user. 3.1.11.1.2 Classifier This component is an instance of the classifier User Interface. 3.1.11.1.3 LOS Goals
SSAD_LCA_F04a_T11.doc
53
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Table 51
Version 0.6
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
Table 52
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
Table 53
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users.
3.1.11.2 Video Server
3.1.11.2.1 Purpose The software component classifier video server is main component of system; it is consisted of all the main functionalities provided by the system like authentication, searching, displaying, annotation and saving etc. This server receives the user request and SSAD_LCA_F04a_T11.doc 54 Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
to full fill the user request it accesses Database server which contains the user profiles and video files. 3.1.11.2.2 Classifier This component is an instance of the classifier Application Server 3.1.11.2.3 L.O.S. System Security, System scalability, Easy to maintain, Searching Response Time: Application server will contain whole system so it should provide security, scalability, it should be easy to maintain and it should use efficient method to reduce response time.
Table 54
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-04 System Scalability The system is able to handle at least 20 simultaneous users. 20 students are able to login and work in the system at the same time. OCD 4.4, SSRD 5.4 The system is able to handle 20 users at the same time
Table 55
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
Table 56
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users. 55 Version Date 11/21/2004
SSAD_LCA_F04a_T11.doc
System and Software Architecture Description(SSAD)
Version 0.6
3.1.11.3 Database Server
3.1.11.3.1 Purpose The software component classifier database server is repository of video files, video file information and users profile. This information is used by the system during the process. 3.1.11.3.2 Classifier This component is an instance of the classifier Database Server 3.1.11.3.3 L.O.S. System Security, Easy to maintain: Database server will contain the whole information regarding videos and user so it should provide security and it should be easy to maintain.
Table 57
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-01 Easy to maintain The proposed system should be easy to maintain for faculty The faculty should be able to maintain the database with minimum training. OCD 4.4, SSRD 5.1 The faculty could maintain the website with less than 2 times training.
Table 58
Level of Project requirement: Description: Measurable: Relevant: Specific:
LR-03 System Security The system should be accessed by different users and the main database server is not directly accessed by users. The students cannot modify the archives in database. OCD 4.4, SSRD 5.3 The system will provide different user interface to different users.
3.1.12 Software Connectors
There are no software connectors in the system as shown in the software classifier model. SSAD_LCA_F04a_T11.doc 56 Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3.2
Analysis Classes
This section describes the information classes that are used to support the architecture structure [SSAD 3.1] and implement the system behavior [SSAD 3.3]. In the following class diagram, it shows what are the information classes and their relations
<<boundary>> Dis play Form
Faculty User Student
<<boundary>> Search Form <<boundary>> Annotation Form <<boundary>> Save Form
reprensents generates> Search Query Sea rch Resul t Video File
annotates>
saves> Image File adds>
<<boundary>> Add Video Form updates> <<bound ary>> Update Video Info <<boundary>> Login Form adds> <<boundary>> User Registration Form <<boundary>> Update Password adds> adds> Student Profile Wo rker Profile Faculty Profile Admi ni strator Pro fi le
Video Catalog
Adminsitrator
Worker
Database
Figure 27
3.2.1Search Form
Used to build search query by selecting different search criteria.
Table 59
Name Purpose Responsibility Attributes
Search Form Use to build search query by selecting different search criteria Search Videos None.
3.2.2Search Query
Query build by user by selecting different search criteria.
SSAD_LCA_F04a_T11.doc
57
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Table 60
Version 0.6
Name Purpose Responsibility Attributes
Search Query To extract the desired videos from the database on the user set criteria. Search Videos in Database None
3.2.3Search Result
Result of Search query, it contains video files from the video catalog.
Table 61
Name Purpose Responsibility Attributes
Search Result Contains the selected video file from database on certain search query Display Videos None
3.2.4Video File
Video files are stored in video catalog in database and user display two video files simultaneously to compare them.
Table 62
Name Purpose Responsibility Attributes
Video File User display two video files simultaneously to compare them. Select to display None
3.2.5Image File
User generates image file after the comparison of two videos.
Table 63
Name Purpose Responsibility Attributes
Image File To highlight the certain features in the image by annotating it. Annotate Image file None
SSAD_LCA_F04a_T11.doc
58
Version Date 11/21/2004
System and Software Architecture Description(SSAD)
Version 0.6
3.2.6Video Catalog
It is part of database it contains video files and video files information.
Table 64
Name Purpose Responsibility Attr...