Software Design Specification：软件设计规范Software Design SpecificationElectronic Inspection SchedulerJim CoanJoe WolfordChris LesnieskiCIS 495 – Senior DesignDr. MaximNovember 10, 2005- 1 -1.0 IntroductionThis software is being created to replace the paper version of the buildinginspection schedule for the Building and Safety department at the City ofDearborn. The program is going to store past inspections, and future inspections.In addition to the storage of information for the scheduling it will also have someadded functionality. The additional criterion for the program is the following: , Each inspector will have limited inspections during a specific day, willbe flexible each day and controlled by the application., Each inspector will have inspections in the East and /or west end ineach day, Program will identify and skip holidays, days off and inactive inspector., Data entry clerks will have the ability to enter vacation, sick, trainingtime or other reasons for blocking dates and times, Program must allow complete audit trail of all transaction dates, time,users, and workstation ID, Program will print inspection reports by one day, multiple dates, specific inspector, and specific inspector by date range, A calendar on the forms screen to allow user the pick a date, if available, text range on screen is acceptable also, Allow the user to schedule an inspection for the first available date, Allow the user to schedule an inspection for the first available dateafter a specific date, Allow the user to schedule an inspection for the first available date byspecific inspector, All tables will allow adding, searching, modifying and deleting recordsfrom the same screen, Drop down menu for selection of records, All drop down menus must allow data entry to add more itemswithoutexiting the screen1.1 Goals and ObjectivesThe goals of this project is to replace the current antiquated system that is being used to schedule building inspections. Ourobjective is to allow scheduling to be done in a more orderly, and simple fashion with future scheduling being a simple thing to do. The current system that is in place does not allow for inspections to be scheduled to far in advance. We hope to make finding available dates for inspections and specific inspectors an easy thing to do.1.2 Statement of ScopeOur software is a scheduling tool that will allow the clerks in the - 2 -department to schedule appointments for the building inspectors. The major inputs for the software will be the date for the inspection if requested on a specific date, otherwise first available will be used. The inspector requested if any, or the first available inspector will be used. An additional input will be for when reports are being generated. The software will ask for the day, or inspector, for which to generateand inspection report. The clerk will also be able to enter when the inspectors will have holidays, sick days, or other sorts of time off so that when the scheduling is done it will automatically block those dates from being scheduled. The inspectors will also be able to access their schedules via the internet/intranet where ever they are.The outputs that will be available from the software will be reports. They will be able to choose from a daily report to a report by inspector. There will be many different reports that will be available for many different situations that the clerk would need reports for.1.3 Software ContextThis software is intended to be used for scheduling building inspections by the clerks in the Building and Safety department at the City of Dearborn. The inspectors will also use it to view their schedules. Depending on what the customer wants to do schedules willalso be available for the people receiving the inspections.1.4 Major Constraints, Anyone using the software must have their PC connected to theinternal network. Since it runs off of a server the computer must be able to connect to it., The people doing the data entry will have to be trained beforeusingthe software. Throwing them into using it without any training would leave them wondering how things work., Audit Trails may become large if there is a single record that is editedfrequently. This should not happen as once it is entered it should beleft alone. The most that should happen is a reschedule being done on it once or twice., Holidays will have to be checked for validity. Since some of them fluctuate every year the program may be incorrect. Also since some holidays may fall on a weekend, the preceding Friday, or following Monday may be given off as compensation so they will need to be added in as holidays., When an inspector retires from the City the people monitoring the database will have to go into the system and manually set his/her status toinactive so that they are not scheduled on any more inspections.- 3 -, Only one data entry person may be working on a specific file at a time.If two people are trying to enter the same inspection at the same timeit will cause errors to occur., The software will only be available for use on the internal network forthe time being. This can be remedied by the City should they decide to open it up to the public, but as of now it will only be available internally., Communication of ideas between the Technical contact and the group. , Time is a major constraint that we have on this project. , Arranging times to meet up with the business.- 4 -2.0 Data DesignA description of all data structures including internal, global, and temporary datastructures.2.1 Internal Software Data StructureThis section describes data structures that are passed among components the software.2.1.1 ClassesEach form in the interface has a backend class file, which storesallof the interface functions, stored procedure calls, and variables.2.1.2 Form ObjectsWithin each of the forms there are form objects. There consist of data grids, dropdown menus, text boxes, labels, list boxes,calendar controls and several other form objects.2.1.3 Stored ProceduresAll functionalities in the system are performed using a storedprocedure. These stored procedures contain transact SQL thatmanipulate the data in the database. The procedures are called in the classes.2.2 Global Data StructureThis section describes data structures that are available to major portions of the architecture are described.2.2.1 FormsThe interface consists of three different forms. Each of these forms has an html backend, form objects, along with a class. There is a schedule (main) form, user form, and administration form. Inaddition there is a menu control that is similar to a form and has the same information incorporated.2.3 Temporary Data Structure- 5 -This section describes data structures in the system that are for temporaryuse.2.3.1 Temporary VariablesThere will be many places in the system where we will need to use temporary variables. This exists in most programs for many different uses such as counters, global variables, temporary strings, etc.2.3.2 Temporary Form ObjectsThere will also be many places in the system in which we will needto use form objects temporarily.For example, in the case of working with data grids and template columns, in order to make changes to the objects in the column, we must create a temporary form object and set it equal to the object on the form. You then use the temporary object to make your changes.Temporary form objects will also be used within functions to simply store information for the duration of the function call.2.3.3 Session objects and variablesIn the system we will be using sessions to temporarily store information. This information includes login information, form objects, and variables.For example, to prevent having to go back to the database repeatedly every time a grid is loaded, we can store the grid containing the information into a session object. Once we load the grid again, we can simply take the grid out of the session instead of re-querying the database.2.4 Database DescriptionThis section describes each data object, relationships between objects, acomplete data model, as well as a data dictionary.2.4.1 Data Objects2.4.1.1 Action Type- 6 -The action_type table stores information about the types of actions that are performed in the audit trail. These actions may include “update” and “delete”.2.4.1.2 Audit TrailThe audit_trail table stores information for an action involving an “update” or “delete”. This information involvesth e user’s id that performed the action, the user’s workstation id, the action performed, the date, the time, and a constructed string ofthe previous record before action was performed.2.4.1.3 HolidayThe holiday table stores dates and names for holidays. It is when scheduling inspections so that the system ignores any holidays.2.4.1.4 Home Type- 7 -The home_type table stores information about the different hometypes used in the system. This table is used specifically for theinspections table. The current home types are “single”, “duplex”, and “multi”. Each home type has a weight, which is used in determining how many homes an inspector is inspecting in a day.2.4.1.5 Inspection Date DefaultThe inspection_date_default table is used to store the default number of homes an inspector may expect on any given day. If thereisn’t a specific amount for the current date in theinspection_date_specific table, then the num_allowed_per_day value in the inspection_date_default table is used as a maximum amount before an admin is prompted.2.4.1.6 Inspection Date SpecificThe inspection_date_specific table is used to store the number of homes an inspector may expect on a specific date. Thenum_allowed_per_day value is used as a maximum amount before an admin is prompted.2.4.1.7 Inspection Time- 8 -The inspection_time table is used to store the different times ofthe day that inspections can take place. Currently the only times are “AM” and “PM”. However, in the future they may change to havingthree or four times a day in which inspections will take place. This gives them flexibility.2.4.1.8 Inspection LocationThe inspection location table is used to store the different locations in which sections can take place. Currently the only locations are “East” and “West”. However, in the future theymay divide the city into a more defined breakdown of city locations. This would allow them extra flexibility.2.4.1.9 Inspection ScheduleThe inspection schedule table is used to store information about inspections. It acts as the primary table in the system in terms of scheduling and each record in the table represents an appointment. Allinformation pertaining to an appointment is recorded in or related to this table.2.4.1.10 Inspection Status- 9 -The inspection_status table stores information for the different inspection statuses. Currently the only statuses are “Open” and “Closed”.2.4.1.11 Inspection TypeThe inspection_type table stores information for the different types of inspections. Currently the inspection types in the system are “first”, “second”, and “final”.2.4.1.12 InspectorThe inspector table is used to store information about inspectors. It saves their id, name, and status.2.4.1.13 Inspector Days OffThe inspector_days_off table is used to store the days off for each inspector. Each record stores the id of the inspector, the date that they will have off, and the reason for the day off of work.2.4.1.14 Inspector Status- 10 -The inspector_status table stores information for each of the types of inspector statuses. The current status types in the system are “active” and “inactive”.2.4.1.15 UserThe user table stores information about the users of the system. The user id, user name, password, name, and role are stored in the user table.2.4.1.16 User RoleThe user_role table stores information for the different roles in the system. Currently the only roles in the system are “viewer”, “administrator”, and “super administrator”.- 11 -3.0 Architectural and Component-Level Design3.1 Program StructureArchitecture is not the operation software. Rather, it is a representation that enables a software engineer to 1) analyze the effectiveness of the design in meeting its stated requirements, 2) consider architectural alternatives at a stage when making design changes is still relatively easy, and 3) reduce the risks associated with the construction of the software. Architectural design focuses on the representation of the structure of the software components, their properties, and interactions.3.1.1 Architectural DiagramPlease see the appendix for the architectural diagram of the overall system.3.1.2 AlternativesThe main architecture for this project is a data-centered architecture. Ourrequirements stated we need to develop a program that will not only storedata but also allow multiple users to retrieve and modify that data. As theintegrity of that data is very important, some sort of data store would beideal. This way, different users from all over the department could haveaccess to the same data at the same time compared to the old paper system, in which there was only one clipboard which held the data.Two other minor architectures exist within this system. A data-flow architecture is present, despite that data may not pass through more anymore than two filters before reaching it’s destination. This is mostlyautomated by the suite of programs we are using ( and MSSQL).Most of the data manipulation happens with and formatting it tothe next component’s expected form.The other minor, and last, design architecture was a layered architecture.There are components which handles interactions with the user.Components within the next inner level () handle transform datafrom the user interface to the database interface or from the databaseinterface to the user interface. Lastly, at the core we have the databaseitself and it’s components in the form of stored procedures.The two other main architectures – call and return and object-oriented –we have decided not to implement as they don’t quite fit our needs. In acall and return architecture, one main program or function is ableto callother program components which can either finish their processing andreturn to the main program or call other components creating a vertical- 12 -hierarchy of control within one larger overall component. In our system data is more or less passed along a horizontal route between larger components – a user interface, , and MSSQL.In looking at our data model, choosing to implement our system in an object-oriented architecture would mean that objects (and the available behavior of objects) are the primary components within the system. For our system, tables appeared to be better geared for describing, storing, and organizing the data.3.2 Description for Component View Audit Trail3.2.1 Component View Audit Trail PSPECThe Audit Trail is a separate table within the database which holds all of the edited and deleted inspection schedules for the past six months. No inspectors or administrators are allowed access to this listing, only super administrators.3.2.2 Component View Audit Trail Processing Detail3.2.2.1 Interface DescriptionThis component has no input. As the user has already been validated earlier, no username or password needs to be checked. Also, there is no range of dates specified.The output will be sent to the page to be displayed in alistformat.3.2.2.2 Algorithmic Modelcomponent View Audit Trail;call generic query in a stored procedure from ;receive data from database;if dataReceived > spaceAvailableOnScreenpartition up dataReceiveddisplay dataReceived;end View Audit Trail;3.2.2.3 Restrictions/LimitationsNone at this time.3.2.2.4 Local Data StructuresA set of strings which hold enqueued entries from the Audit Trail whenthere is too much information to display on screen at one time.- 13 -3.2.2.5 Performance IssuesDe to the large amount of entries, retrieving and displaying all of them, which may number into the thousands for the past six months, may take a bit longer than a normal query on the database.The format of the data will not be displayed in a polished manner as it normally would if an administrator or inspector were looking at a current schedule. This may present a problem for the page if the data is not broken into easily displayable chunks.3.2.2.6 Design ConstraintsNone at this time.3.3 Description for Component Create New Inspection3.3.1 Component Create New Inspection PSPECWhen a person requests a new inspection, where an inspection is one inspector inspecting one building, this should be the component that allows the administrator to add an inspection to the database.3.3.2 Component Create New Inspection Processing Detail3.3.2.1 Interface DescriptionFor the input of this component, data will be received from the user by way of the Read In Data component. The inputs the user should give are: inspector’s name, the address of the building, contact phone number, which side of the city it resides in, the time of the inspection, the status, the type of inspection to be conducted, and a memo if necessary.This component should take the data and pass it to the Validity Check component of the system. After the data has been submitted to thedatabase, a message stating either a success or failure will be displayed using the Display Messages component.3.3.2.2 Algorithmic Modelcomponent CreateNewInspection;get formData from frontend;validate formData;pass formData in query to database;pass successFailFlag to DisplayMessages;end CreateNewInspection;- 14 -3.3.2.3 Restrictions/LimitationsNone at this time.3.3.2.4 Local Data StructuresData will be taken from local form objects and stored in temporary variables before they are committed to a stored procedure.3.3.2.5 Performance IssuesA potential performance issue would be related to the time it takes anadministrator to input the data. There may be upwards of 15schedules requested per day. If the administrator cannot input data into the system, and receive confirmation that it was stored properly,faster than they could using their paper system, we may have aproblem with the interface which should then be analyzed again.3.3.2.6 Design ConstraintsNone at this time.3.4 Description for Component Delete Inspection3.4.1 Component Delete Inspection PSPECWithin a day’s schedule, there are many different inspectionslisted for many different addresses. Suppose someone who already has an inspection needs to cancel it. The administrator can then scroll to find the date specified, look for the address, and delete it’s entry. The rest of the schedules for that day will be left untouched.3.4.2 Component Delete Inspection Processing Detail3.4.2.1 Interface DescriptionThe input to this component should come from the Read In Datacomponent. The information passed here should include whichaddress needs to be deleted along with the date that the inspection was scheduled on.The output of this component will be the data specified above which ispassed to the Format Data component. After the database has been modified, a message passed back denoting either success or failure willbe displayed using the Display Messages component.3.4.2.2 Algorithmic Model- 15 -component DeleteInspection;get deleteData from ReadInData;confirm deletion with a warning from DisplayMessages;query database for deleteData;delete entry in database using standard query;send message of success or failure to DisplayMessages;end DeleteInspection;3.4.2.3 Restrictions/LimitationsNone at this time.3.4.2.4 Local Data StructuresA temporary variable which holds the piece of data that is searched forin the database.3.4.2.5 Performance IssuesThe data needs to be deleted from the database and a messagepassed back to the user within a relatively short amount of time –about one second or less. This will keep both the administrator and the person cancelling their inspection from waiting too long for verification and also prevent the administrator from hitting the Deletebutton more than once if they think they did not hit it the first time.3.4.2.6 Design ConstraintsNone at this time.3.5 Description for Component Modify Inspection3.5.1 Component Modify Inspection PSPECAfter someone schedules an inspection, information may change or may not have been entered in the first time. This component will allow the administrator to go back to that person’s scheduled inspection andeither change information or add new information to the inspection.3.5.2 Component Modify Inspection Processing Detail3.5.2.1 Interface DescriptionThe input will be data that is taken from the Read In Data component.This data can be one or more of the following items: inspector’s name,the address of the building, contact phone number, which side of the city it resides in, the time of the inspection, the status, the typeofinspection to be conducted, and a memo.- 16 -The output of the system will be data that is handed to the Validity Check component.3.5.2.2 Algorithmic ModelComponent ModifyInspection;set modData to whatever is passed from ReadInData;send modData to be validated;send modData to a stored procedure which will allow the databaseto change entries;end ModifyInspection;3.5.2.3 Restrictions/LimitationsThe component should not allow two entries to exist within thedatabase that have exactly the same traits. While their IDs given to them by the database may be different, searches and modifications are performed by searching strings. If more than one entry pops up, the administrator may not know which one to edit.3.5.2.4 Local Data StructuresTemporary variables, which will be stored from the form data, will holdthe data that needs to be stored into the database.3.5.2.5 Performance IssuesNone at this time.3.5.2.6 Design ConstraintsNone at this time.3.6 Description for Component View Schedules3.6.1 Component View Schedules PSPECThis component is responsible for the main functionality of the system. Here both the read-only users and administrators are able to see inspection schedules for any given day. If the user is read-only, they should be able to view just their inspection schedule, not anyoneelse’s, and should not be able to edit it in anyway.3.6.2 Component View Schedules Processing Detail3.6.2.1 Interface DescriptionOne input needed here will be the user’s privileges, decided by theUser Verification component. As of deployment of this system, there - 17 -should only be read-only, administrator, and super administrator defined as privilege levels.Another will be the date which to view inspection schedules. Theuser may do this by navigating through a small calendar on their screen. Clicking an appropriate day will submit that day, as an output, to the database to query.3.6.2.2 Algorithmic ModelComponent ViewSchedules;call generic query in a stored procedure from ;receive data from database;if dataReceived > spaceAvailableOnScreenpartition up dataReceiveddisplay dataReceived;end ViewSchedules;3.6.2.3 Restrictions/LimitationsAs stated above, this component will rely on what privileges theuser has. If an administrator is using the system, not only can they view all inspector’s schedules but they also have the ability to edit, delete, and create inspections. If a read-only user is logged into the system, they should only be able to view their schedules and not anyone else’s.3.6.2.4 Local Data StructuresA set of strings which hold enqueued entries from the schedule when there is too much information to display on screen at one time.3.6.2.5 Performance IssuesQuerying the database for the information and having it display in a timely matter (less than five seconds) would be helpful to the user. If an inspector calls from the field and asks where the next place they need to go is, the quicker the data is displayed the quicker the inspector can do their job.3.6.2.6 Design ConstraintsThis is one of the components which depends on the security being strong enough to keep out people who shouldn’t be viewing others’ schedules and data. One thing that we cannot prevent, however, is having an administrator log into the system and allowing a read-only user to look at the screen.3.7 Description for Component Search Schedule- 18 -3.7.1 Component Search Schedule PSPECThe inspection schedule will probably become very populated with data. In order to quickly look up an inspection while only knowing pieces of data that are in the inspection, a search function will be implemented. This component will allow the user to search through the schedules by such things as inspectors names, phone numbers, date scheduled, addresses, times, parts of the city, what type of inspection it is, and how large of a building is to be inspected.This function can also allow administrators or super administrators to do some back of the envelope analysis. By searching by just one field and one term, the results shown may bring up certain patterns, such as Wednesday is the busiest day for inspections, or that multi-family homes are more likely to be built on the west side of the city than the east.3.7.2 Component Search Schedule Processing Detail3.7.2.1 Interface DescriptionThis component will take data from the Read In Data component. This data can be any one or more of the following: inspector’s name, the address of the building, the date to be conducted, contact phone number, which side of the city it resides in, the time of the inspection,the status, the type of inspection to be conducted, and a memo.The output of the system will be a query sent to the database afteritis passed through a Validation Check to make sure the data is of the correct type.3.7.2.2 Algorithmic Modelcomponent SearchSchedule;store ReadInData returned into searchData;send searchData to ValidityCheck;use searchData in stored procedure;end SearchSchedule;3.7.2.3 Restrictions/LimitationsThere will be a ceiling put into place on the number of results whichcan be returned. If the search is too intensive or has too broad of ascope, the user might not be able to get the information they need quickly. Not to mention the CPU cycles wasted searching through all the tables for that data.3.7.2.4 Local Data Structures- 19 -Temporary variables which hold the data from the form objects while they are validated and then converted for use in appropriate stored procedures.3.7.2.5 Performance IssuesSearching through potentially tens of thousands of fields in a databasecan not only be problematic for the user – who has to wait for the results – but also for the machine itself that hosts the database. Themachine has other processes and daemons running on it so the search on the database needs to take care not to hog all the available CPU cycles.3.7.2.6 Design ConstraintsNone at this time.3.8 Description for Component Display Results。
