OnVeterinary Project

System Design Document
Version: SRS V1.0

Prepared by Team #11 Ali Kaan Kiriş – Onur Babaoğlu Enver Can Karaduman – Mehmet Uyanık

OnVeterinary PROJECT

www.OnVeterinary.com

December 20th, 2010

Atılım University COMPE/SE/ISE 491-492

2/35 Team # 11 (Team OnVeterinary)

System Design Document Version: 1.0

OnVeterinary PROJECT

Preface
This Software design Description Document v1.0 contains of detailed design of “OnVeterinary” system. The main objective of this document is to demonstrate the system design by means of module decomposition, module and data detailed designs. All the dependencies between modules and data are described detailed.

Version History Version 1 Status* Released Date 20.12.2010 Responsible Team 11 Version Definition First SDD Version

*: Draft, In Review, Released, Approved, Rejected, In Change

Atılım University COMPE/SE/ISE 491-492

3/35 Team # 11 (Team OnVeterinary)

System Design Document Version: 1.0

...........................................................................................14 FIG......................................................................... 1 REGISTER MODULE.......................................24 FIG.........9 TREATMENT MODULE.... 16 GUEST GUI SAMPLE..............................12 FIG...............23 FIG.................................................................................................................................................................20 FIG...................................................... 15 SYSTEM MODULES (CTRL + LEFT CLICK)................. 8 CUSTOMER MODULE.............17 FIG... 4 STOCK MODULE...........29 FIG..........................................11 FIG..........................................16 FIG......... 3 ADVERTISEMENT MODULE........... 6 MEDICAL INTERACTION MODULE.....30 : : List of Tables : : Atılım University COMPE/SE/ISE 491-492 4/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1...... 14 VET GUI SAMPLE – HTTP://WWW..........................................19 FIG.8 FIG........................................................5 CALENDAR MODULE................28 FIG................................................................................................ 16 SYSTEM OVERVIEW.........MIRANAHOSTING.............9 FIG......................................................................................................ASPX... 13 MODULE DESCRIPTIONS (CTRL + LEFT CLICK)...................... 10 ER DIAGRAM WITH ATTRIBUTES ................25 FIG.............................................................................................COM/MAIN..... 2 ANIMAL MODULE............................................0 ......................................................................................OnVeterinary PROJECT List of Figures FIG............................................................................................................................ 7 ANIMAL FAMILY TREE MODULE........

......30 3.........................................3................................... Definitions.....................6 0.............28 3......................................................... Module Detailed Design.......... Scope......... SYSTEM OVERVIEW......9 2................................................2............................... Calender Table...... SYSTEM COMPONENTS...............1..................................30 3......................4 LIST OF TABLES ................................................32 3....................................... RTM.......................................................................................................................3............. Definitions................................................................................................1.........................9 2...............................2.................................................................9 2. Decomposition Description....30 3........... User Table......................................................................................................................................................................6 0..................................................... Dependency Description...................... User Interfaces (GUI)............................................................5......................28 2....................................................................... Treatment Table.....2...............32 3..........................2...................... Data Decomposition................ Animal Table...................................... Acronyms & Abbreviations.......2......... Intermodule Description..............................................................2.........................................................................3..................... References.6 0.....................7 1......................................3................................................................................ Accounting Table. Data dependencies.... Interface Description...................... Acyronyms...........................................31 3.....................................7.1.....................................................................................................................................................................................................3 LIST OF FIGURES........1.....................................................................................................................................................................................................................................................................31 3.........................2.................................................30 3.........27 2...................................................................................32 3........4 TABLE OF CONTENTS.......................................................... Stock Table......................2.............................................................2...............2..................................................2..............................1..OnVeterinary PROJECT Table of Contents PREFACE................... APPENDICES....................................................................................32 4.......................................3..........................23 2.......................................2............2..3................6..................... Data Detailed Design..................1...............1................1...............................................5 INTRODUCTION............................1....35 Atılım University COMPE/SE/ISE 491-492 5/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1..0 .........................6 0....... Customer Table...... Module Decomposition ............................................................................1..3..............................6 0...................................................................................28 2.......................................................25 2.............................2.....................................................................4......................................6 0.................................4........... Purpose......2...........................................................................3.............................8 2............................. Module Interfaces.............2................................................................................... DETAILED DESIGN..............................................................................................30 3........2....................................24 2....................................................................................

OnVeterinary PROJECT Introduction 0. Acronyms SDD Acyronyms Software Design Document. System interface. apply veterinary registrations. This document is the main reference for code improvement which should contain all the information for a developer.3. Customer Customers of veterinaries.1. 0. database and design will briefed detailed in order to guide the implementation phase. Online Veterinary Management System. Acronyms & Abbreviations Definitions Admin The person or persons who controls the system. They can see their animals information and treatments of animals in their panel. Atılım University COMPE/SE/ISE 491-492 6/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. They may use our system with veterinary accounts.3.0 . Scope The SDD indicates how the software system will be arranged in order to satisfy the requirements.2. 0. Guest OnVeterinary They are unauthorized people. Purpose This document provides the detailed design of “OnVeterinary” system.2.1.3. 0. Definitions Definitions. 0. Veterinary OnVeterinary system designed for veterinaries.

Personal Digital Assistant 0. 1997 Fairley. McGraw-Hill. IEEE CS Press. IEEE Standard for Software Project Management Plans Pressman.4. Software Engineering. Workbreakdown Structure.0 .OnVeterinary PROJECT SDD ER SW PDA Software Design Description Entity Relationship. 1997 Software Engineering Project Atılım University COMPE/SE/ISE 491-492 7/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1... Software. Roger S. Management. 4th edition. • • • References IEEE Std 1058-1998. R. E.

0 .OnVeterinary PROJECT 1. 16 System Overview User Group Admin Responsible for Veterinary Accounts Database Back-up Critical Data Modifications Veterinary Customer Accounts Advertisement Management Customer Guest - Atılım University COMPE/SE/ISE 491-492 8/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. System Overview Fig.

0 .OnVeterinary PROJECT 2. System Components 2. Decomposition Description This section will be handled with two aspects.1.1. Module Decomposition In this section all of the modules are decomposed. explained and visualized with diagrams below.1. module and data decomposition.1. 2.1. Register Module Fig. 1 Register Module Atılım University COMPE/SE/ISE 491-492 9/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.1. 2.

at the same time it is about veterinary. and register . Register sub module has the following hierarchy. checkUser function provides us indicates users who are registered system or not . register function is used to register for veterinary who fills necessary information at the registration forms . Atılım University COMPE/SE/ISE 491-492 10/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. Process Purpose: This module is used to open accounts only veterinary . recorded necessary information • Register Module o o checkUser(). Function: Register Module consists of two sub functions which are checkUser .register module is check up every user of the system .0 .OnVeterinary PROJECT Identification: Register Module Type: GUI. register().

OnVeterinary PROJECT 2. Animal Module Fig.2.1.removeAnimal) veterinary is used to addAnimal function fills the necessary information about animal adding animal in the system.1. editAnimal function veterinary can make changes on the animal information .searchAnimal.0 . 2 Animal Module Identification: Animal Module Type: Application . searchAnimal function veterinary research to get necessary Atılım University COMPE/SE/ISE 491-492 11/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.process Purpose: This module responsible for providing veterinary can performs all kinds of animal information Function: Animal module has five sub functions (addAnimal.editAnimal. deleteAnimal function veterinary is deleted animal recorded information at the system using this function.viewAnimal function provide veterinary can see detailed information about the animal .editAnimal .

3. Fig.1.0 . 3 Advertisement Module Atılım University COMPE/SE/ISE 491-492 12/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.OnVeterinary PROJECT information about animal using this function hierarchy • Animal Module o o o o o addAnimal() removeAnimal() editAnimal() viewAnimal() searchAnimal() Advertisement Module Animal sub module has the following 2.1.

process Purpose: Veterinary needs or wants sell any medicine material such as vaccine . they can review product in detail. Advertisement sub module has the following hierarchy • Advertisement Module o Public Advertisement      addPublicAdvertisement() removePublicAdvertisement() editPublicAdvertisement() viewPublicAdvertisement() searchPublicAdvertisement() o Private Advertisement Atılım University COMPE/SE/ISE 491-492 13/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.OnVeterinary PROJECT Identification:Advertisement Module Type:Application.0 . SearchAdvertisemen function users research to getting information about materials or needs anything.and public Advertisement which are private veterinaries can only accessed private public advertisement these two advertisement . ViewAdvertisement function within the web-page. EditAdvertisement function is used to user can make change on the users can see all of the ads published advertisement. removeAdvertisement user does not want to publish advertisements this function provides us remove unnecessary advertisement. medicament .veterinary who can used to advertisement module to needed anything published on the website Function: Advertisement module consists of two sub module Advertisement . customers and visitors can see only module has five different functions addAdvertisement function is used for users fills content of advertisement published on the webpage .

therefore veterinary can get receive information about kept product .1. Function: Stock module is used only by veterinary .4. process Purpose: Stock Module is used to for veterinary can see status of products in the their stock. and veterinary also determine to holding products at the stock.1.OnVeterinary PROJECT      2. Each stock is unique Stock Module consists of ten sub Atılım University COMPE/SE/ISE 491-492 14/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. 4 Stock Module Identification:Stock Module Type:Application.0 . addPrivateAdvertisement() removePrivateAdvertisement() editPrivateAdvertisement() viewPrivateAdvertisement() searchPrivateAdvertisement() Stock Module Fig.

removeSupplyType. editSupplyType function is provides veterinary can make change information of product . viewSupplyType . addSupplyType. searchSupplyType the product. ViewSupplyType function veterinary can see detalied information of product.0 . drug in the stock. used to for veterinary fills neccessary fields about material . searchSupplyType. editFromType function function provides veterinary can make change on the stock informations Stock sub module has the following hierarchy • Stock Module o Supply Type        Atılım University COMPE/SE/ISE 491-492 using this function was able to get any information about addSupplyType() removeSupplyType() editSupplyType() searchSupplyType() viewSupplyType() addToSupplyType() removeFromSupplyType() 15/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. editFromSupplyType . product’s removeSupplyType expiration date . removeFromSupplyType . searchSupplyType function is used to veterinary checks whether there are products such as vaccine . addSupplyType function provides veterinary add detalied information about product such as number of products. searchFromSupplyType . then can add new items at their stock.OnVeterinary PROJECT functions which are addToSupplyType. addToSupplyType function is editSupplyType. RemoveFromType function veterinary does not want to use the products in stock allows to remove from stock. viewFromType function is used to veterinary can see all of the products at the stock. viewFromSupplyType . function if veterinary want to deleting information about product using this function. product price.

OnVeterinary PROJECT    editFromSupplyType() viewFromSupplyType() searchFromSupplyType() 2.5. addEvent provides veterinary can fills Atılım University COMPE/SE/ISE 491-492 16/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.1. searchEvent.5 Calendar Module Identification:Calendar Module Type:Application Purpose: Calendar Module is reminded to veterinary have to do tasks of daily working life. removeEvent. viewEvent.1. Function: Calendar module consists of have five functions which are the addEvent.0 . editEvent. Calendar Module Fig.

veterinary can remove selected events using this function. 6 Medical Interaction Module Atılım University COMPE/SE/ISE 491-492 17/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. and can make change viewEvent function provides veterinary can see necessary fields. Fig.1.1. function veterinary can accessed recorded events .6.OnVeterinary PROJECT necessary fields. using this function before added all of the events. then removeEvent editEvent function when reminder time is come system will warn veterinary.0 . Calendar sub functions has the following hierarchy • Calendar Module o o o o addEvent() removeEvent() editEvent() viewEvent() Medical Interaction Module 2.

Medical Interaction sub module has the following hierarchy • Interaction Module o o o o o o addInteraction() removeInteraction() editInteraction() viewInteraction() searchInteraction() setInteraction() Atılım University COMPE/SE/ISE 491-492 18/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.0 .OnVeterinary PROJECT Identification:Interaction Module Type:Application Purpose: Provides veterinary assigns items if used medicine or vaccine for treatment of animal interaction to another material Function: Medical Interaction Module have six sub functions which are addInteraction.vaccine . addInteraction functions provides veterinary selects medicine . viewInteraction function provides indicates all of the used interaction materials . removeInteraction. editInteraction. setInteraction function can help veterinary assigns more than one interaction vaccines searchInteraction function veterinary can get detailed information about interaction product using this function.searchInteraction. viewInteraction.editInteraction function provides veterinary can updated interaction’s information .treatment then assigns to interaction adding the system .and delete from the system.setInteraction.removeInteraction function provides veterinary can select interaction’s items .

viewInformationAFT function veterinary want to see detailed Atılım University COMPE/SE/ISE 491-492 19/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.1.7.after that fills animal’s genders of animal’s father and mother to adding system.OnVeterinary PROJECT 2. viewInformationAFT. editInformationAFT function veterinary can make change on the selected animal. RemoveInformationAFT function veterinary selects animal remove information about animal’s family from system.0 .1. editInformationAFT. removeInformationAFT. Animal Family Tree Module Fig. addInformationAFT function is used for veterinary enter animal ID number . 7 Animal Family Tree Module Identification:Animal Family Tree Module Type:Application Purpose: provide veterinarian keeps information to the type of animal family Function: Animal Family Tree module consists of four sub functions which are addInformationAFT.

1. Atılım University COMPE/SE/ISE 491-492 20/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.OnVeterinary PROJECT information about animal’s family using this function. Animal Family Tree sub module has the following hierarchy • Animal Family Tree Module o o o o 2.1.8.0 . addInformationAFT() removeInformationAFT() editInformationAFT() viewInformationAFT() Customer Module Fig. 8 Customer Module Identification:Customer Module Type:Application Purpose: Provides Veterinary can see information of all the users who are registered at the system.

editCustomer function provides veterinary can update or change customer recorded information.removeTreatment . searchCustomer function provides veterinary research to get detalied information about their customers .checkMedicalInteraction . which will used the treatment method of animal . searchCustomer. Treatment Module Identification:Treatment Module Type:Application Purpose:Veterinary can review applied animal treatment methods in the past. editTreatment. viewTreatment .0 .1.1.such as the vaccine . addTreatment function is used to for veterinary can add new treatment . removeCustomer function is used to for veterinary wanted to be deleted from system. removeCustomer.OnVeterinary PROJECT Function: Customer Module consists of the five sub functions which are addCustomer.viewCustomer. addCustomer function is used to for veterinar can add new user at their system . viewCustomer function provides veterinary can follow customer who is registered the system . editCustomeri. drug will add to detalied information in this section Function: Treatment module consists of five sub functions which are addTreatment. Customer sub module has the following hierarchy • Customer Module o o o o o addCustomer() removeCustomer() editCustomer() viewCustomer() searchCustomer() 2.9. but veterinary Atılım University COMPE/SE/ISE 491-492 21/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.

and when treatment module will add. and previous drug Treatment sub module has the following hierarchy • Treatment Module o o o o o addTreatment() editTreatment() viewTreatment() removeTreatment() checkMedicalInteraction() Atılım University COMPE/SE/ISE 491-492 22/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. this function will check interaction between new drug . checkMedicalInteraction function provides if veterinary will use a new drug for treatment of animal . viewTreatment function provides indicates that all medicines which used for animal. editTreatment function provides veterinary selects the treatment . removeTreatment function provides selects the treatment which wanted to be deleted. wanted to change treatment information fields. defines content of treatment system will assigned automatically date of treatment another necessary side .OnVeterinary PROJECT must fills treatment head .0 . enter animal’s ID number .

Data Decomposition Atılım University COMPE/SE/ISE 491-492 23/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.9 Treatment Module 2.OnVeterinary PROJECT Fig.0 .1.2.

Dependency Description Atılım University COMPE/SE/ISE 491-492 24/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.OnVeterinary PROJECT Fig.2.0 . 10 ER Diagram with Attributes 2.

13 Module Descriptions (CTRL + LEFT CLICK) Fig. Intermodule Description Fig. 12 Veterinary Account Modules (CTRL + LEFT CLICK) Atılım University COMPE/SE/ISE 491-492 25/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.OnVeterinary PROJECT 2.0 .2.1.

X5 STOCK M ODULE X6 ACCOUNTING M ODULE X7 CALENDAR MODULE X8 MEDICAL INTERACTIONX9 MODULE ANIMAL FAMILY TREEX10 MODULE TREATMENT MODULE X11 X1. X6. X10. X9. X7.0 . Atılım University COMPE/SE/ISE 491-492 26/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.X12 : User cannot go forward before authentication X3. X5. user should be authenticated. X2. X8.OnVeterinary PROJECT AUTHENTICATION AUTHENTICATION CUSTOMER MODULE ANIMAL MODULE X3 X4 ADVERTISEMENT X1 REGISTER MODULE X2 MOBILE M ODULE X12 PRIVATE ADVERTISM.X11 : In order to see contents of the modules. X4.

OnVeterinary PROJECT 2.0 .2.2. Data dependencies Atılım University COMPE/SE/ISE 491-492 27/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.

aspx Atılım University COMPE/SE/ISE 491-492 28/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. 2. Include all modules and they are able to manage their own modules. User Interfaces (GUI) Veterinary Panel Interface Sample 2. 2.1. 2.2. 14 Vet GUI Sample – http://www.miranahosting.1.0 .3.3.1.OnVeterinary PROJECT 2. Fig.1. Include all modules.3.2. Admin panel will be designed for administrative tasks.1.3. Veterinary Panel Veterinary panel will be designed for veterinaries due to their requirements.3. Interface Description Module Interfaces Admin Panel 2.com/main.2.3.

OnVeterinary PROJECT 2. Admin Panel Interface Sample Admin panel GUI is under construction. 16 Guest GUI Sample 2. Atılım University COMPE/SE/ISE 491-492 29/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.2.2.3.3. Guest Panel Interface Sample Fig.2.3.0 .

2. Detailed Design 3. 3. Calender Table Name Data Type Size Atılım University COMPE/SE/ISE 491-492 30/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.OnVeterinary PROJECT 3.0 .1. 15 System Modules (CTRL + LEFT CLICK) 3.2.2.2. Module Detailed Design Fig. Data Detailed Design User Table Name UserID UserName Password UserType Data Type int varchar varchar char Size 32 50 50 2 3.1.

4.3.OnVeterinary PROJECT CalenderID EventName EventStartDate EventEndDate SmsReminderFlag E-MailReminderFlag ReminderFlag EventDescription int varchar date date bool bool bool varchar 32 100 500 3.2. Animal Table Name Data Type Int Varchar Varchar Varchar Varchar Float Float Float 31/35 Team # 11 (Team OnVeterinary) Size 32 50 50 500 32 20 20 20 System Design Document Version: 1. Customer Table Name Data Type int varchar varchar varchar int date varchar varchar varchar varchar varchar varchar Size 32 50 50 32 32 20 20 100 20 500 20 CustomerID Name Surname TCKimlik VeterinaryID RegistrationDate City Country E-Mail PhoneNumber Address MobilePhoneNumber 3.2.0 Animal_ID AnimalsMother AnimalsFather AnimalDescription AnimalKind AnimalWeight AnimalHeight AnimalLength Atılım University COMPE/SE/ISE 491-492 .

Treatment Table Name Data Type int varchar date Size 32 100 - TreatmentID OperationName Date 3.2.2.7.2. 3.0 .3. RTM Create Veterinary Account Admin has the authority toRegistration Module confirm registrations.OnVeterinary PROJECT AnimalPicturePath AnimalIdentityNumber AnimalType AnimalAge AnimalGender Varchar Varchar Varchar int varchar 100 32 20 5 10 3. Stock Table Name Data Type Int Varchar Float Int Date varchar Size 32 50 20 10 50 StockID Name Price Count Date Type 3.6. Accounting Table Still working on this table and its content. veterinary Atılım University COMPE/SE/ISE 491-492 32/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.5.

Admin remove has authority item toStock Module Remove Stock from veterinary stock.0 . Admin has authority to editAnimal Module animal. Admin has authority to editAdvertisement Module advertisement.OnVeterinary PROJECT Admin has authority toCustomer Module Create Customer Account create customer accounts. Admin has authority to editCustomer Module customer account. Admin has authority toCalendar Module Edit Calendar Atılım University COMPE/SE/ISE 491-492 33/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. Admin has authority toStock Module Edit Stock Edit Advertisement modify veterinary stocks. Admin has authority toCustomer Module Remove Customer Account Edit Customer Account remove customer account. Admin has authority toAnimal Module Remove Animal Edit Animal Add Animal remove animal. Admin has authority toAdvertisement Module Create Advertisement publish advertisement. Admin has authority toAdvertisement Module Remove Advertisement remove advertisement. Admin has authority ofStock Module Add Stock adding item to veterinary stock. Admin has authority to addAnimal Module animal.

OnVeterinary PROJECT modify veterinary calender. Admin has authority toCalendar Module Remove Calendar remove veterinary calendar Admin has authority to addCalendar Module item to veterinary calender. Admin modify veterinary. Admin has authority to editMedical Interaction Module Add/Edit/Remove medical veterinary.0 . has authority toTreatment Module for Add/Edit/Remove Treatment Treatment Atılım University COMPE/SE/ISE 491-492 34/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1. Admin has authority toAnimaly Family TreeAdd/Edit/Remove Animal Family Tree interaction for Medical Interaction Add Calendar modify Animal family treeModule for veterinary.

OnVeterinary PROJECT 4. Appendices Atılım University COMPE/SE/ISE 491-492 35/35 Team # 11 (Team OnVeterinary) System Design Document Version: 1.0 .