Download System and Software Architecture Description | CSCI 577A and more Study Guides, Projects, Research Software Engineering in PDF only on Docsity!
SSAD_DCP_F08a_T16_V5.1 I 11/24/
System and Software Architecture
Description
Theater Script Online Database
Team #
Jae Young Bang Project Manager
Gary Lam Requirement Engineer
Young Chan Noh System Architect
Ka Ho Au Prototyper
Shi Heng Guan Planning and Control Engineer
Sandeep Mikkilineni Operational Concept Engineer
Nory Kealii Nishimura IIV&V / QFP
John Christopher Reynolds IIV&V/ SRE
Julie Sanchez Client
SSAD_DCP_F08a_T16_V5.1 II 11/24/
Version History
Date Author Version Changes made Rationale
10/ 13 / 08 Young Cahn Noh
1.0 (^) Initial system analysis model Initial draft of SSAD
10/21/08 Young Chan Noh
1.1 (^) Initial technology independent diagram Update system analysis model and Add technology independent diagram 10/27/08 Young Chan Noh
1.3 (^) Update system analysis model and technology diagram
Update system analysis model, technology independent diagram and sequence diagram 10/28/08 Young Chan Noh
1.4 (^) Modified Use-Case (Table1,2,3,4) and Section 2 and 3
Addressed Agile Artifact Review
11/22/08 Young Chan Noh
2.0 (^) Modified System-Domain Analysis and Initial draft Technology-Specific Design Model
Addressed Agile Artifact Review and Initial draft Technology-Specific Design Model 11/23/08 Young Chan Noh
5.0 (^) Updated Class diagrams Updated Technology-Specific class diagrams 11/29/08 Young Chan Noh
5.1 (^) Updated Deployment diagram, Software Component diagram, and Interface diagram
Peer Review
1 Introduction
1.1 Purpose of the SSAD
The purpose of the SSAD is to document the results of the object-oriented analysis and design of the system being developed. The SSAD is to provide the analysis of the operational concept, design the architecture including software and hardware platform, and design the implementation of the Theatre Script Online Database. This system being developed should be faithful to the architecture specified in the SSAD. It serves as system reference to the builder by providing the in-depth architectural design and implementation of the proposed system. Moreover, the SSAD document is used by the maintainer and clients to help understand the structure of the system once the proposed system is delivered.
The Draft Development Commitment package of the SSAD document consists of the description of system analysis, system process model including behavior, modes of operation, and technology specific model of the Theatre Script Online Database and the draft system platform.
1.2 Status of the SSAD
The current version of the SSAD is at the Foundation phase. At this phase, the structure diagram, domain/system information, artifacts class model, system process model and technology specific design diagram are described.
2 System Analysis
2.1 System Analysis Overview
The primary purpose of the Theatre Script Online Database is to manage the theatre paper script efficiently. This system will provide a way to keep various scripts for administrator to continuously edit, change, and upload scripts. A technical theatre website includes announcing of new changes and updates to the scripts and converting image file scripts into text file with OCR software. The web-based system, theatre staff, actors, and visitors can view and print online scripts. They also share script changes among the distributed copies.
2.1.1 System Context
Figure 1 shows the operational context of the Theatre Script Online Database.
Figure 1: System Context
Figure 2: Artifacts and Information Model
Table 2 contains a description of each artifact shown above.
Table 2: Artifacts and Information Summary
Artifact Purpose ATF-1: Administrator Profile Form / Profile
Contains the information of the administrator. This includes names, contact information, and ID, password. ATF- 2 : Script image file Scripts are scanned and typed by the administrator. This artifact will be generated according to the theatre’s schedule. ATF- 3 : Script Detail information
Contains all information included on the script. This includes script title, organization, event date, genre, etc. This information is used as a mean of search keywords and to sort scripts. ATF- 4 : Actor Information Contains the information of the actor involved with the script. This includes names, roles. ATF- 5 : Comment Message This comment message is generated automatically by the Notify changes. Whenever the script changes, this notification message is sent to users. ATF- 6 : Script View Form / Printing
This artifact will be printed by the View script application. The selected script contents will be printed ATF- 7 : User Profile Form / Profile
Contains the information of the user who is activated by the administrator. This includes name, email, password, etc.
2.1.3 Behavior
The following Use-Case Diagram shows the processes that were identified when capabilities described in the OCD were analyzed.
Figure 3: Process Diagram
2.1.3.1 Online Script
2.1.3.1.1 Search Script List (main page)
Table 3: Process Description – Search Script List
Identifier UC- 1 Search Script List Purpose After the script is uploaded, All users can view script List through the Search Script List application page. Requirements CR- 14 : Visitor Access, CR-19: Search in Script Development Risks
None
Pre-conditions System database is properly initialized Users have loaded Script List application page Post-conditions All script list^ including title, organization, and script file^ are displayed on the screen
Table 4: Typical Course of Action – Search Script List Application
Seq# Actor Actions System Response 1 Select search category or no select.
of the system, what the person is authorized to do when using the system. Administrator will determine privilege level Requirements CR-2:User Account Notification,CR-^3 : Account Creation Development Risks
None
Pre-conditions System database is properly initialized. Post-conditions If user is authorized s/he is given access to system operations appropriate to his/her role; otherwise, s/he is denied access to the system.
Table 8: Typical Course of Action – Account Creation_Request
Seq# Actor Action System Response 1 Click on Account Creation_Request Menu 2 Fill in user profile fields. Click on Account Creation_Request Button 3 Sends user profile to the User Account Activation module of the Theatre Script online system Save the user’s profile to the database and then Sends e-mail(Notification Message) to the administrator
2.1.3.2.2 Script Access_Request
Table 9: Process Description – Script Access_Request
Identifier UC-^4 :^ Script Access_Request Purpose The system shall allow a User to request from an Administrator permission to access a Script. Requirements CR-8:Script Access-User Request,CR- 9 :Script Access-Request Notification Development Risks
None
Pre-conditions System database is properly initialized. Post-conditions The request, consisting of the Username and the Script requested, will be stored in the database. If the script is authorized s/he is given access to the script appropriate to his/her role; otherwise, s/he is denied access to the script.
Table 10: Typical Course of Action – Script Access_Request
Seq# Actor Action System Response 1 Click on^ Script Access_Request Menu
2 Select Script List user wants to access. Click on Request Button 3 Sends^ the script list^ to the^ Account Creation_ Request module of the Theatre Script online system Save the user’s script list to the database and then Sends e-mail (Notification Message) to the administrator
2.1.3.2.3 Login
Table 11: Process Description - Login
Identifier UC- 5 : Login Purpose Determine if a person logging into the system can be authenticated, and, if so, what the person’s privileges are as a user of the system, what the person is authorized to do when using the system Requirements CR- 12 Authentication, CR- 13 User Lockout Development Risks
None
Pre-conditions System database is properly initialized. Post-conditions If user is authorized s/he is given access to system operations appropriate to his/her role; otherwise, s/he is denied access to the system.
Table 12: Typical Course of Action – Login: Successful
Seq# Actor Action System Response 1 [user] Enters a user name and password 2 [user] Clicks Login button 3 Sends username and password to the authentication module of the Theatre Script online system 4 [Theatre Script Online system] Sends authentication verification and user session data 5 [valid]^ User^ –^ The user has privileges to view the script contents
Administrator – The user can access to Upload Script page, Edit Script page, Notify changes page, or Administrator management page, as appropriate
Table 13: Alternate Course of Action – Login: Failure
Seq# Actor Actions System Response 1 Click on User Profile Manage Menu 2 Update user profile fields. Click on UPDATE Button 3 Sends user profile field to the User Profile Manage module of the Theatre Script online system Update the user’s profile field to the database 4 Display a message: “Your Profile is updated!” in a dialog box
Table 18: Exception Course of Action – User Profile Manage
Seq# Actor Actions System Response 1 Display Database error message *Database error : A message Database Error Code + “ This data cannot update table” 2 Check error message and each field format. Retry the typical course of action
2.1.3.3 Script Management
2.1.3.3.1 Upload Script _Input Script Information
Table 19: Process Description – Upload Script _Input Script Information
Identifier UC-^8 Upload^ Script_^ Input Script^ Information Purpose Allows the administrator to upload script and input the information. Requirements CR-6: Upload Script Development Risks
Before uploading the image file to database, this system will call OCR component in order to convert file. Converting image file and integrating OCR component will require complex coding and testing Pre-conditions User is only administrator Database is properly initialized Script file is on the local computer (text file or image file) Post-conditions Script file is converted to text file New script file and information are recorded to the database
Table 20: Typical Course of Action – Upload Script_Input Script Information
Seq# Actor Actions System Response 1 Click on “Upload & Input Script” link 2 Display Upload Script_Input Script Information screen 3 Enters Organization, Title, Genre, Date, Actors Info., Staffs Info. 3 Click on “Browse” button 4 Display the Choose file Pop-up box 5 Select the script file 6 Display the file directory 7 Check the converted script contents, Click “Submit” button 8 Upload, insert this file and script information into the database 9 Display an OK message Screen clear
Table 21: Exception Course of Action - Upload Script_Input Script Information
Seq# Actor Actions System Response 1 Display error message
- OCR error : A message “ Retry OCR converting” *Database error : A message Database Error Code + “ This data cannot insert into table” 2 Check error message and database error code. Retry the typical course of action
2.1.3.3.2 Edit Script_ Update Script Information
Table 22: Process Description – Edit Script_Update Script Information
Identifier UC- 9 Edit Script_Update Script Information Purpose To Edit script and Update script information Requirements CR-5:^ Script^ Editing Interface, CR-17: System displays Script as PDF or DOC Development None
Purpose The administrator has the ability to notify comment messages that includes announcement of script changes. Whenever the administrator changes the script, the system automatically send the comment message to users Requirements CR- 1 Script Modification Notification Development Risks
None
Pre-conditions The administrator must change script contents or script information. Post-conditions Send comment messages to users via e-mail Comment messages are recorded in the database
Table 26: Typical Course of Action - Notify Script change
Seq# Actor Actions System Response 1 Click the “Edit Script_Update Script Information” link 2 Edit Organization, Title, Genre, Date, Actors Info., Staffs Info or Edit script contents 3 Input comment message in the comment field 4 Click on^ “Update”^ button 5 Save the script file to the local computer and then upload, update this file and information into the database 6 If the comment message is in the comment field, automatically send comment message to users 5 Display an Send Ok message
Table 27: Exception Course of Action - Notify Script change
Seq# Actor Actions System Response 1 Display returned^ e-mail(bounced e- mail) address 2 Update the user information^ and then Refer to typical course of action 3 - 4
2.1.3.4 Administrator Management
2.1.3.4.1 Administrator Profile Manage
Table 28: Process Description – Administrator Profile Manage
Identifier UC- 11 Administrator Profile Manage Purpose To update administrator profile Requirements CR-15: User Password Change, CR-16: User Profile Edit
Development Risks
None
Pre-conditions The user is a^ Administrator The user’s login session still exists Post-conditions Administrator profile fields in the database are updated
Table 29: Typical Course of Action – Administrator Profile Manage
Seq# Actor Actions System Response 1 Click on^ Administrator^ Profile Manage Menu 2 Update Administrator profile fields (Administrator’s password, user id, name, etc.) Click on UPDATE Button 3 Sends^ Administrator^ profile^ field^ to the Administrator Profile Manage module of the Theatre Script online system Update the administrator’s profile field to the database 4 Display an OK message
Table 30: Exception Course of Action – Administrator Profile Manage
Seq# Actor Actions System Response 1 Display Database error message *Database error : A message Database Error Code + “ This data cannot update table” 2 Check error message^ and each field format. Retry the typical course of action
2.1.3.4.2 User Account_ Script Access Activation
Table 31: Process Description – User Account_Script Access Activation
Identifier UC- 12 User Account Activation Purpose Administrator can approve user’s account, script list^ request to become a activated user Requirements CR-7:User Account Activation, CR-18: User Account Activation Notification,CR- 10 :Script Access-Update Request,CR-11:Script Access-User Notification Development Risks
None
Pre-conditions A visitor had to submit a profile including script list into the system Post-conditions Admission or denial will generate an email to the User to update the User on status.
