and System Software Architecture Description (SSAD)
Version 1.3
System and Software Architecture Description (SSAD)
REEO Database
Team 10
NAME Vishal Patel Kalyani Soniminde Nirav Chheda Parag Shah Samit Vyas Swara Desai Mark Dexter ROLE Project Manager/ Prototyper Operational Concept Engineer Requirements Analyst System Analyst Feasibility Analyst Life Cycle Plan Engineer IV&V
November 12, 2007
dd364d940381a7283ac9cae0c57c84a1c2623628.doc i
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Version History
Date 10/19/07 Author Parag Shah Version 1.0 Changes made Original SSAD for LCO Draft made with reference to LeanMBASE Guidelines v1.9 and LeanMBASE Additional SSAD Guidelines v1.7 New Service Chat Room Functionality added in 2.1.1 Actor 6: Volunteers added at 2.1.2.6 Section name corrected for 2.2.1.8 Table Captions corrected for Tables 14 and 22. Tables 19 and 38 have been elaborated. Added Table 33 Changes made to requirements to make it consistent with SSRD v1.2 Section 3, 4 and 5 added. Naming Conventions added in Section 1.2 Reference: Section 1.3 has been modified. Modes of Operation in Section 2.3.2 have been rectified. Numbering error fixed in 2.1.1.2.2 Corrected entries in Table 58 New risks have been identified in Table 60 Feedback received from Architecture Review Board session has been incorporated. New sections have been added to meet the completion criteria for LCO Package. Feedback received from QFP in the form of AAR. Rationale Initial draft of SSAD
10/24/07
Parag Shah
1.1
10/29/07 Parag Shah Samit Vyas 1.2
The high priority and high criticality issues highlighted by IV&V in his review on 10/22/07 need to be taken care of as soon as they are discovered. Some inconsistencies with SSRD and OCD documents were found after the same were updated to a new version.
11/12/07
Parag Shah
1.3
dd364d940381a7283ac9cae0c57c84a1c2623628.doc ii
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Table of Contents
System and Software Architecture Description (SSAD).....................................................i Version History...................................................................................................................ii Table of Contents...............................................................................................................iii Table of Tables...................................................................................................................v Table of Figures................................................................................................................vii 1 Introduction.......................................................................................................................1 1.1 Purpose of the SSAD Document................................................................................1 1.2 Standards and Conventions........................................................................................1 1.3 References..................................................................................................................1 2 System Analysis................................................................................................................3 2.1 Summary of System Analysis Model........................................................................3 2.1.1 Structure..............................................................................................................3 2.1.1.1 System..........................................................................................................4 2.1.1.2 Actor............................................................................................................4 2.1.2 Artifacts & Information......................................................................................8 2.1.2.1 Artifact or Information Classes....................................................................8 2.1.3 Behavior............................................................................................................13 2.1.3.1 Processes....................................................................................................13 2.1.3.2 Modes of Operation...................................................................................27 2.2 Rationale for System Analysis.................................................................................27 3 Platform/TechnologyIndependent Model.....................................................................28 3.1 Summary of TIM.....................................................................................................28 3.1.1 Structure............................................................................................................29 3.1.1.1 Deployment Model....................................................................................29 ..............................................................................................................................32 3.1.1.2 Software Classifier Model.........................................................................32 3.1.1.3 Hardware Classifier Model........................................................................47 3.1.2 Information Classes..........................................................................................50 3.1.2.1 Information Class Descriptions..................................................................50 3.1.3 Behavior............................................................................................................51 3.1.4 Architectural styles, patterns and framework...................................................51 3.2 Rationale for TIM....................................................................................................51 4 Platform/TechnologySpecific Model............................................................................52 4.1 Structure...................................................................................................................52 4.1.1 Hardware Classifier Model...............................................................................52 4.1.2 Software Classifier Model ...............................................................................52 4.1.3 Deployment Model...........................................................................................52 4.1.4 Hardware Component Classifiers.....................................................................52 4.1.5 Hardware Connector Classifiers.......................................................................52 4.1.6 Software Component Classifiers.......................................................................52 4.1.7 Hardware Components......................................................................................52 4.1.8 Software Components.......................................................................................53
dd364d940381a7283ac9cae0c57c84a1c2623628.doc iii
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
4.1.9 Information Classes..........................................................................................53 4.1.9.1 Objects.......................................................................................................53 4.2 Behavior...................................................................................................................53 4.3 Patterns & Frameworks ...........................................................................................53 4.4 Project Artifacts.......................................................................................................53 5 Glossary for System Analysis and Design......................................................................54
dd364d940381a7283ac9cae0c57c84a1c2623628.doc iv
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Table of Tables
Table 1: System Administrator............................................................................................4 Table 2: Executive Board Member......................................................................................5 Table 3: Corporate Partner...................................................................................................5 Table 4: Student...................................................................................................................5 Table 5: Community College Partner..................................................................................6 Table 6: Volunteer...............................................................................................................6 Table 7: Artifact: Student Profile.........................................................................................9 Table 8: Artifact: Job Request Form....................................................................................9 Table 9: Artifact: Community College Partner Profile........................................................9 Table 10: Artifact: Employer Profile.................................................................................10 Table 11: Artifact: Job Profile...........................................................................................10 Table 12: Artifact: Event Calendar....................................................................................10 Table 13: Artifact: Chat Log..............................................................................................11 Table 14: Artifact: Student Resume...................................................................................11 Table 15: Artifact: Student Progress Report......................................................................11 Table 16: Artifact: Log File...............................................................................................12 Table 17: Artifact: Job Schedule........................................................................................12 Table 18: Use Case Description: Job Application.............................................................13 Table 19: Typical Course of Action: Job Application.......................................................14 Table 20: Alternate Course of Action: Job Application....................................................14 Table 21: Use Case Description: Social Networking........................................................15 Table 22: Typical Course of Action: Social Networking..................................................15 Table 23: Alternate Course of Action: Social Networking................................................15 Table 24: Use Case Description: Login.............................................................................16 Table 25: Typical Course of Action: Login.......................................................................16 Table 26: Alternate Course of Action: Login....................................................................16 Table 27: Use Case Description: Logout...........................................................................17 Table 28: Typical Course of Action: Logout.....................................................................17 Table 29: Alternate Course of Action: Logout..................................................................17 Table 30: Use Case Description: Create Profile................................................................18 Table 31: Typical Course of Action: Create Profile..........................................................18 Table 32: Alternate Course of Action I: Create Profile.....................................................18 Table 33: Alternate Course of Action II: Create Profile....................................................19 Table 34: Use Case Description: Update Profile...............................................................20 Table 35: Typical Course of Action: Update Profile.........................................................20 Table 36: Alternate Course of Action: Update Profile......................................................20 Table 37: Use Case Description: User searching for Jobs.................................................21 Table 38: Typical Course of Action: User searching for Jobs...........................................21 Table 39: Use Case Description: Corporate partners searching for employees.................22 Table 40: Typical Course of Action: Corporate partners searching for employees..........22 Table 41: Use Case Description: Event Scheduling..........................................................23 Table 42: Typical Course of Action: Event Scheduling....................................................23
dd364d940381a7283ac9cae0c57c84a1c2623628.doc v
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Table 43: Use Case Description: Event Registration.........................................................24 Table 44: Typical Course of Action: Event Registration...................................................24 Table 45: Use Case Description: Job Posting....................................................................25 Table 46: Typical Course of Action: Job Posting..............................................................25 Table 47: Use Case Description: Email notification and reminders..................................26 Table 48: Typical Course of Action: Email notification...................................................26 Table 49: Use Case Description: Report Generation.........................................................27 Table 50: Typical Course of action: Report Generation....................................................27 Table 51: Process Use Case Description: Job Application................................................33 Table 52: Process Use Case Description: Login................................................................33 Table 53: Process Use Case Description: Logout..............................................................34 Table 54: Process Use Case Description: Create Profile...................................................34 Table 55: Process Use Case Description: User searching for Jobs....................................34 Table 56: Process Use Case Description: Corporate partners searching for employees.. .35 Table 57: Process Use Case Description: Event Scheduling.............................................36 Table 58: Process Use Case Description: Event Registration...........................................36 Table 59: Process Use Case Description: Email notification and reminders.....................38 Table 60: Process Use Case Description: Social Networking...........................................40 Table 61: Process Use Case Description: Report Generation............................................42 Table 62: Process Use Case Description: Update Profile..................................................44 Table 63: Process Use Case Description: Job Posting.......................................................45 Table 64: Level of Service Specification Form: Web Server............................................47 Table 65: Use Case Realization Description.....................................................................51
dd364d940381a7283ac9cae0c57c84a1c2623628.doc vi
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Table of Figures
Figure 1: REEO Database System Structure.......................................................................3 Figure 2: System Information Table....................................................................................8 Figure 3: Deployment Model.............................................................................................29 Figure 4: Software Classifier Model..................................................................................32 Figure 5: Hardware Classifier Model................................................................................47 Figure 6: Information Classes Model................................................................................50
dd364d940381a7283ac9cae0c57c84a1c2623628.doc vii
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
1 Introduction
1.1 Purpose of the SSAD Document
The purpose of the SSAD is to document the results of the object-oriented analysis and design (OOA&D) for the REEO Database. It provides an analysis of the organizational concept for the database by designing the architecture. It serves as a bridge between the Operational Concept defined during the Inception phase and the Construction phase by providing an in-depth architectural design and implementation of the proposed system. The initial draft of the SSAD document consists of the description of system analysis, behavior, and modes of operation of the REEO database.
1.2 Standards and Conventions
The following standards are used in the SSAD document: LeanMBASE Guidelines Version 1.9 UML version 2.0 notations The following naming conventions are used: Nouns Components and Objects Verbs Behavior and Patterns.
1.3 References
The following references were used to build this SSAD document: LeanMBASE Guidelines Version 1.9 o http://greenbay.usc.edu/csci577/fall2007/site/guidelines/LeanMBASE_Gu idelines_V1.9.pdf LeanMBASE Additional_SSAD Guidelines Version 1.7.1 o http://greenbay.usc.edu/csci577/fall2007/site/guidelines/New SSAD guidelines Part I.071027.pdf LeanMBASE Version 1.9 Templates for SSAD o http://greenbay.usc.edu/csci577/fall2007/site/guidelines/LeanMBASE_v1. 9_templates_for_SSAD.doc dd364d940381a7283ac9cae0c57c84a1c2623628.doc 1 Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Sample SSAD Document for LCO Package: Team 3 Fall 2006 CSC Volunteer Tracking System o http://greenbay.usc.edu/csci577/fall2007/site/guidelines/SSAD_LCO_F06 a_T03_V2.2.pdf SSAD Document for LCO Package: Team 15 Fall 2006 LANI Database Management System o http://greenbay.usc.edu/csci577/fall2006/projects/team15/LCO/SSAD_LC O_F06a_T15_v1.3.pdf Sample OCD Document for LCO Draft: Team 3 Fall 2006 CSC Volunteer Tracking System o http://greenbay.usc.edu/csci577/fall2007/site/guidelines/OCD_LCO_F06a _T03_V3.1.pdf Sample SSRD Document for LCO Draft: Team 3 Fall 2006 CSC Volunteer Tracking System o http://greenbay.usc.edu/csci577/fall2007/site/guidelines/SSRD_LCO_F06 a_T03_V2.0.pdf Team 10 Fall 2007 REEO Database Website o http://greenbay.usc.edu/csci577/fall2007/projects/team10
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 2
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2 System Analysis
2.1 Summary of System Analysis Model
2.1.1 Structure
Figure 1: REEO Database System Structure
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 3
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.1.1
System
The primary purpose of the REEO Database System is to allow students to search for jobs, for employers to find the best candidates, and provide the students progress studying in various Community Colleges. The system allows students to create their profile, upload their resumes and be able to network with other students. The college administrators and the REEO administrators can track the progress of each student. Employers can post job profiles on the system for the student to read, they can also create event schedules where the students can RSVP. A log file is maintained on the system for the system administrator to keep track of things. The list of services provided by the system is listed as follows: User Authentication Event Notification Event Scheduling Post New Jobs File Handling Tracking User Activity Report Generation Customized Search Profile Creation Chat Room Functionality.
2.1.1.2
2.1.1.2.1
Role Responsibility Attributes Services Processes
Actor
Actor 1: System Administrator
Table 1: System Administrator Administrator Assign username, password, and permissions Maintain well-being of system Administrative rights access to system Assigns appropriate privileges to users Database backup and maintenance Submit user details and user id and password in encrypted format in the system database
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 4
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.1.2.2
Role Responsibility
Actor 2: Executive Board Member
Table 2: Executive Board Member Executive member and manager Identify potential students Verify and post jobs events and college events View, analyze data and generate reports Right to accept/reject event posting and update the event list. Post jobs Post events Send email reminders Analyze data and generate Reports Report generation process Job Posting process Emailing/ messaging service
Attributes Services
Processes
2.1.1.2.3
Role Responsibility
Actor 3: Corporate Partner
Table 3: Corporate Partner Corporate partners Find potential candidates for recruitment Create new job openings and request for posting on the website Contact the potential candidate and schedule an interview. Attend the community college RSP events and recruitment events. Rights to browse the database and search potential candidates based on GPA, Major, skill set, etc and Create new job openings, interview students. Create Job opening Request the system admin to post job Search Potential Candidate Contact Student & Schedule interview Recruit Students Job posting service Customizable searching Service
Attributes Services
Processes
2.1.1.2.4
Role
Actor 4: Student
Table 4: Student Student
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 5
Version Date: 11/12/07
System and Software Architecture Description (SSAD) Responsibility
Version 1.3
Attributes
Create online profile Upload/ Update resume Search Jobs Interact with other community college students Register and attend college events and recruitment events Access to system and upload and download resume, able to search and interact with other community college students, register events Resume Upload/update/edit/download Search jobs Apply jobs Register events Chat with other scholars Interact with corporate partners Online Profile Creation File handling service Job application service Online event registration
Services
Processes
2.1.1.2.5
Role Responsibility
Actor 5: Community College Partner
Table 5: Community College Partner Community College Partners Create events like JumpStart, RSP Review Student reports and find potential students Help students to transfer into 4-year university program Rights to create college events and review student reports Create and request to post events Track and monitor student progress Give academic advice to students Event scheduling process
Attributes Services
Processes
2.1.1.2.6
Role Responsibility
Actor 6: Volunteer
Table 6: Volunteer Sponsors who donate money View organizational progress reports. Donate money to the organization
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 6
Version Date: 11/12/07
System and Software Architecture Description (SSAD) Attributes Services Processes
Version 1.3
Access to static progress report, ability to donate money
N/A Online Profile Creation Static File handling service
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 7
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.2
Artifacts & Information
This section contains information and descriptions of the artifacts like documents and reports inspected, manipulated or produced by the system. It holds the information that the system uses and shows the relation among various artifacts and information.
2.1.2.1
Artifact or Information Classes
Figure 2: System Information Table
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 8
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.2.1.1
Type Id Role Purpose Responsibility Related Capability(s)
Student Profile
Table 7: Artifact: Student Profile
Description
ATF-1 The profile of each student Provides the detailed profile of each student for processes such as job application, security handling etc. Contains all information of each student like name, email, GPA, school, class status etc. CR-1 Central Hub of Information CR-5 Profile Generation Service
2.1.2.1.2
Type Id Role Purpose Responsibility Related Capability(s)
Job Request Form
Table 8: Artifact: Job Request Form
Description
ATF-2 Job request form Provides information about each job that needs students. Job scheduling matches students and job requirements. Contains information about job application like name, description, schedule, profile of preferred candidates, etc. CR-1 Central Hub of Information CR-6 Job Applications CR-12 Email Notification Service CR-14 Customized Searching Service
2.1.2.1.3
Type Id Role Purpose Responsibility Related Capability(s)
Community College Partner Profile
Table 9: Artifact: Community College Partner Profile
Description ATF-3 The profile for community college partner Provides the detailed profile of each college partner for processes such as job application, security handing etc. Contains all information of each college partner like name, email, partner type etc. CR-1 Central Hub of Information CR-5 Profile Generation Service
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 9
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.2.1.4
Type Id Role Purpose Responsibility Related Capability(s)
Employer Profile
Table 10: Artifact: Employer Profile
Description ATF-4 The profile of the employer, i.e. corporate partner of REEO Provides the detailed profile of the employer to help the students gain further information about the company Contains all information of each student like name, email, company, website, etc. CR-1 Central Hub of Information CR-5 Profile Generation Service
2.1.2.1.5
Type Id Role Purpose Responsibility Related Capability(s)
Job Profile
Table 11: Artifact: Job Profile
Description
ATF-5 The job profile The information in the job request form will be transferred to this artifact. It provides the detailed description of the job requirement. Contains all information of each job such as name, description, job type, GPA requirement , preferred skill etc. CR-1 Central Hub of Information CR-6 Job Applications CR-12 Email Notification Service CR-14 Customized Searching Service
2.1.2.1.6
Type Id Role Purpose Responsibility Related Capability(s)
Event Calendar
Table 12: Artifact: Event Calendar
Description
ATF-6 The event calendar Provides the complete information about each event to be held on each day and the description of the event. Contains all information of each student registered for each event, date of the event, venue, etc. CR-1 Central hub of information CR-3 Dynamic Calendar CR-7 Event Registration (RSVP)
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 10
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.2.1.7
Type Id Role Purpose Responsibility Related Capability(s)
Chat Log
Table 13: Artifact: Chat Log
Description
ATF-7 The chat log Each student uses the chat system to interact with other students. Contains networking mechanism and chatting ability between different community college students. CR-1 Central hub of information CR-4 Online Chat Service
2.1.2.1.8
Type Id Role Purpose Responsibility Related Capability(s)
Student Resume
Table 14: Artifact: Student Resume
Description ATF-8 The resume of each student Each student enters his complete profile in the resume. This helps corporate partners in searching for potential candidate Contains all information of each student like name, email, school, GPA, work experience, etc. CR-1 Central hub of information CR-6 Job Applications CR-11 Document Upload Format
2.1.2.1.9
Type Id Role Purpose
Student Progress Report
Table 15: Artifact: Student Progress Report
Responsibility Related Capability(s)
Description ATF-9 The student progress report The progress report contains updated student information to ensure that the most current information exists. This enables statistical analysis. Contains all information about the current status, GPA, description of current course-work etc. CR-1 Central hub of information CR-8 Report Generation Service
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 11
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.2.1.10 Log File
Table 16: Artifact: Log File
Type Id Role Purpose Responsibility Related Capability(s) Description ATF-10 The log file that the admin views The file has all current information about the system and the errors and processes logged. Contains all information so that the admin can record all transactions and log various activities. CR-10 Login Behavior CR-15 Website Behavior
2.1.2.1.11 Job Schedule
Table 17: Artifact: Job Schedule
Type Id Role Purpose Responsibility Related Capability(s) Description ATF- 11 The job schedule gets linked to the event calendar after viewing the job profile The job scheduling helps the event calendar register the job information Contains all information about the student and corporate mapping, date and job profile. CR-3 Dynamic Calendar CR-6 Job Applications CR-7 Event Registration (RSVP)
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 12
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3
2.1.3.1
2.1.3.1.1
Identifier Use Case Name Abstract Purpose Actors Priority Capability Requirements Risks High-Risk Architecturally Significant? Overview User Interface Pre- Conditions Post- Conditions Specializes Includes Extends Extension Points
Behavior
Processes
Job Application
Table 18: Use Case Description: Job Application UC-1 Job Application No Students will search for jobs, apply online and upload resumes through the central communication system. Users, Corporate partners and REEO staff M OC-1 CR-6 No Yes User is capable of applying online for jobs, uploading resumes. WEB INTERFACE Authenticated user N/A N/A N/A N/A N/A
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 13
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Seq# 1 2 3 4 5 6 7 8 Seq# 1 2 3 4 5 6
Table 19: Typical Course of Action: Job Application Actor Actions System Response Click on Search Jobs Online Display the Search page with various fields, each field having multiple selectable objects. User selects data in field for which he wants to search including keywords Lists all the relevant jobs according to the search criteria User selects the job Prompt the user to upload resume User uploads resume Gets confirmation of job application Table 20: Alternate Course of Action: Job Application Actor Actions System Response Click on Apply Job List the jobs that the user had saved according to the login information User selects the job Prompt the user to upload resume User uploads resume Gets confirmation of job application
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 14
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.2
Social Networking
Table 21: Use Case Description: Social Networking Identifier UC-2 Use Case Name Social Networking Abstract No Purpose Users will be able to know students from the same community as well as corporate partners and REEO staff Actors Users, Corporate partners and REEO staff Priority M Capability OC-1 Requirements CR-4 Risks High-Risk No Architecturally Yes Significant? Overview User is capable of interacting with other students from other colleges as well as the corporate partners and the REEO staff with regards to jobs and career development User Interface WEB INTERFACE Pre- Conditions Authenticated user Post- Conditions N/A Specializes N/A Includes N/A Extends N/A Extension Points N/A Seq# 1 2 3 4 Seq# 1 2 3 4 Table 22: Typical Course of Action: Social Networking Actor Actions System Response Click on Network button Lists all the members that the user added User selects the user he wants to communicate and sends an email The message sent text is displayed Table 23: Alternate Course of Action: Social Networking Actor Actions System Response Click on the member Gives option to send message to the selected member User selects option to send an email or message. The message sent text is displayed
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 15
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.3
Identifier Use Case Name Abstract Purpose Actors Priority Capability Requirements Risks High-Risk Architecturally Significant? Overview User Interface Pre- Conditions Post- Conditions Specializes Includes Extends Extension Points Seq# 1 2 3 4
User Login
Table 24: Use Case Description: Login UC-3 User Login No Determine authentication and privilege of the use of system Users, Corporate partners and REEO staff M OC-2 CR-2, CR-10 Hacker may be able to hack into the system via the login page No Yes Authenticate the actor to use the system WEB INTERFACE Volunteers username and password on exist the system database with appropriate authentication status. Volunteer is authorized to use the system N/A N/A N/A N/A
Table 25: Typical Course of Action: Login Actor Actions System Response Send the username and password Click send button Validate the username and password Redirect the actor to user home page Table 26: Alternate Course of Action: Login Actor Actions System Response Send the wrong username or password Validate the username and password Create user authentication session Display An error message: username or password are wrong in a dialog box Click OK button Redirect the user to the login page
Seq# 1 2 3 4 5
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 16
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.4
Identifier Use Case Name Abstract Purpose Actors Priority Capability Requirements Risks High-Risk Architecturally Significant? Overview User Interface Pre- Conditions Post- Conditions Specializes Includes Extends Extension Points Seq# 1 2 3 4
User Logout
Table 27: Use Case Description: Logout UC-4 User Logout No To log out of the system Users, Corporate partners and REEO staff M OC-2 CR-2, CR-10 N/A No Yes Log off the actor from the system WEB INTERFACE The user has logged in to the system. The users login session still exists The user login session is terminated. The user is detached from the system N/A N/A N/A N/A
Table 28: Typical Course of Action: Logout Actor Actions System Response Click the log out hypertext Display a message: you have already logged out of the system in a dialog box Click OK button Redirect the actor to REEO home page Table 29: Alternate Course of Action: Logout Actor Actions System Response Try to directly enter logout page An error message: You have not Logged in yet.
Seq# 1 2
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 17
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.5
Identifier Use Case Name Abstract Purpose Actors Priority Capability Requirements Risks High-Risk Architecturally Significant? Overview User Interface Pre- Conditions Post- Conditions Specializes Includes Extends Extension Points Seq# 1 2 3 4
Create Profile
Table 30: Use Case Description: Create Profile UC-5 Create Profile No Create an online profile of each student Users (student) M OC-3 CR-1, CR-5 N/A No Yes The user will create an online profile and will be able to upload resume. WEB INTERFACE The user has logged in to the system. The users login session still exists The user login session is terminated. The user is detached from the system N/A N/A N/A N/A
Table 31: Typical Course of Action: Create Profile Actor Actions System Response Click the Create Profile hypertext Displays a form asking for username, password, first name, last name. User fills in all the information and clicks the submit button Displays a Dialog box Online profile created Table 32: Alternate Course of Action I: Create Profile Actor Actions System Response Try to directly create profile An error message: You have not Logged in yet.
Seq# 1 2
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 18
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
Seq# 1 2
Table 33: Alternate Course of Action II: Create Profile Actor Actions System Response Choose an already existent username An error message: The username you chose is already used by a user. Please select a new user name.
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 19
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.6
Identifier Use Case Name Abstract Purpose Actors Priority Capability Requirements Risks High-Risk Architecturally Significant? Overview User Interface Pre- Conditions Post- Conditions Specializes Includes Extends Extension Points Seq# 1 2 3 4
Update Profile
Table 34: Use Case Description: Update Profile UC-6 Update Profile No Update the profile of an already existing users Users (student) M OC-3 CR-1, CR-5 The updated profile is not reflected in the database. No Yes The user will be able to change his online profile after he logs-in. WEB INTERFACE The user has logged in to the system. The users login session still exists The user login session is terminated. The user is detached from the system N/A N/A N/A N/A
Table 35: Typical Course of Action: Update Profile Actor Actions System Response Click the Update Profile hypertext Displays a form showing the username, password, first name, last name that the user had already entered. User updates all the information and clicks the submit button Displays a Dialog box Online profile updated Table 36: Alternate Course of Action: Update Profile Actor Actions System Response Try to directly update the profile An error message: You have not Logged in yet.
Seq# 1 2
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 20
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.7
Search for Jobs
Table 37: Use Case Description: User searching for Jobs Identifier UC-7 Use Case Name Search for Jobs Abstract No Purpose Search for jobs according to the specified keyword Actors Users (student) Priority M Capability OC-4 Requirements CR-14 Risks High-Risk No Architecturally Yes Significant? Overview The user will be able to search based on his major, location etc User Interface WEB INTERFACE Pre- Conditions N/A Post- Conditions N/A Specializes N/A Includes N/A Extends N/A Extension Points N/A Seq# 1 2 3 4 5 6 7 8 Table 38: Typical Course of Action: User searching for Jobs Actor Actions System Response Click the Search for Jobs hypertext Gives a detailed form asking for keywords, major and location User inputs the information in the form and clicks the submit button Displays a list of jobs according to the searched keywords The user will click on a specific job The system displays the job description and company profile information The user then can choose to read the description and apply for the job. Gives message Applied to the job
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 21
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.8 Corporate partners searching for employees
Table 39: Use Case Description: Corporate partners searching for employees Identifier UC-8 Use Case Name Corporate partners searching for employees Abstract No Purpose Corporate partners will be able to search for prospective employees based on the search criteria Actors Users (student) Priority M Capability OC-4 Requirements CR-6, CR-14 Risks High-Risk No Architecturally Yes Significant? Overview The client can search for students based on their resumes. User Interface WEB INTERFACE Pre- Conditions N/A Post- Conditions N/A Specializes N/A Includes N/A Extends N/A Extension Points N/A Table 40: Typical Course of Action: Corporate partners searching for employees Seq# Actor Actions System Response 1 Click the Search for employees hypertext 2 Gives a detailed list of students according to the search field of the corporate. 3 Selects the students and gets to see the resumes of all the students.
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 22
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.9
Event Scheduling:
Table 41: Use Case Description: Event Scheduling Identifier UC- 9 Use-Case Name Event Scheduling Abstract No Purpose Allow REEO staff and corporate partners to post and schedule events on calendar. Actors REEO staff, Corporate Partners Priority M (Must have) Capability OC-5 Requirements CR-3, CR-7 Risks Unauthorized members may post bogus events misleading students. High-Risk? N Architecturally Y Significant? Overview Post events User Interface GUI Pre-conditions REEO staff, corporate partners are logged on the system. Post-conditions Authorized users can view details about the event and register for the event. Specializes N/A Includes N/A Extends N/A Extension N/A Points Seq# 1 2 3 4 Table 42: Typical Course of Action: Event Scheduling Actor Actions System Response Open the calendar Corporate partners and REEO staff post events Event is updated on the calendar Redirects user to calendar home page
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 23
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.10 Event Registration:
Table 43: Use Case Description: Event Registration Identifier UC- 10 Use-Case Name Event Registration Abstract No Purpose Students can register for the event by filling registration form. Actors Students Priority M (Must have) Capability OC-5 Requirements CR-3, CR-7 Risks Unauthorized members may post bogus events misleading students. High-Risk? N Architecturally Y Significant? Overview Register for events User Interface GUI Pre-conditions Students are logged into the system Post-conditions Authorized users can view details about the event and register for the event. Specializes N/A Includes N/A Extends N/A Extension N/A Points Seq# 1 2 3 4 Table 44: Typical Course of Action: Event Registration Actor Actions System Response Students click on event Details of the event is displayed Student register for event Student is registered for event
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 24
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.11 Job Posting:
Identifier Use-Case Name Abstract Purpose Actors Priority Capability Requirements Risks High-Risk? Architecturally Significant? Overview User Interface Pre-conditions Post-conditions Specializes Includes Extends Extension Points Seq# 1 2 3 4 Table 45: Use Case Description: Job Posting UC- 11 Job Posting No Corporate partners post job openings for students Students, Corporate Partners M (Must have) OC-6 CR-6, CR-11 Job posted for wrong opening N Y Post job openings GUI Corporate partners logged on job portal Job openings are posted on the website available for students to apply. N/A N/A N/A N/A
Table 46: Typical Course of Action: Job Posting Actor Actions System Response Corporate partners login on job portal by validating username and password Username and password is validated. Corporate partners post job openings Job posting is displayed on website
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 25
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.12 Email Notification and Reminders
Table 47: Use Case Description: Email notification and reminders Identifier UC- 12 Use-Case Name Email notification and reminders Abstract No Purpose Event reminder emails to students and email notifications to REEO staff. Actors Students, Corporate Partners, REEO staff Priority M (Must have) Capability OC-7 Requirements CR-12 Risks Notification is sent to the wrong student High-Risk? N Architecturally Y Significant? Overview Email notification and event reminders to students User Interface GUI Pre-conditions Corporate partners contacts student for job opening. Student registers for event. Post-conditions Email notification sent to REEO staff incase corporate partners contacts students. Event reminder sent to students before the event. Specializes N/A Includes N/A Extends N/A Extension N/A Points Seq# 1 2 Table 48: Typical Course of Action: Email notification Actor Actions System Response Corporate partners contact student for job opening Notification sent to REEO staff.
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 26
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
2.1.3.1.13 Report Generation
Table 49: Use Case Description: Report Generation Identifier UC- 13 Use-Case Name Report Generation Abstract No Purpose Reports generated about students performance Actors REEO staff Priority M (Must have) Capability OC-8 Requirements CR-8 Risks Report generated with wrong information about students High-Risk? N Architecturally Y Significant? Overview Report generation in various formats. User Interface GUI Pre-conditions Students performance information available with REEO staff Post-conditions Reports generated using student performance. Specializes N/A Includes N/A Extends N/A Extension N/A Points Seq# 1 2 Table 50: Typical Course of action: Report Generation Actor Actions System Response REEO staff generates report Student report is generated
2.1.3.2
Modes of Operation
The system has a single mode of operation which is the execution mode with standard configuration.
2.2 Rationale for System Analysis
The system analysis was done based on the requirements of the client. These high level requirements of the client are translated into the use-case diagrams which represent the capabilities of the system that is going to be developed.
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 27
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
3 Platform/TechnologyIndependent Model
This section describes in detail a software-architecture for the system, which is independent of the implementation technology used.
3.1 Summary of TIM
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 28
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
3.1.1
3.1.1.1
Structure
Deployment Model
Figure 3: Deployment Model
3.1.1.1.1
Hardware Component
3.1.1.1.1.1 HC-1: CCP Workstation
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 29
Version Date: 11/12/07
System and Software Architecture Description (SSAD) 3.1.1.1.1.1.1 Purpose
Version 1.3
This is the workstation that is used by the community college partners. Workstations are used to access the services provided by the system. 3.1.1.1.1.1.2 HCC-2 Classifier
3.1.1.1.1.2 HC-2: CP Workstation
3.1.1.1.1.2.1
Purpose
This is the workstation that is used by the community corporate partners. Workstations are used to access the services provided by the system. 3.1.1.1.1.2.2 HCC-2 Classifier
3.1.1.1.1.3 HC-3: Volunteer Workstation
3.1.1.1.1.3.1
Purpose
This is the workstation that is used by the volunteers. Workstations are used to access the services that are provided by the system. The volunteers will organize the events manage student profiles. 3.1.1.1.1.3.2 HCC-2 Classifier
3.1.1.1.1.4 HC-4: Web Server
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 30
Version Date: 11/12/07
System and Software Architecture Description (SSAD) 3.1.1.1.1.4.1 Purpose
Version 1.3
The web server is the host for the software system to be deployed. In addition to the REEO Database system, it also hold key software components required for the system to perform lie apache, php Engine and MySQL 3.1.1.1.1.4.2 HCC-1 Classifier
3.1.1.1.1.5 HC-5: Student Workstation
3.1.1.1.1.5.1
Purpose
This is the workstation that is used by the students.. Workstations are used to access the services that are provided by the system. The students will upload the resumes, use the social networking and chat features through their workstations 3.1.1.1.1.5.2 HCC-2 Classifier
3.1.1.1.1.6 HC-6: System Administrator Workstation
3.1.1.1.1.6.1
Purpose
These workstations are used by System Administrators. They have additional server management components. 3.1.1.1.1.6.2 HCC-3 Classifier
3.1.1.1.2
Software Component
This section has not been elaborated because each software component classifier has only one software component. For details of the software classifiers, please refer Section 3.1.1.2
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 31
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
3.1.1.2
Software Classifier Model
Figure 4: Software Classifier Model
3.1.1.2.1
SCC 1: Content Management System
3.1.1.2.1.1 Purpose
The Content Management System is the key component of the system itself. Its chief purpose is to be able to modify the web content easily. It provides most of the basic features. Its sub-components/plug-ins provide all the extra functionality of the system.
3.1.1.2.1.2 Interface
To be done. dd364d940381a7283ac9cae0c57c84a1c2623628.doc 32 Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
3.1.1.2.1.3 Parameters
To be done.
3.1.1.2.1.4 Behavior
3.1.1.2.1.4.1
Processes
3.1.1.2.1.4.1.1 Job Application
Table 51: Process Use Case Description: Job Application Identifier UC-1 Use Case Name Job Application Abstract No Purpose Students will apply for jobs. Actors Students Capability OC-1 Risks N/A Architecturally Yes Significant?
3.1.1.2.1.4.1.2 User Login
Identifier Use Case Name Abstract Purpose Actors Capability Risks Architecturally Significant?
Table 52: Process Use Case Description: Login UC-3 User Login No Determine authentication and privilege of the use of system Users, Corporate partners and REEO staff OC-2 Hacker may be able to hack into the system via the login page Yes
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 33
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
3.1.1.2.1.4.1.3 User Logout
Identifier Use Case Name Abstract Purpose Actors Capability Risks Architecturally Significant?
Table 53: Process Use Case Description: Logout UC-4 User Logout No To log out of the system Users, Corporate partners and REEO staff OC-2 N/A Yes
3.1.1.2.1.4.1.4 Create Profile
Table 54: Process Use Case Description: Create Profile Identifier UC-5 Use Case Name Create Profile Abstract No Purpose Create an online profile of each student Actors Users (student) Capability OC-3 Risks N/A Architecturally Yes Significant?
3.1.1.2.1.4.1.5 Search for Jobs
Table 55: Process Use Case Description: User searching for Jobs Identifier UC-7 Use Case Name Search for Jobs Abstract No Purpose Search for jobs according to the specified keyword Actors Users (student) Capability OC-4 Risks Architecturally Yes Significant?
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 34
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
3.1.1.2.1.4.1.6 Corporate partners searching for employees
Version 1.3
Table 56: Process Use Case Description: Corporate partners searching for employees Identifier UC-8 Use Case Name Corporate partners searching for employees Abstract No Purpose Corporate partners will be able to search for prospective employees based on the search criteria Actors Users (student) Capability OC-4 Risks Architecturally Yes Significant? 3.1.1.2.1.4.2 Modes of Operation
The software component classifier has a single mode of operation.
3.1.1.2.1.5 Constraints
No constraints have been identified for this software component classifier
3.1.1.2.1.6 Internal Architecture
To be done.
3.1.1.2.2
SCC 2: Events Calendar
3.1.1.2.2.1 Purpose
The Events Calendar is used to record occurrences of events. Functionalities involve viewing, scheduling and registering for events.
3.1.1.2.2.2 Interface
To be done.
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 35
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
3.1.1.2.2.3 Parameters
To be done.
3.1.1.2.2.4 Behavior
3.1.1.2.2.4.1
Processes
3.1.1.2.2.4.1.1 Event Scheduling:
Table 57: Process Use Case Description: Event Scheduling Identifier UC- 9 Use-Case Name Event Scheduling Abstract No Purpose Allow REEO staff and corporate partners to post and schedule events on calendar. Actors REEO staff, Corporate Partners Capability OC-5 Risks Unauthorized members may post bogus events misleading students. Architecturally Y Significant?
3.1.1.2.2.4.1.2 Event Registration:
Table 58: Process Use Case Description: Event Registration Identifier UC- 10 Use-Case Name Event Registration Abstract No Purpose Students can register for the event by filling registration form. Actors Students Capability OC-5 Risks Unauthorized members may register for events Architecturally Y Significant? 3.1.1.2.2.4.2 Modes of Operation
The software component classifier has a single mode of operation.
dd364d940381a7283ac9cae0c57c84a1c2623628.doc 36
Version Date: 11/12/07
System and Software Architecture Description (SSAD)
Version 1.3
3.1.1.2.2.5 Constraints
No ...