Download System and Software Architecture Description | AME 577 and more Study Guides, Projects, Research Aerospace Engineering in PDF only on Docsity!
SSAD_FCP_F08a_T16_V1.44 I 10/28/
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_FCP_F08a_T16_V1.44 II 10/28/
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
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 a bridge linking between the inception and the construction phases 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 initial draft of the SSAD document consists of the description of system analysis, system process model including behavior, modes of operation 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 Valuation phase. At this phase, only the structure diagram, domain/system information, artifacts class model and system process model 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 an easy 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. Through 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 performance schedule or keeping script. ATF-3: OCR software OCR software will automatically convert image file into text PDF file and then insert this file into the DBMS. ATF- 4 : 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 key word and sort scripts. ATF-5: Actor/Staff (User) Information
Contains the information of the actor/staff involved with the script. This includes names, roles, email. ATF- 6 : Notify changes The manager can notify to share changes among the distributed copies and this artifact is automatically sent to actors and staffs involved with this script. This notification includes comment message, and the administrator can email this message. ATF-7: Comment Message This comment message is generated automatically by the Notify changes. Whenever the script change, this notification message is sent to users.
ATF-8: Script View Form / Printing
This artifact will be printed by the View script application. The selected script contents will be printed ATF-9: User Profile Form / Profile
Contains the information of the user who is activated by the administrator. This includes name, email, password, etc. AFT-10: Account Activation
The account activation is generated according to users request, users who want to view the script contents request account activation
2.1.3 Behavior
The following Use-Case Diagram shows the processes that were identified when analyzed the 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
5 If the user want to print the script, Click On “Print” button 5 Send the script contents to the printer 6 Display an “Printing OK”
2.1.3.2 Authentication
2.1.3.2.1 Account Creation_Request
Table 7: Process Description – Account Creation_Request
Identifier UC- 3 : Account Createion_Request Purpose Determine if a person logging in to the system can be authenticated, and, if so, what the person’s privileges are as a administrator of the system, what the person is authorized to do when using the system. Administrator will determine privilege level Requirements CR- 3 : Account Creation, CR-8: Script Access User Request, CR- 9:Request Notification Development Risks
None
Pre-conditions System database is properly initialized. User is on a computer connected to the web server through internet protocol. A visitor submits a profile into the system with permissions to become a user. 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
2.1.3.2.2 Login
Table 9: Process Description - Login
Identifier UC- 4 : Login Purpose Determine if a person logging in to the system can be
authenticated, and, if so, what the person’s privileges are as a administrator 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. User is on a computer connected to the web server through internet protocol. 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 10: 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 11: Alternate Course of Action – Login: Failure
Seq# Actor Action System Response 1 – 4 Refer to typical course of action 5 After 5 consecutive unsuccessful login, Displays An error message: “You have to contact the administrator” in a dialog box. User’s account locked out 6 Redirects the user to the Search Script List main page
2.1.3.2.3 Logout
Table 12: Process Description – Logout
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 17: Process Description – Upload Script _Input Script Information
Identifier UC- 7 Upload Script_ Input Script Information Purpose Allows the administrator to upload script and input the information. Requirements CR-6: Upload Script,^ CR-^7 :^ System must be able to convert an uploaded Script to text 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 is recorded to the database
Table 18: 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 8 If the file is scan image, Click on “Preview/OCR” button 9 Call OCR component and convert
image file into text file. Display the converted script contents. 10 Check the converted script contents, Click “Submit” button 11 Save the converted text file to the local computer and then upload, insert this file and script information into the database 12 Display an OK message Screen clear
Table 19: 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 20: Process Description – Edit Script_Update Script Information
Identifier UC- 8 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 Risks
None
Pre-conditions User is only administrator Database is properly initialized Post-conditions Update information such as script contents, title, organization, actor, staff, event date and genre in the database
Table 21: Typical Course of Action – Edit Script_Update Script Information
Seq# Actor Actions System Response 1 Click on “Edit Script_Update Script Information” link 2 Display^ Edit Script_Update Script Information screen 3 Fill in Search word such as Title
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 25: 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 26: Process Description – Administrator Profile Manage
Identifier UC- 10 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 27: 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 28: 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 Activation
Table 29: Process Description – User Account Activation
Identifier UC- 11 User Account Activation Purpose Administrator can approve user’s account request to become a activated user Requirements CR-2: User Account Activation, CR-18: User Account Activation Notification, CR-10: User Request, CR-11: User Notification Development Risks
None
Pre-conditions A visitor had to submit a profile into the system Post-conditions Administrator will be able to view the visitor’s submission along with all the entered details and decde whether or not to grant access. Admission or denial will generate an email to the User to update the User on status.
Table 30: Typical Course of Action – User Account Activation
Seq# Actor Actions System Response 1 Click on User Account Activation Menu 2 Display visitor’s submission list on the screen 3 Check Admission field or Denial field to give account activation and then select script user’s list of permissible script 4 Click on “Submit” button 5 Update the flag(status) field to user
