Section 2 – Software Requirements · PDF fileInventory and Work Order Management System (IWOMS) Software Requirements Specification Peter C. Maroon December 1, 2000 Section 2 –

Inventory and Work Order Management System (IWOMS) Software Requirements Specification

Peter C. Maroon December 1, 2000

Section 2 – Software Requirements Specification Table of Contents

Chapter 1 – Introduction ................................................................................................................. 2 1.1 Purpose............................................................................................................................ 2 1.2 Scope of Project .............................................................................................................. 2 1.3 Glossary .......................................................................................................................... 3 1.4 References....................................................................................................................... 4 1.5 Overview of Document................................................................................................... 4

Chapter 2 – Overall Description ..................................................................................................... 4 2.1 System Environment............................................................................................................. 5 2.2 Functional Requirements Definition..................................................................................... 5

2.2.1 Create Work Order......................................................................................................... 5 2.2.2 View Work Order .......................................................................................................... 6 2.2.3 Print Work Order ........................................................................................................... 6 2.2.4 Close Work Order .......................................................................................................... 7 2.2.5 Edit Work Order ............................................................................................................ 7 2.2.6 Add Inventory Record.................................................................................................... 8 2.2.7 Add Inventory Record Component................................................................................ 8 2.2.8 View Inventory Record.................................................................................................. 9 2.2.9 Edit Inventory Record.................................................................................................. 10 2.2.10 Edit Inventory Record Component ............................................................................ 10 2.2.11 Transfer Inventory Record Component ..................................................................... 11 2.2.12 Delete Inventory Record Component ........................................................................ 12 2.2.13 Delete Inventory Record ............................................................................................ 12 2.2.14 Copy Inventory Record.............................................................................................. 13 2.2.15 Generate Work Order Statistics Report ..................................................................... 14 2.2.16 Generate Library Hours Report ................................................................................. 14 2.2.17 Generate Mileage Report ........................................................................................... 15 2.2.18 Generate Network Address Report ............................................................................ 15 2.2.19 Generate Expired Warranty Report ........................................................................... 16 2.2.20 Generate Hardware Specifications Report................................................................. 17

2.3 User Interface Specification................................................................................................ 17 2.4 Non-Functional Requirements ............................................................................................ 18 2.5 System Evolution................................................................................................................ 18

Chapter 3 – Requirements Specification....................................................................................... 18 3.1 External Interface Requirements......................................................................................... 18

3.2 Functional Requirements .................................................................................................... 18 3.2.1 Create Work Order....................................................................................................... 18 3.2.2 View Work Order ........................................................................................................ 19 3.2.3 Print Work Order ......................................................................................................... 20 3.2.4 Close Work Order ........................................................................................................ 20 3.2.5 Edit Work Order .......................................................................................................... 21 3.2.6 Add Inventory Record.................................................................................................. 22 3.2.6 Add Inventory Record Component.............................................................................. 23 3.2.8 View Inventory Record................................................................................................ 24 3.2.9 Edit Inventory Record.................................................................................................. 24 3.2.10 Edit Inventory Record Component ............................................................................ 25 3.2.11 Transfer Inventory Record Component ..................................................................... 26 3.2.12 Delete Inventory Record Component ........................................................................ 27 3.2.13 Delete Inventory Record ............................................................................................ 28 3.2.14 Copy Inventory Record.............................................................................................. 28 3.2.15 Generate Work Order Statistics Report ..................................................................... 29 3.2.16 Generate Library Hours Report ................................................................................. 30 3.2.17 Generate Mileage Report ........................................................................................... 31 3.2.18 Generate Network Address Report ............................................................................ 31 3.2.19 Generate Expired Warranty Report ........................................................................... 32 3.2.20 Generate Hardware Specifications Report................................................................. 32

3.3 Detailed Non-Functional Requirements ............................................................................. 33 Appendix A: Sample User Interface Prototypes........................................................................... 33

A.1 IWOMS Main Menu .......................................................................................................... 33 A.2 Work Orders Module Form................................................................................................ 35 A.3 Work Order Form............................................................................................................... 35 A.4 Inventory Module Form..................................................................................................... 37 A.5 Inventory Record Form...................................................................................................... 38 A.6 Reports Module Form ........................................................................................................ 38

Index ............................................................................................................................................. 39

Chapter 1 – Introduction

1.1 1.1 Purpose This document is the software requirements specification. The software requirements specification document is a detailed description explaining exactly what the software is supposed to do and gives the user a general idea about how to use the software. The software requirements specification is designed to aid the user as well as the developer in better understanding the workings of the system.

1.2 1.2 Scope of Project The Inventory and Work Order Management System (IWOMS) will be developed for the employees of the Information Technologies (IT) Department at the Scranton Public Library. The Scranton Public Library is a member of the Lackawanna County Library System, which also

consists of the Abington Community Library, the Carbondale Public Library, the Dalton Community Library, the Interboro United Districts Library, the North Pocono Public Library, and the Taylor Public Library. The IT Department at the Scranton Public Library maintains a wide-area network with about 100 clients and provides technical support to all member libraries of the Lackawanna County Library System. The IT Department staff includes the Head of Information Technologies, two University of Scranton students, and a volunteer from The University of Scranton. The IT Department will use IWOMS in the following ways: to keep track of open and closed work orders, to maintain an inventory of all computer equipment used by the Lackawanna County Library System, and to generate reports related to work orders and inventory. This system will replace a commercial software package called Track It!. IWOMS will be a significant improvement over the system which is currently in production, a commercial software package called Blue Ocean Track It!. Track It! does not meet all of the needs of the IT Department. Since Track It! can only be run by one computer at a time, access to this software by IT Department staff members is limited. Also, Track It! has forms and fields which request unnecessary data, and it does not provide the ability to easily generate all needed reports. IWOMS will include features which will eliminate the inadequacies of Track It!. IWOMS will have the following system objectives:

• • To make the IT Department employees more efficient by meeting their exact needs.

• • To provide more relevant information about work orders and computer hardware inventory to decision-making personnel.

1.3 1.3 Glossary Term Definition Action A verb which describes the action to be performed in a work order Form A box that appears on a display screen to present information or request

input Inventory Component

Contains information pertaining to an item that is part of an inventory record

Inventory Module Window

The window that allows an IWOMS user to carry out functionalities related to inventory

Inventory Record Contains information pertaining to a computer or device IT Staff Member An employee of the Information Technologies Department at the Scranton

Public Library IWOMS Inventory and Work Order Management System, this system IWOMS Client Application

The portion of IWOMS responsible for displaying the user interface and processing application logic

IWOMS Database A database which stores information pertaining to work orders and inventory records

IWOMS Main Menu

The window that appears when the IWOMS client application is loaded; it gives access to IWOMS’s three modules: work orders, inventory, and reports

Managers Managers at the Scranton Public Library; primarily, the Library Director and the Business Manager

Network Printer Any printer with network connectivity to which the IWOMS client

application can print Object A noun which describes on what an action is going to be performed in a

work order Reports Module The window that allows an IWOMS user to generate reports pertaining to

work orders and inventory Work Order A description of a task which the Head of IT would like an IT Department

staff member to perform Work Orders Module Window

The window that allows an IWOMS user to carry out functionalities related to work orders

1.4 1.4 References None.

1.5 1.5 Overview of Document The software requirements specification document contains several chapters that dissect and elaborate on aspects such as the functionality of the system, what is required for the system to run properly, how the system may change over time, and it gives the user a view, through prototypes, of how the system will look. Chapter 2 will be an overall description of the system. It will include the System Environment, which describes the relationship between the system, its components, and the external environment of the system, the Functional Requirements Definition, which provides a detailed overview of the services provided to the user, the User Interface Specification, which details how the user will interface with the system, the Non-Functional Requirements, which are constraints and standards, and the System Evolution, which identifies requirements that do not need to be implemented at this time. Chapter 3 will cover the Requirements Specification, which lists each functionality of the system in full detail, and the Detailed Non-Functional Requirements, which is a formal listing of the rest of the non-functional requirements.

Chapter 2 – Overall Description IWOMS will include three modules: a work order module, an inventory module, and a reports module. In this context, work orders are a description of a task which the Head of IT would like an IT Department staff member to perform. The work order module of IWOMS will have two main functionalities: (1) the Head of IT will be able to create work orders and assign them to the appropriate IT Department employee with a certain numbered priority level, and (2) the IT Department staff members will be able to view these work orders and indicate to the department head when the task is complete. The IWOMS inventory module will enable the IT Department to maintain an inventory of all IT-related hardware owned by the Lackawanna County Library System or one of its member libraries. The primary functionalities of the inventory module will be to allow the IT Department to add, edit, and remove inventory records. The reports module of IWOMS will provide information about work orders and the equipment inventory to facilitate the decision-making of appropriate personnel, upon request.

2.1 System Environment

IT Staff Mem ber

IWOMS Databas e

Managers

Network Printer

IWOMSUse System

Query/Maintain Datab ase

Provide Reports

Print

(For explanations, see Section 1.3)

2.2 Functional Requirements Definition

2.2.1 Create Work Order (For Use Case Realizations, see Design Document, section 5.1)

Use Case: Create Work Order Diagram:

IT Staff Member Create Work Order IWOMS Database

Brief Description The use case Create Work Order is initiated by the Primary User to create a work order in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using.

1. The Primary User selects “Work Orders” from the IWOMS Main Menu. 2. In the Work Orders Module window, the Primary User selects “Create”. 3. IWOMS prompts the Primary User for work order information. 4. When the Primary User finishes data entry, he/she selects “Save” on the form.

5. IWOMS inserts the work order into the work order list, which is ordered by priority number, on the Work Orders Module window.

(For Full Functional Requirements Specification, see 3.2.1.)

2.2.2 View Work Order (For Use Case Realizations, see Design Document, section 5.2)

Use Case: View Work Order Diagram:

IT Staff Mem ber View Work Order IWOMS Databas e

Brief Description The use case View Work Order is initiated by the Primary User to view a work order in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one work order exists.

1. The Primary User selects “Work Orders” from the IWOMS Main Menu. 2. In the Work Orders Module window, the Primary User selects a work order from a list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays information pertaining to the work order. 5. When the Primary User is finished viewing the work order, he/she selects “Close” on the

form. (For Full Functional Requirements Specification, see 3.2.2.)

2.2.3 Print Work Order

(For Use Case Realizations, see Design Document, section 5.3) Use Case: Print Work Order Diagram:

IT Staff Mem ber Print Work Order IWOMS Databa s e

Brief Description The use case Print Work Order is initiated by the Primary User to print a work order in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one work order exists.

1. The Primary User selects “Work Orders” from the IWOMS Main Menu. 2. In the Work Orders Module window, the Primary User selects a work order from a list.

3. The Primary User then selects “Print”. 4. IWOMS prints information pertaining to the work order.


2.2.4 Close Work Order

(For Use Case Realizations, see Design Document, section 5.4) Use Case: Close Work Order Diagram:

IT Staff Mem ber Clos e Work Order IWOMS Databa s e

Brief Description The use case Close Work Order is initiated by the Primary User to indicate that a work order in IWOMS has been completed. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one work order exists.

1. The Primary User selects “Work Orders” from the IWOMS Main Menu. 2. In the Work Orders Module window, the Primary User selects a work order from a list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays information pertaining to the work order. 5. The Primary User changes the Status field to Closed. 6. The Primary User selects “Save” on the form.


2.2.5 Edit Work Order (For Use Case Realizations, see Design Document, section 5.5)

Use Case: Edit Work Order Diagram:

IT Staff Mem b er Edit Work Order IWOMS Databas e

Brief Description The use case Edit Work Order is initiated by the Primary User to modify information pertaining to a work order in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one work order exists.

1. The Primary User selects “Work Orders” from the IWOMS Main Menu. 2. In the Work Orders Module window, the Primary User selects a work order from a list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays information pertaining to the work order. 5. The Primary User makes all necessary changes to the work order. 6. When the Primary User is finished modifying the work order, the Primary User selects

“Save” on the form. (For Full Functional Requirements Specification, see 3.2.5.)

2.2.6 Add Inventory Record

(For Use Case Realizations, see Design Document, section 5.6) Use Case: Add Inventory Record Diagram:

IT Staff MemberAdd Inventory Record

IWOMS Database

Brief Description The use case Add Inventory Record is initiated by the Primary User to add a new inventory record in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using.

1. The Primary User selects “Inventory” from the IWOMS Main Menu. 2. In the Inventory Module window, the Primary User selects “Add”. 3. IWOMS prompts the Primary User for inventory information. 4. When the Primary User finishes data entry, he/she selects “Save” on the form. 5. IWOMS inserts the inventory record into the inventory list, which is sorted by

computer/device name in ascending order, on the Inventory Module window. (For Full Functional Requirements Specification, see 3.2.6.)

2.2.7 Add Inventory Record Component (For Use Case Realizations, see Design Document, section 5.7)

Use Case: Add Inventory Record Component Diagram:

IT Staff MemberAdd Inventory Record Component

IWOMS Database

Brief Description The use case Add Inventory Record Component is initiated by the Primary User to add a component to an inventory record in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists.

1. The Primary User selects “Inventory” from the IWOMS Main Menu. 2. In the Inventory Module window, the Primary User selects an inventory record from a

list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays a form with the inventory record’s information. 5. On the form, the Primary User selects “Add Component”. 6. IWOMS prompts the Primary User for component information. 7. When the Primary User finishes data entry, he/she selects “Save” on the form. 8. IWOMS inserts the component into the component list, which is sorted by component

name in ascending order, on the inventory record’s form. (For Full Functional Requirements Specification, see 3.2.7.)

2.2.8 View Inventory Record

(For Use Case Realizations, see Design Document, section 5.8) Use Case: View Inventory Record Diagram:

IT Staff Mem berView Inventory Record IWOMS Databas e

Brief Description The use case View Inventory Record is initiated by the Primary User to view an inventory record in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists.


list.

3. The Primary User then selects “View/Edit”. 4. IWOMS displays the inventory record’s information. 5. When the Primary User is finished viewing the inventory record, he/she selects “Close”

on the form. (For Full Functional Requirements Specification, see 3.2.8.)

2.2.9 Edit Inventory Record

(For Use Case Realizations, see Design Document, section 5.9) Use Case: Edit Inventory Record Diagram:

IT Staff MemberEdit Inventory Record

IWOMS Database

Brief Description The use case Edit Inventory Record is initiated by the Primary User to change an inventory record’s information in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists.


list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays the inventory record’s information. 5. The Primary User makes all necessary changes to the inventory record. 6. When the Primary User is finished modifying the inventory record, the Primary User

selects “Save” on the form. (For Full Functional Requirements Specification, see 3.2.9.)

2.2.10 Edit Inventory Record Component (For Use Case Realizations, see Design Document, section 5.10)

Use Case: Edit Inventory Record Component Diagram:

IT Staff MemberEdit Inventory Record Component

IWOMS Database

Brief Description The use case Edit Inventory Record Component is initiated by the Primary User to change the information for an inventory record’s component in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists with at least one component.


list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays the inventory record’s information. 5. On the form, the Primary User selects a component. 6. The Primary User then selects “View/Edit Component”. 7. IWOMS displays the component information. 8. The Primary User makes all necessary changes to the component information. 9. When the Primary User is finished modifying the component information, the Primary

User selects “Save” on the form. (For Full Functional Requirements Specification, see 3.2.10.)

2.2.11 Transfer Inventory Record Component

(For Use Case Realizations, see Design Document, section 5.11) Use Case: Transfer Inventory Record Component Diagram:

IT Staff MemberTransfer Inventory Record

ComponentIWOMS Database

Brief Description The use case Transfer Inventory Record Component is initiated by the Primary User to move an inventory record’s component to another inventory record in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists with at least one component.


list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays the inventory record’s information. 5. On the form, the Primary User selects a component. 6. The Primary User then selects “Transfer Component”.

7. IWOMS prompts the Primary User for the computer/device name to which the component will be transferred.

8. IWOMS inserts the component into the component list of the inventory record of both the computer/device where the component did reside and the computer/device to which the component was transferred.


2.2.12 Delete Inventory Record Component

(For Use Case Realizations, see Design Document, section 5.12) Use Case: Delete Inventory Record Component Diagram:

IT Staff Member Delete Inventory Record Component

IWOMS Database

Brief Description The use case Delete Inventory Record Component is initiated by the Primary User to remove an inventory record’s component from IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists with at least one component.


list. 3. The Primary User then selects “View/Edit”. 4. IWOMS displays the inventory record’s information. 5. On the form, the Primary User selects a component. 6. The Primary User then selects “Delete Component”. 7. IWOMS removes the component from the component list of the inventory record.


2.2.13 Delete Inventory Record (For Use Case Realizations, see Design Document, section 5.13)

Use Case: Delete Inventory Record Diagram:

IT Staff Me m ber Delete Inventory Record IWOMS Databas e

Brief Description The use case Delete Inventory Record is initiated by the Primary User to remove an inventory record from IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists.


list. 3. The Primary User then selects “Delete”. 4. IWOMS confirms the removal of this inventory record. 5. IWOMS removes the inventory record.

(For Full Functional Requirements Specification, see 3.2.13)

2.2.14 Copy Inventory Record

(For Use Case Realizations, see Design Document, section 5.14) Use Case: Copy Inventory Record Diagram:

IT Staff MemberCopy Inventory Record

IWOMS Database

Brief Description The use case Copy Inventory Record is initiated by the Primary User to create a copy of an inventory record in IWOMS. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists.


list. 3. The Primary User then selects “Copy”. 4. IWOMS prompts the user for the inventory tag number and name of the computer/device

of the new inventory record.

5. IWOMS creates the new inventory record and copies the information from the old inventory record to the new one.

6. IWOMS inserts the inventory record into the inventory list, which is sorted by computer/device name in ascending order, on the Inventory Module window.


2.2.15 Generate Work Order Statistics Report (For Use Case Realizations, see Design Document, section 5.15)

Use Case: Generate Work Order Statistics Report Diagram:

IT Staff Mem ber Generate Work Order Stat is t ics Report

IWOMS Databas e

Brief Description The use case Generate Work Order Statistics Report is initiated by the Primary User to create a report pertaining to various work order statistics. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one work order exists.

1. The Primary User selects “Reports” from the IWOMS Main Menu. 2. In the Reports Module window, the Primary User selects “Work Order Statistics Report”. 3. IWOMS displays a report consisting of the amount of work orders completed by each IT

Department staff member, the amount of work orders completed per computer/device, the amount of work orders completed per each resolution type, and the amount of work orders involving each action, each object, or each combination of an action and an object.

4. When the Primary User is finished viewing the report, he/she selects “Close” on the report.


2.2.16 Generate Library Hours Report (For Use Case Realizations, see Design Document, section 5.16)

Use Case: Generate Library Hours Report Diagram:

IT Staff Mem ber Generate Library Hours Report IWOMS Databas e

Brief Description The use case Generate Library Hours Report is initiated by the Primary User to create a report of the amount of hours that the IT Department devoted to each remote library.

Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one work order pertaining to a remote library exists.

1. The Primary User selects “Reports” from the IWOMS Main Menu. 2. In the Reports Module window, the Primary User selects “Library Hours Report”. 3. IWOMS displays a report which gives a list of the number of hours that the IT

Department devoted to each remote library. 4. When the Primary User is finished viewing the report, he/she selects “Close” on the

report. (For Full Functional Requirements Specification, see 3.2.16.)

2.2.17 Generate Mileage Report (For Use Case Realizations, see Design Document, section 5.17)

Use Case: Generate Mileage Report Diagram:

IT Staff Mem ber Generate Mileage Report IWOMS Databas e

Brief Description The use case Generate Mileage Report is initiated by the Primary User to create a report of the total number of miles for work-related travel that each IT Department staff member has. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one work order pertaining to a remote library exists.

1. The Primary User selects “Reports” from the IWOMS Main Menu. 2. In the Reports Module window, the Primary User selects “Mileage Report”. 3. IWOMS displays a report listing the date, the number of miles, and the library visited for

each trip and the total number of miles for work-related travel that each IT Department staff member has and a grand total of the number of miles that the IT Department, as a whole, traveled.

4. When the Primary User is finished viewing the report, he/she selects “Close” on the report.


2.2.18 Generate Network Address Report

(For Use Case Realizations, see Design Document, section 5.18) Use Case: Generate Network Address Report Diagram:

IT Staff Me m ber Generate Netw ork Ad dres s Repor t IW OMS Databas e

Brief Description The use case Generate Network Address Report is initiated by the Primary User to create a report of network address information for each computer/device. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record pertaining to a networked computer/device exists.

1. The Primary User selects “Reports” from the IWOMS Main Menu. 2. In the Reports Module window, the Primary User selects “Network Address Report”. 3. IWOMS displays a report consisting of the following, if applicable: computer/device

name, network drop location, switch/hub port number, and IP address. 4. When the Primary User is finished viewing the report, he/she selects “Close” on the


2.2.19 Generate Expired Warranty Report

(For Use Case Realizations, see Design Document, section 5.19) Use Case: Generate Expired Warranty Report Diagram:

IT Staff Mem berGenerate Expired Warranty Report IWOMS Databas e

Brief Description The use case Generate Expired Warranty Report is initiated by the Primary User to create a report that indicates when the warranty for each computer/device will expire. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record exists.

1. The Primary User selects “Reports” from the IWOMS Main Menu. 2. In the Reports Module window, the Primary User selects “Expired Warranty Report”. 3. IWOMS displays a report listing each computer/device and its warranty expiration in

ascending order by date and then by computer/device name. 4. When the Primary User is finished viewing the report, he/she selects “Close” on the


2.2.20 Generate Hardware Specifications Report

(For Use Case Realizations, see Design Document, section 5.20) Use Case: Generate Hardware Specifications Report Diagram:

IT Staff Mem berGenera te Hardware Sp eci fications

Repor tIWOMS Databas e

Brief Description The use case Generate Hardware Specifications Report is initiated by the Primary User to create a report of the hardware specifications for each computer/device. Initial Step-By-Step Description Before this use case can be initiated, the Primary User has already run the IWOMS client application on the computer that he/she is using and at least one inventory record pertaining to a computer/device exists.

1. The Primary User selects “Reports” from the IWOMS Main Menu. 2. In the Reports Module window, the Primary User selects “Hardware Specifications

Report”. 3. IWOMS displays a report indicating the hardware specifications for each

computer/device. 4. When the Primary User is finished viewing the report, he/she selects “Close” on the


2.3 User Interface Specification The primary users of IWOMS will be the personnel of the IT Department. The IWOMS client will only require the users to be familiar with the features of a basic Windows application. Since the IT Department staff use many different Windows applications in their job tasks, this requirement will not be a problem. Also, before being hired to work in the IT Department, an employee must already posses experience using Windows applications. There will be two different classes of users, IT Department staff and managers. IT Department staff members will access IWOMS directly via its client application. The IWOMS client application will consist of forms, buttons, text boxes, drop-down lists, radio buttons, message boxes, dialog boxes, and other common Windows features (See Appendix A: Sample User Interface Prototypes). Drop-down lists will facilitate data entry and lessen the likelihood of data entry errors. Users will have the ability to add items to drop-down lists by typing into the drop-down list’s text box. Except for the Head of the IT Department, managers will not access the system directly. A manager will request a report from the IT Department and an IT Department employee will then use IWOMS to generate and print that report and give it to the manager. The reports will be properly formatted and organized, and they will be in an appropriate order.

IWOMS will display an error message when it detects that input to a field is invalid. It will display a message box indicating which fields are invalid. This will assist a user in correcting his/her mistakes and will prevent the GIGO (garbage in, garbage out) effect.

2.4 Non-Functional Requirements • • A computer running the IWOMS client application must have one of the

following operating systems installed on it: Microsoft Windows 9x, NT 4.0, or 2000 Professional.

• • The server portion of IWOMS requires that the Microsoft SQL Server 7.0 database management system be installed on a server running Microsoft Windows NT Server 4.0.

2.5 System Evolution Eventually, the Head of the IT Department would like IWOMS to be Web-based. Staff would be able to submit a work order via a Web form. Upon submission, IWOMS would create the work order and send an e-mail notification to the Head of the IT Department. He would then access the work order in IWOMS, revise its description, if necessary, and assign a priority number and an IT Department staff member to it. Also, if IWOMS was Web-based, IT Department staff could access IWOMS remotely, and managers could easily access the Reports Module in IWOMS.

Chapter 3 – Requirements Specification

3.1 External Interface Requirements None.

3.2 Functional Requirements

3.2.1 Create Work Order Use Case Name Create Work Order Priority Essential Trigger None Precondition IWOMS is loaded. Basic Path 1. 1. The Primary User left-clicks on the Work Orders

button on the IWOMS Main Menu. 2. 2. IWOMS displays the Work Orders Module window. 3. 3. In the Work Orders Module window, the Primary

User left-clicks on the Create button. 4. 4. IWOMS displays a form called Work Order

requesting the Primary User to input work order information.

5. 5. When the Primary User finishes data entry, he/she left-clicks on the Save button on the Work Order form.

6. 6. IWOMS adds this work order information to the database.

7. 7. IWOMS refreshes the work order list on the Work

Orders Module window to include this new work order. 8. 8. IWOMS returns the Primary User to the Work

Orders Module window. Alternative Paths In Step 4, if the Primary User does not want to create a work

order, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Work Orders Module window.

Postcondition The new work order is added to the database. Exception Paths If the input to a field(s) on the Work Order form is invalid, when

the Primary User left-clicks on the Save button (Step 5), IWOMS displays a message box with an error message indicating which field(s) are invalid, and upon the Primary User left-clicking on the Close button on the message box, he/she continues with Step 4 in the Basic Path.

Other None (For Functional Requirements Definition, see 2.2.1)

3.2.2 View Work Order Use Case Name View Work Order Priority Essential Trigger None Precondition IWOMS is loaded and at least one work order must exist in the

database. Basic Path 1. 1. The Primary User left-clicks on the Work Orders


User left-clicks on an entry for a work order in the work order list.

4. 4. The Primary User then left-clicks on the View/Edit button.

5. 5. IWOMS displays a form called Work Order with information pertaining to the work order.

6. 6. When the Primary User is finished viewing the work order, he/she left-clicks on the Close button on the Work Order form.

7. 7. IWOMS returns the Primary User to the Work Orders Module window.

Alternative Paths Prior to Step 3, if the Primary User would like to view a closed work order, he/she left-clicks on the Closed radio button. IWOMS then displays only closed work orders. He/she continues with Step 3. In Step 3, prior to selecting a work order, the Primary User left-clicks on the Filter button, in the subsequent dialog box, selects an IT Department staff member from a drop-down list, and left-clicks on OK. IWOMS then displays only the work orders

pertaining to that staff member in the work order list. Postcondition None Exception Paths None Other None

(For Functional Requirements Definition, see 2.2.2)

3.2.3 Print Work Order Use Case Name Print Work Order Priority Desired Trigger None Precondition IWOMS is loaded and at least one work order must exist in the




4. 4. The Primary User then left-clicks on the Print button. 5. 5. IWOMS sends a print job with information

pertaining to the work order to the network printer. Alternative Paths In Step 3, prior to selecting a work order, the Primary User left-

clicks on the Filter button, in the subsequent dialog box, selects an IT Department staff member from a drop-down list, and left-clicks on OK. IWOMS then displays only the work orders pertaining to that staff member in the work order list.

Postcondition The work order information is printed. Exception Paths None Other None


3.2.4 Close Work Order Use Case Name Close Work Order Priority Essential Trigger None Precondition IWOMS is loaded and at least one work order must exist in the





5. 5. IWOMS displays a form called Work Order with

information pertaining to the work order. 6. 6. The Primary User selects Closed from a drop-down

list in the Status field. 7. 7. The Primary User left-clicks on the Save button on

the Work Order form. 8. 8. IWOMS updates this work order in the database. 9. 9. IWOMS refreshes the work order list on the Work

Orders Module window to exclude this closed work order.


Alternative Paths In Step 3, prior to selecting a work order, the Primary User left-clicks on the Filter button, in the subsequent dialog box, selects an IT Department staff member from a drop-down list, and left-clicks on OK. IWOMS then displays only the work orders pertaining to that staff member in the work order list. In Step 5, if the Primary User does not want to close a work order, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Work Orders Module window.

Postcondition The work order is updated in the database. Exception Paths None Other None


3.2.5 Edit Work Order Use Case Name Edit Work Order Priority Desired Trigger None Precondition IWOMS is loaded and at least one work order must exist in the





5. 5. IWOMS displays a form called Work Order with information pertaining to the work order.

6. 6. The Primary User modifies all of the fields that he/she needs to.

7. 7. The Primary User left-clicks on the Save button on the Work Order form.

8. 8. IWOMS updates this work order in the database.


Alternative Paths In Step 3, prior to selecting a work order, the Primary User left-clicks on the Filter button, in the subsequent dialog box, selects an IT Department staff member from a drop-down list, and left-clicks on OK. IWOMS then displays only the work orders pertaining to that staff member in the work order list. In Step 5, if the Primary User does not want to edit a work order, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Work Orders Module window.

Postcondition The work order is updated in the database. Exception Paths If the input to an edited field(s) on the Work Order form is

invalid, when the Primary User left-clicks on the Save button (Step 7), IWOMS displays a message box with an error message indicating which field(s) are invalid, and upon the Primary User left-clicking on the Close button on the message box, he/she continues with Step 5 in the Basic Path.


3.2.6 Add Inventory Record Use Case Name Add Inventory Record Priority Essential Trigger None Precondition IWOMS is loaded. Basic Path 1. 1. The Primary User left-clicks on the Inventory button

on the IWOMS Main Menu. 2. 2. IWOMS displays the Inventory Module window. 3. 3. In the Inventory Module window, the Primary User

left-clicks on the Add button. 4. 4. IWOMS displays a form called Inventory Record

requesting the Primary User to input inventory information.

5. 5. When the Primary User finishes data entry, he/she left-clicks on the Save button on the Inventory form.

6. 6. IWOMS adds this inventory information to the database.

7. 7. IWOMS refreshes the inventory list on the Inventory Module window to include this new inventory record.

8. 8. IWOMS returns the Primary User to the Inventory Module window.

Alternative Paths In Step 4, if the Primary User does not want to create an inventory record, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Inventory Module window.

Postcondition The new inventory record is added to the database.

Exception Paths If the input to a field(s) on the Inventory Record form is invalid, when the Primary User left-clicks on the Save button (Step 5), IWOMS displays a message box with an error message indicating which field(s) are invalid, and upon the Primary User left-clicking on the Close button on the message box, he/she continues with Step 4 in the Basic Path.


3.2.7 Add Inventory Record Component Use Case Name Add Inventory Record Component Priority Essential Trigger None Precondition IWOMS is loaded and at least one inventory record must exist in

the database. Basic Path 1. 1. The Primary User left-clicks on the Inventory button


left-clicks on an entry for an inventory record in the inventory list.


5. 5. IWOMS displays a form called Inventory Record with the inventory record’s information.

6. 6. The Primary User left-clicks on the Add Component button.

7. 7. IWOMS displays a form called Inventory Record Component requesting the Primary User to input inventory record component information.

8. 8. When the Primary User finishes data entry, he/she left-clicks on the Save button on the Inventory Record Component form.

9. 9. IWOMS adds this inventory record component information to the database.

10. 10. IWOMS refreshes the component list on the Inventory Record form to include this new component.

11. 11. IWOMS returns the Primary User to the Inventory Record form.

Alternative Paths In Step 7, if the Primary User does not want to add an inventory record component, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Inventory Record form.

Postcondition The new inventory record component is added to the database. Exception Paths If the input to a field(s) on the Inventory Record Component

form is invalid, when the Primary User left-clicks on the Save button (Step 8), IWOMS displays a message box with an error

message indicating which field(s) are invalid, and upon the Primary User left-clicking on the Close button on the message box, he/she continues with Step 7 in the Basic Path.


3.2.8 View Inventory Record Use Case Name View Inventory Record Priority Essential Trigger None Precondition IWOMS is loaded and at least one inventory record must exist in






6. 6. When the Primary User is finished viewing the inventory record, he/she left-clicks on the Close button on the Inventory Record form.


Alternative Paths None Postcondition None Exception Paths None Other None


3.2.9 Edit Inventory Record Use Case Name Edit Inventory Record Priority Essential Trigger None Precondition IWOMS is loaded and at least one inventory record must exist in




4. 4. The Primary User then left-clicks on the View/Edit

button. 5. 5. IWOMS displays a form called Inventory Record

with the inventory record’s information. 6. 6. The Primary User modifies all of the fields that

he/she needs to. 7. 7. The Primary User left-clicks on the Save button on

the Inventory Record form. 8. 8. IWOMS updates this inventory record in the

database. 9. 9. IWOMS returns the Primary User to the Inventory

Module window. Alternative Paths In Step 5, if the Primary User does not want to edit an inventory

record, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Inventory Module window.

Postcondition The inventory record is updated in the database. Exception Paths If the input to an edited field(s) on the Inventory Record form is

invalid, when the Primary User left-clicks on the Save button (Step 7), IWOMS displays a message box with an error message indicating which field(s) are invalid, and upon the Primary User left-clicking on the Close button on the message box, he/she continues with Step 5 in the Basic Path.


3.2.10 Edit Inventory Record Component Use Case Name Edit Inventory Record Component Priority Essential Trigger None Precondition IWOMS is loaded and at least one inventory record with at least

one component must exist in the database. Basic Path 1. 1. The Primary User left-clicks on the Inventory button





6. 6. The Primary User left-clicks on an entry for a component in the component list.

7. 7. The Primary User then left-clicks on the View/Edit Component button.

8. 8. IWOMS displays a form called Inventory Record Component with inventory record component

information. 9. 9. The Primary User modifies all of the fields that

he/she needs to. 10. 10. The Primary User left-clicks on the Save button on

the Inventory Record Component form. 11. 11. IWOMS updates this inventory record component

information in the database. 12. 12. IWOMS refreshes the component list on the

Inventory Record form to reflect any changes. 13. 13. IWOMS returns the Primary User to the Inventory

Record form. Alternative Paths In Step 8, if the Primary User does not want to edit an inventory

record component, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Inventory Record form.

Postcondition The inventory record component is updated in the database. Exception Paths If the input to a field(s) on the Inventory Record Component

form is invalid, when the Primary User left-clicks on the Save button (Step 10), IWOMS displays a message box with an error message indicating which field(s) are invalid, and upon the Primary User left-clicking on the Close button on the message box, he/she continues with Step 8 in the Basic Path.


3.2.11 Transfer Inventory Record Component Use Case Name Transfer Inventory Record Component Priority Desired Trigger None Precondition IWOMS is loaded and at least one inventory record with at least







7. 7. The Primary User then left-clicks on the Transfer Component button.

8. 8. IWOMS displays a dialog box requesting the Primary User to select the computer/device name to

which the component will be transferred from a drop-down list.

9. 9. The Primary User then left-clicks on OK. 10. 10. IWOMS moves this inventory record component to

another record in the database. 11. 11. IWOMS refreshes the component list on the

Inventory Record form of both the computer/device where the component did reside and the computer/device to which the component was transferred to reflect the transfer.


Alternative Paths In Step 8, if the Primary User does not want to transfer an inventory record component, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Inventory Record form.

Postcondition The inventory record component is moved to another record in the database.

Exception Paths None Other None


3.2.12 Delete Inventory Record Component Use Case Name Delete Inventory Record Component Priority Desired Trigger None Precondition IWOMS is loaded and at least one inventory record with at least







7. 7. The Primary User then left-clicks on the Delete Component button.

8. 8. IWOMS displays a message box confirming the deletion.

9. 9. The Primary User left-clicks on the Yes button. 10. 10. IWOMS deletes this inventory record component

from the database.

11. 11. IWOMS refreshes the component list on the Inventory Record form to reflect the deletion.


Alternative Paths In Step 8, if the Primary User does not want to delete an inventory record component, he/she left-clicks on the No button. IWOMS returns him/her to the Inventory Record form.

Postcondition The inventory record component is deleted from the database. Exception Paths None Other None


3.2.13 Delete Inventory Record Use Case Name Delete Inventory Record Priority Desired Trigger None Precondition IWOMS is loaded and at least one inventory record must exist in




4. 4. The Primary User then left-clicks on the Delete button.

5. 5. IWOMS displays a message box confirming the deletion.

6. 6. The Primary User left-clicks on the Yes button. 7. 7. IWOMS deletes this inventory record from the

database. 8. 8. IWOMS refreshes the inventory list on the Inventory

Module window to reflect the deletion. 9. 9. IWOMS returns the Primary User to the Inventory

Module window. Alternative Paths In Step 5, if the Primary User does not want to delete an

inventory record, he/she left-clicks on the No button. IWOMS returns him/her to the Inventory Module window.

Postcondition The inventory record is deleted from the database. Exception Paths None Other None


3.2.14 Copy Inventory Record Use Case Name Copy Inventory Record Priority Desired

Trigger None Precondition IWOMS is loaded and at least one inventory record must exist in




4. 4. The Primary User then left-clicks on the Copy button.

5. 5. IWOMS displays a dialog box requesting the Primary User to input the inventory tag number of the new computer/device and its name.

6. 6. The Primary User then left-clicks on OK. 7. 7. IWOMS creates this new inventory record in the

database and copies the information, except the inventory tag number and the computer/device name, from the selected, preexisting inventory record to the new one.

8. 8. IWOMS refreshes the inventory list on the Inventory Module window to include this new inventory record.


Alternative Paths In Step 5, if the Primary User does not want to copy an inventory record, he/she left-clicks on the Cancel button. IWOMS returns him/her to the Inventory Module window.

Postcondition The inventory record is copied to a new inventory record in the database.

Exception Paths In Step 5, if the input to a field(s) in the dialog box is invalid, when the Primary User left-clicks on the OK button (Step 6), IWOMS displays a message box with an error message indicating which field(s) are invalid, and upon the Primary User left-clicking on the Close button on the message box, he/she continues with Step 5 in the Basic Path.


3.2.15 Generate Work Order Statistics Report Use Case Name Generate Work Order Statistics Report Priority Desired Trigger None Precondition IWOMS is loaded and at least one work order must exist in the

database. Basic Path 1. 1. The Primary User left-clicks on the Reports button

on the IWOMS Main Menu. 2. 2. IWOMS displays the Reports Module window.

3. 3. In the Reports Module window, the Primary User left-clicks on the Work Order Statistics button.

4. 4. IWOMS displays a properly formatted report consisting of the amount of work orders completed by each IT Department staff member in ascending order by staff member name, the amount of work orders completed per computer/device in ascending order by computer/device name, the amount of work orders completed per each resolution type in ascending order by resolution type, and the amount of work orders involving each action, each object, or each combination of an action and an object in ascending order.

5. 5. When the Primary User is finished viewing the report, he/she left-clicks on the Close button on the report window.

6. 6. IWOMS returns the Primary User to the Reports Module window.

Alternative Paths None Postcondition The report is displayed in its proper format. Exception Paths None Other None


3.2.16 Generate Library Hours Report Use Case Name Generate Library Hours Report Priority Desired Trigger None Precondition IWOMS is loaded and at least one work order pertaining to a

remote library must exist in the database. Basic Path 1. 1. The Primary User left-clicks on the Reports button

on the IWOMS Main Menu. 2. 2. IWOMS displays the Reports Module window. 3. 3. In the Reports Module window, the Primary User

left-clicks on the Library Hours button. 4. 4. IWOMS displays a properly formatted report which

gives a list of the number of hours that the IT Department devoted to each remote library in ascending order by library.



Alternative Paths None Postcondition The report is displayed in its proper format. Exception Paths None


3.2.17 Generate Mileage Report Use Case Name Generate Mileage Report Priority Desired Trigger None Precondition IWOMS is loaded and at least one work order pertaining to a

remote library must exist in the database. Basic Path 1. 1. The Primary User left-clicks on the Reports button


left-clicks on the Mileage button. 4. 4. IWOMS displays a properly formatted report listing

the date, the number of miles, and the library visited for each trip and the total number of miles for work-related travel that each IT Department staff member has in ascending order by staff member name and a grand total of the number of miles that the IT Department, as a whole, traveled.





3.2.18 Generate Network Address Report Use Case Name Generate Network Address Report Priority Desired Trigger None Precondition IWOMS is loaded and at least one inventory record pertaining to

a networked computer/device must exist in the database. Basic Path 1. 1. The Primary User left-clicks on the Reports button


left-clicks on the Network Address button. 4. 4. IWOMS displays a properly formatted report

consisting of the following, if applicable: computer/device name, patch panel location and

number, switch/hub location and port number, and IP address in ascending order by computer/device name.





3.2.19 Generate Expired Warranty Report Use Case Name Generate Expired Warranty Report Priority Desired Trigger None Precondition IWOMS is loaded and at least one inventory record must exist in

the database. Basic Path 1. 1. The Primary User left-clicks on the Reports button


left-clicks on the Expired Warranty button. 4. 4. IWOMS displays a properly formatted report listing

each computer/device and its warranty expiration in ascending order by date and then by computer/device name.





3.2.20 Generate Hardware Specifications Report Use Case Name Generate Hardware Specifications Report Priority Desired Trigger None Precondition IWOMS is loaded and at least one inventory record must exist in

the database.

Basic Path 1. 1. The Primary User left-clicks on the Reports button on the IWOMS Main Menu.

2. 2. IWOMS displays the Reports Module window. 3. 3. In the Reports Module window, the Primary User

left-clicks on the Hardware Specifications button. 4. 4. IWOMS displays a properly formatted report

indicating the hardware specifications for each computer/device.





3.3 Detailed Non-Functional Requirements Hardware: The IWOMS client application must run on an IBM-Compatible Pentium-based PC. Operating System: Either Microsoft Windows 9x, NT 4.0, or 2000 Professional must be installed

on the client and Microsoft Windows NT Server 4.0 on the server. Software Needed: Microsoft Visual Basic 6.0 and Microsoft SQL Server 7.0 must be used to

develop and maintain this system. Software Standard: Any IWOMS functionality which can modify the database will have a cancel

option, where appropriate. If the user selects the cancel option, IWOMS will return the user to the previous form.

Network Interface: The IWOMS client application must have network connectivity in order to access the SQL Server database.

Appendix A: Sample User Interface Prototypes

A.1 IWOMS Main Menu

A.2 Work Orders Module Form

A.3 Work Order Form

A.4 Inventory Module Form

A.5 Inventory Record Form (Please note: The Inventory Record Component form is not displayed in this appendix because it is very similar to the form below.)

A.6 Reports Module Form

Index

Add Inventory Record, 11, 12, 34, 35 Add Inventory Record Component, 12, 35 Close Work Order, 9, 32 Copy Inventory Record, 19, 43 Create Work Order, 6, 29 Delete Inventory Record, 17, 18, 41, 42 Delete Inventory Record Component, 17, 41 Detailed Non-Functional Requirements, 3, 50 Edit Inventory Record, 14, 15, 37, 38 Edit Inventory Record Component, 15, 38 Edit Work Order, 10, 33 External Interface Requirements, 29 Functional Requirements, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,

23, 24, 25, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49 Functional Requirements Definition, 3, 6, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41,

42, 43, 44, 45, 46, 47, 48, 49 Generate Expired Warranty Report, 24, 48 Generate Hardware Specifications Report, 25, 49 Generate Library Hours Report, 21, 45 Generate Mileage Report, 22, 46 Generate Network Address Report, 23, 47 Generate Work Order Statistics Report, 20, 44 Glossary, 2 Introduction, 1 Inventory Module Form, 54 Inventory Record Form, 55 IWOMS Main Menu, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,

25, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51 Non-Functional Requirements, 3, 27 Overall Description, 4 Overview of Document, 3 Print Work Order, 8, 31 Purpose, 1 References, 3 Reports Module Form, 56 Requirements Specification, i, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21,

22, 23, 24, 25, 29 Sample User Interface Prototypes, 26, 51 Scope of Project, 1 System Environment, 3, 5 System Evolution, 3, 28 Transfer Inventory Record Component, 16, 40 User Interface Specification, 3, 26 View Inventory Record, 13, 36 View Work Order, 7, 30 Work Order Form, 53

Documents

Section 2 – Software Requirements · PDF fileInventory and Work Order Management System (IWOMS) Software Requirements Specification Peter C. Maroon December 1, 2000 Section 2 –