Requirement_Specs

Table of Contents I INTRODUCTION 3 Scope and Purpose 3 Overall System Description 3 Software Project Constraints Structure of Document 3 II SYSTEM ARCHITECTURE 5 III INFORMATION DESCRIPTION 6 Entity Relationship Diagram 6 Data Flow Diagram 7 IV FUNCTION DESCRIPTION 8 Functional Partitioning 8 Functional Description 9 V NAVIGATION FLOW AND BEHAVIOR DESCRIPTION 11 Navigation Flow 11 VI VALIDATION AND CRITERIA 19 Performance Bounds 19 Classes of Tests 19 VII BIBLIOGRAPHY 21 VIII APPENDIX 22 Major Function Summary 22 I INTRODUCTION Scope and Purpose In this document, requirements that are necessary for the successful development of the Online Veterinary Hospital Information System are being discussed. The said requirements are suggested by the client and have been accepted by the project leader. This documentation will serve as a foundation for the system design stage. Overall System Description This Veterinary Hospital Information System is available online. Clients need username and password to access the system. Once logged-in, clients can schedule appointments, inquire services of the hospital, check their account status and do certain payments. Staff will have all the account options and will perform user account modification and database report generation. The administrator will have the complete access to all levels of user-functions and will be able to log-on to the server. As account manager, the administrator can update, create, or delete client, staff, or administrator accounts. The system will support an interface suited to each user type. Software Project Constraints • Administrator interface should run the system in Windows XP or a current operating system. • Customer interface must support Mozilla Firefox and Internet Explorer. • The database and application server must run on Windows 2001. Structure of Document System Architecture • This section describes the overall architecture and structure flow of the system. Information Description • This section contains the Entity Relationship Diagram and Data Flow Diagram that describes the relationship between the objects in the system. Function Description • This section contains the purpose, description and the diagram for functional partitioning. Behavior Description • This section contains diagrams for the client, staff and administrator. Each diagram is followed by tables explaining the related Actions and Events that may occur in the system. Validation and Criteria • Performance Bounds and the classes of tests that will be performed are included in this section. II SYSTEM ARCHITECTURE Figure 1 : Context Diagram III INFORMATION DESCRIPTION Entity Relationship Diagram Figure 2 : Entity Relationship Diagram – Complete System Based on the diagram above, the data object Appointment is the central data object. All other objects are connected in the central data object. Data Flow Diagram Figure 3 : Data Flow Diagram IV FUNCTION DESCRIPTION Functional Partitioning Veterinary Hospital Information System Figure 4 : Tree Diagram with Horizontal and Vertical Partitioning Functional Description Log-in Function(Shared Function) Security and control of the user’s level of access are covered in this function. This function requires a username and password. The access control function manages the user type. The system will validate the username and the password before the user can completely access the system. If the username and password are invalid, an error message will appear that instructs the user to try again the log-in process. With a correct log-in, the user will be taken to the appropriate menu. Clients can log-in using any internet browser. Staff can log-in through the hospital’s LAN. Administrators can log-in through the LAN connection or mainly on the actual server. Schedule Appointment Function (Client Function) The schedule appointment function will create, update and delete appointments scheduled by the clients. Users can create an appointment by filling up a form with the desired schedule for appointment. A user can reschedule and cancel an appointment by means of updating and deleting. Account Status Check Function (Client Function) The account status check will allow clients to check their account status. Appointment fees and purchased items with their corresponding amount are being displayed when this function is being selected. Payments can be done online through credit cards. Service Inquiry Function (Client Function) This function will allow clients to inquire services of the veterinary hospital. A search menu is displayed when this function is selected. User Account Set-up Function (Staff and Administrator Function) Staff and administrator have the access to this function. There are three sub functions under this function: account creation, account update and account deletion. The menu will display these three options and the staff or administrator will make a selection. When creating an account, fields for the username, password, id, name, address, user type and phone number are being filled up. To update a certain account, the staff will click the update button. When deleting an account, the staff will click the delete button and the system will require verification that the account should really be deleted before it will be permanently removed from the system. Report Generation Function (Staff and Administrator Function) The report function contains a complete list of appointments, user accounts and the account status of the clients. Reports may also be produced through the search fields. Access Control Function (Administrator Function) The level of access for each type of user is controlled by the administrator. Throughout the log in process, the user type will distinguish the level of access and generate the appropriate menu display. The user account validation will also be managed through this function. If the username and the password are invalid, an error message will be displayed and the user will be returned to the log-in display. Account Management Function (Administrator Function) Administrator manages all the user accounts. Even though, the staff may create a client account, only the administrator can create staff and other administrator accounts. Three sub functions are included in this function: account creation, account update and account deletion. The menu will display these three options and the administrator will make a selection. When creating an account, fields for the staff’s username, password, id, name, address, user type and position are being filled up. To update a certain account, the administrator will click the update button. When deleting an account, the administrator will click the delete button and the system will require verification that the account should really be deleted before it will be permanently removed from the system. V NAVIGATION FLOW AND BEHAVIOR DESCRIPTION Navigation Flow Client Interface Events and Actions |Current State |Event |Input |Action |Next State | |Display Log-in |Log-in |Username and Password |Validate Log-in |If log-in fails, loop to | |Menu | | | |current state. | | | | | |Else display Main Menu | |Display Main |Menu |Menu Selection |Output Selection |Selected State | |Menu | | | | | |Display Appointment Menu |Reserve |Menu Selection |If reserve request, update |Reserve Confirmation, or | | | | |database |return to Display Main Menu | |Display Account Info Menu |Menu |Menu Selection |Output Selection |Selected Page | |Display Appointment Fees |Get Reserved List |None |Query database |Return to Display Account Info| | | | | |Menu upon return request | |Display Purchased Item |Get Purchased List |None |Query database |Return to Display Account Info| | | | | |Menu upon return request | |Display Payment Menu |Menu |Menu Selection |Output selection to banking |Banking System | | | | |system | | |Banking System |Payment Validation |User’s payment parameters |Validate user’s payment |If attained, Update Balance. | | | | |parameters |Else, return to Display | | | | | |Payment Menu | |Update Balance |Update Balance |Confirmation code from |Update account database to |Display Account Info Menu | | | |banking system |reflect user’s payment | | Staff Diagram Events and Actions |Current State |Event |Input |Action |Next State | |Display Log-in Menu |Log-in |Username and Password |Validate Log-in |If log-in fails, loop to | | | | | |current state. | | | | | |Else Display Main Menu | |Display Main Menu |Menu |Menu Selection |Output Selection |Selected State | |Display Account Options Menu |Menu |Menu Selection |Output Selection |Selected State | |Display Create Account Menu |Create Account |Account Parameters |Query database |If request valid, Display | | | | | |Account Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Update Account Menu |Update Account |Account Parameters |Query database |If request valid, Display | | | | | |Account Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Delete Account Menu |Delete Account |Account Parameters |Query database |If request valid, Display | | | | | |Account Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Account Change |Confirm Account Change |User Confirm |Update database |Display Account Options | |Confirmation | | | |Menu | |Display Appointment Menu |Menu |Menu Selection |Output Selection |Selected Menu | |Display Create Appointment Menu |Create Appointment |Time and Date |Query database |If request valid, Display | | | | | |Appointment Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Update Appointment Menu |Update Appointment |Time and Date |Query database |If request valid, Display | | | | | |Appointment Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Delete Appointment Menu |Delete Appointment |None |Query database |If request valid, Display | | | | | |Appointment Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Appointment Change |Confirm Appointment |User Confirm |Update database |Display Appointment Menu | |Confirmation |Change | | | | |Display Report Menu |Display Report |None |None |Return to Report Menu upon | | | | | |return request | Administrator Diagram Events and Actions |Current State |Event |Input |Action |Next State | |Display Log-in Menu |Log-in |Username and Password |Validate Log-in |If log-in fails, loop to | | | | | |current state. | | | | | |Else Display Main Menu | |Display Main Menu |Menu |Menu Selection |Output Selection |Selected State | |Display Account Management |Menu |Menu Selection |Output Selection |Selected State | |Menu | | | | | |Display Add Account Menu |Add Account |Account Parameters |Query database |If request valid, Display | | | | | |Account Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Update Account Menu|Update Account |Account Parameters |Query database |If request valid, Display | | | | | |Account Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Delete Account Menu|Delete Account |Account Parameters |Query database |If request valid, Display | | | | | |Account Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Account Change |Confirm Account Change |User Confirm |Update database |Display Account Options | |Confirmation | | | |Menu | |Display Appointment |Menu |Menu Selection |Output Selection |Selected Menu | |Management Menu | | | | | |Display Add Appointment |Add Appointment |Time and Date |Query database |If request valid, Display | |Menu | | | |Appointment Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Update Appointment |Update Appointment |Time and Date |Query database |If request valid, Display | |Menu | | | |Appointment Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Delete Appointment |Delete Appointment |Time and Date |Query database |If request valid, Display | |Menu | | | |Appointment Change | | | | | |Confirmation. | | | | | |Else loop to current state | |Display Appointment Change |Confirm Appointment |User Confirm |Update database |Display Appointment Options| |Confirmation |Change | | |Menu | VI VALIDATION AND CRITERIA Performance Bounds Response Time This system responds within 5 seconds, and it is also assumed that if two rules are enabled, then either one of them may be scheduled first to open. Longest program execution time before a fixed point of the program is reached from a start state. Previous work in computing the response time bounds for rule based programs effectively assumes that all rules take the same amount of firing time. Reliability This system has a capability to continue to perform successfully after a fault occurrence. If a simple Duplication is used, the system can detect the fault when a fault is introduced and some recovery mechanisms such as rollback can be used to recapture the successful state of the system. Classes of Tests Unit Test The first test in the development process is the unit test. This test ensures that each unique path of the project performs accurately to the specifications and contains clearly defined inputs and expected results. System Test This set of test ensures that our entire integrated software system meets requirements. It tests a configuration to ensure known and predictable results. System testing is based on process descriptions and flows, emphasizing pre-driven process links and integration points. Functionality This set of test is employed to verify whether the operation meets the intended specifications and functional requirements laid out in the development documentation. Performance This set of test covers a broad range of engineering or functional evaluations where a material, product, system, or user is not specified by detailed material or component specifications: rather, emphasis is on the final measurable performance characteristics. This set is used as a diagnostic aid in locating communications bottlenecks. Often a system will work much better if a problem is resolved at a single point or in a single component. Reliability This set of test is about exercising an application so that failures are discovered and removed before the system is deployed. Because the different combinations of alternate pathways through an application are high, it is unlikely that we can find all potential failures in a complex application. Acceptance Testing the system will confirm the readiness of the product and customer acceptance. VII BIBLIOGRAPHY http://www.bwci.com/bwc/pages/software.htm#Modules http://www.vetsysdb.com VIII APPENDIX Major Function Summary Log-in Function (Shared Function) –provides security and control of the user’s level of access. Schedule Appointment Function (Client Function) – allow users to create, update and delete appointments scheduled by the clients. Account Status Check Function (Client Function) - allow users to check their account status. Service Inquiry Function (Client Function) – allow users to inquire services of the veterinary hospital. User Account Set-up Function (Staff and Administrator Function) – allow users to add, update and delete user accounts. Report Generation Function (Staff and Administrator Function) – allows staff and administrator produce reports. Access Control Function (Administrator Function) – controls the users level of access and provides user authentication. Account Management Function (Administrator Function) – allows administrator to add, update and delete staff accounts. ----------------------- Vaccination Type Animal Vaccination Animal Owner Drug Drug Prescribed Condition Regime Staff Condition Type Animal Diagnosis Appointment Procedure Drug Dosage may require has requires is administered may require may result in for a may require performs may require administered packaged as Log-in Clients Administrator Account Management Access Control Appointment Management Account Deletion Account Update Account Creation Schedule Appointment Service Inquiry Account Status Check Staff User Account Set-up Appointment Set-up Report Generation Appointment Deletion Appointment Update Appointment Addition Appointment Deletion Appointment Update Appointment Creation Appointment Creation Appointment Fee Purchased Item Client Account Deletion Client Account Update Client Account Creation Appointment Update Appointment Deletion Browser Display Main Menu Display Log-in Menu Update Balance Banking System Display Payment Menu Display Purchased Item Display Account Info Menu Display Appointment Menu Request Confirmation Display Inquiry Search Menu Display Inquired Info Display Appointment Fees Log-in Failed Log-in Log-out Search Request Reserve Request Return Request Search Request Return Request Get Account Info Return Request Get Reserved List Return Request Return Request Get Purchased Item Get Balance Validate Payment Error Success Log-out Log-in Log-in Failed Display Log-in Menu Browser Display Main Menu Display Report Menu Report Request Return Request Display Report Generate Report Return Request Display Appointment Menu Display Create Appointment Menu Display Update Appointment Menu Display Delete Appointment Menu Display Appointment Change Confirmation Display Account Options Menu Display Create Account Menu Display Update Account Menu Display Delete Account Menu Display Account Change Confirmation Request Failed Request Failed Request Failed Return Request Account Request Create Request Update Request Delete Request Confirm Change Appointment Request Return Request Request Failed Request Failed Request Failed Display Account Change Confirmation Display Delete Account Menu Display Update Account Menu Display Add Account Menu Display Appointment Change Confirmation Display Account Options Menu Display Delete Appointment Menu Display Update Appointment Menu Display Add Appointment Menu Display Appointment Menu Log-in Log-out Log-in Failed Display Log-in Menu Browser Display Main Menu Account Request Return Request Add Request Request Failed Request Failed Request Failed Request Failed Request Failed Request Failed Update Request Delete Request Validate Request Confirm Change Appointment Request Return Request Delete Request Update Request Add Request Validate Request Validate Request Validate Request Confirm Change Veterinary Hospital Information System Drug Supplier Client Veterinarian Staff Animal History Details Veterinarian Details Drug Details Supplier Details Follow up Treatment Details Diagnosis Details Animal and Owner Details Payment Details Vaccination Details Reminder Notice Appointment Details Bill Details Staff Details Client Account Details Staff Staff Member Accept Staff Member Details Veterinarian Manage Animal Treatment Details Maintain Appointment Details Animal Animal Owner Drug Animal Owner Drug Supplier Maintain Owner and Animal Details Maintain Customer Account Information Maintain Drug Supplier Details Staff Details Staff Availability Updated Staff Details Staff Details Veterinarian Details Vaccination Details Diagnosis Details Animal History Details Drug Treatment Animal Details Follow up Treatment Details Owner Details Reminder Notice Appointment Details Client Account Details Payment Details Bill Details Animal and Owner Details Updated Owner Details Existing Owner Details Updated Animal Details Existing Animal Details Drug Details Supplier Details Updated Drug Details Existing Drug Details