This has module specifications in the lower half of this page.
Requirements Specification Report
ISQS 4348-001
Team 2
Jeanie French
Jeremy Jones
Leigh Ann Palmore
Chris Rollins
Gilbert Travis
October 3, 1999
Introduction:
The current system for requesting work orders at the Physical Plant
is a manual system that requires a lot of man-hour time. The current system
is not secure because request are received via phone call, Techmail, or
personal delivery. Currently, over 40% of the phone calls received are
for routine requests as opposed to emergency requests. The following
strategic and tactical requirements will follow:
Requirements:
1. The new system will cut phone calls to work control in the Physical
Plant by 40%.
We will implement a new automated system that handles the routine work
order entry processing via a web-based system by May 2000.
We will train work order coordinators how to submit the work order
request through the web application.
We will train work control operators how to review and handle the submissions.
2. The new system will eliminate submissions through the Techmail. System.
All paper mail will be turned into e-mail. The new system allows record
of correspondence between work order coordinator and Physical Plant operator.
Require work order coordinators to submit routine work order request
through the web application.
3. The new system will increase customer satisfaction by 50%.
The system will cut average turn-around from three days to two days.
The system will allow the users to view the status of the work order
through a web interface.
The system will send a confirmation number via e-mail to the work order
coordinator.
4. The system will reduce errors to less than 10% of work orders.
The system will require a work order coordinator to login to the system.
A work order coordinator will only be able to request work orders for
their authorized buildings.
A call back phone number will be required to clarify errors.
Summary:
After fulfilling the above requirements, we are confident that customer
satisfaction will be improved, erroneous work orders will be reduced, cut
back phone calls, and eliminate submissions through Techmail.
CONTROL MODULES
MODULE: Requested Record Screen TYPE: Control
FUNCTIONS:
Call retrieve selected WO Request Record (WO Record Request Selection,
MRF data)
Call display selected WO Request Record (MRF data)
Call get button selection (button selection)
CASE
Edit: Edit selected WO Request Record (MRF data)
Call display edit WO Request Record Screen
(MRF data)
Call get edit button selection
CASE
Exit: Call Exit edit selected WO Request Record
Process: Call Process WO Request changes (MRF data)
Call get WO Request changes (MRF data)
Call verify WO Request data (MRF data, verify flag)
IF verify flag= true
Call save WO Request changes (MRF
data)
Create: Call create work order (MRF
data)
END CASE
Create: Call create work order (MRF data)
Call display create WO screen (MRF data)
Call verify WO Information (MRF data, WO verified
flag)
IF WO verified flag = true
Call send WO Information to 4-site
END CASE
END FUNCTION
END OF MODULE
MODULE: Maintenance Request Form (MRF) TYPE: Control
FUNCTIONS:
Process Maintenance Request Form ()
Call display MRF screen
Call receive MRF Data (MRF data)
Call submit MRF Data (MRF data)
END FUNCTION Process Maintenance Request Form
END OF MODULE
MODULE: Work Order System TYPE: Control
FUNCTIONS:
Process Web System ()
Call display logon screen
Call receive logon data (logon data)
Call verify logon data (logon data, valid logon flag)
Call process Maintenance Request Form
END FUNCTION Process Web System
Process WO Request ()
Call process WO Request controller screen
Call get WO Request record selection
Call process requested record screen
END FUNCTION Process WO Request
END OF MODULE
MODULE: Work Order TYPE: Control
FUNCTIONS:
Call Display Create WO Screen
Call Verify WO Information
If verified = true Then
Call Send WO Information to 4-site
END OF MODULE
MODULE: Work Order Request TYPE: Control
FUNCTIONS:
Call Process WO Request Controller Screen
Call Get WO Request Record Selection
Call Process Requested Record Screen
END OF MODULE
SCREEN MODULES
MODULE: Create Work Order Screen TYPE: Definition
Data Structure
See U.I.D.
Screen name Create Work Order Screen
End Data Structure
Functions
Write Create Work Order Screen (MRF Data)
SQL Statement
Select all from WO_Request_Screen Where Request # = Request
#
End SQL Statement
Write SQL output to screen map
Write screen
End Functions
End Module
MODULE: Logon Screen TYPE: Definition
Data Structure
See U.I.D.
Screen name Logon Screen
End Data Structure
Functions
Write blank logon screen()
write screen
END FUNCTION
END OF MODULE
MODULE: MRF Screen TYPE: Definition
Data Structure
See U.I.D.
Screen name Work Order Request Screen
End Data Structure
Functions
Write blank MRF Screen()
write screen
END FUNCTION
END OF MODULE
MODULE: WO Request Selection Screen TYPE: Definition
Data Structure
See U.I.D.
Screen name WO Request Selection Screen
End Data Structure
Functions
Write WO Request Selection Screen (WO Request Table)
SQL Statements
Select Request #, Date-Submitted, Contact-Name
From WO_Request_table
End SQL Statements
Write screen
Write SQL output to screen //non-editable
END FUNCTION
END OF MODULE
MODULE: Edit WO Request Screen TYPE: Definition
Data Structure
See U.I.D.
Screen name Edit WO Request Screen
End Data Structure
Functions
Write Edit WO Request Screen (MRF Data)
SQL Statement
Select all from WO_Request_Screen Where Request # = Request
#
End SQL Statement
Write Screen
Write SQL output to screen //editable
END FUNCTION
END OF MODULE
MODULE: Selected WO Request Screen TYPE: Defintion
Data Structure
See U.I.D.
Screen name Selected WO Request Screen
End Data Structure
Functions
Write Selected WO Request Screen (MRF Data)
SQL Statement
Select all from WO_Request_Screen Where Request # = Request
#
End SQL Statement
Write Screen
Write SQL output to screen //non-editable
END FUNCTION
END OF MODULE
DEFINITION MODULES
MODULE: MRF Data TYPE: Definition
DATA STRUCTURE:
MRF data: Request # type: numeric (system-filled)
Contact name type: string
Phone # type: string
Room # type: string
Email address type: string
Account type: string
Building type: string
Description of Problem type: string
END DATA STRUCTURE
FUNCTIONS:
Process Maintenance Request Form ()
Display MRF screen
1+ last Request # write to Request #
write blank MRF screen to monitor
get MRF data (MRF data)
read MRF screen to WO Request Record
validate MRF data (MRF data, valid MRF flag)
set valid-MRF-flag to notvalid
if all fields = not null then
set valid-MRF-flag to valid
IF valid MRF flag = valid
confirm MRF data (MRF data, confirmation #)
read MRF-data from user screen to WO Request
Record
confirmation number = last assigned confirmation
number + 1
display confirmation number screen
write confirmation number to confirmation
screen
write MRF data to confirmation screen
write confirmation number screen to monitor
END FUNCTION
END OF MODULE
MODULE: Logon Data TYPE: Definition
DATA STRUCTURE:
Logon data: Username type: string
Password type: string
END DATA STRUCTURE
FUNCTIONS:
Process get logon ()
Call display logon screen
receive logon data (logon data)
read logon data from logon screen
verify logon data (logon data, valid logon flag)
Valid logon flag = cleared
IF username and password = valid
THEN set valid logon flag = valid
IF valid logon flag = valid then
Call process Maintenance Request Form
END FUNCTION
END OF MODULE
MODULE: Button Selection TYPE: Definition
DATA STRUCTURE:
Button: button_choice type:
integer
END DATA STRUCTURE
FUNCTIONS:
Get Button Selection (button_choice)
Return button_choice
END FUNCTION
END OF MODULE
MODULE: Selected WO Record
DATA STRUCTURE:
WO Request Record Selection: wo_req_id type: string
MRF data: Request # type: numeric (system-filled)
Contact name type: string
Phone # type: string
Room # type: string
Email address type: string
Account type: string
Building type: string
Description of Problem type: string
END DATA STRUCTURE
FUNCTIONS:
Retrieve selected WO record (WO request record selection, MRF
data)
Return MRF data where no_req_id = WO request record selection
Display selected WO record (MRF data)
Write MRF data to screen
Edit selected WO record (MRF data)
Call display edit WO request record screen (MRF data)
Call get edit button selection (button selection
CASE of button selection type
EXIT: Exit selected WO request record
Transfer control to process WO request
PROCESS: Process WO request changes (MRF data)
Call get WO request record changes (MRF data)
Call verify WO data (MRF data, verified flag)
Call save WO request changes (MRF data)
CREATE: Create work order (MRF data)
END FUNCTION
END OF MODULE
MODULE: Work Order Data TYPE: Definition
DATA STRUCTURE:
MRF data: Request # type: numeric (system-filled)
Contact name type: string
Phone # type: string
Room # type: string
Email address type: string
Account type: string
Building type: string
Description of Problem type: string
Verify: Verified flag type: boolean
END DATA STRUCTURE
FUNCTIONS:
Verify WO request data (MRF data, verified flag)
IF all fields = not null then
Call save WO request changes
END FUNCTION
END OF MODULE
MODULE: Work Order Request Changes TYPE: Definition
DATA STRUCTURE:
MRF data: Request # type: numeric (system-filled)
Contact name type: string
Phone # type: string
Room # type: string
Email address type: string
Account type: string
Building type: string
Description of Problem type: string
Verified flag type: Boolean
END DATA STRUCTURE
FUNCTIONS:
Process work order request changes (MRF data)
Call get WO request changes (MRF data)
Read screen
Return MRF data changes
Call verify WO request data (MRF data, verified flag)
IF verified flag= true then
Call save WO request changes (MRF data)
ELSE
Return control process WO request changes
END FUNCTION
END OF MODULE
MODULE: Work Order Information TYPE: definition
DATA STRUCTURE:
Request # type: numeric (system-filled)
Contact name type: string
Phone # type: string
Room # type: string
Email address type: string
Account type: string
Building type: string
Description of Problem type: string
internal_valid_flag type: Boolean
END DATA STRUCTURE
FUNCTIONS:
Verify Work Order Information (Work Order Information)
Set internal_valid_flag to false
<<Begin nested if testing for content match>>
If Contact name = null then
Set internal_valid_flag to false
ELSE
IF <<test all fields>> = null then
Set internal_valid_flag to false
ELSE
Set internal_valid_flag to true
<<END nested if testing for content match>>
SELECT from authority_table
Where: User=requester, account_code=account, building_code=building
If (matches found) then
Set internal_valid_flag to true
Send Work Order Information to 4-site (Work
Order Information)
ADD Work Order Information to 4-site Database
END FUNCTION
END OF MODULE
MODULE: Edit Button Selection TYPE: definition
DATA STRUCTURE:
Exit_Button type: boolean
Process_Changes_Button type: boolean
Create_Work_Order_Button type: boolean
END DATA STRUCTURE
FUNCTIONS:
Get Edit Button Selection (edit_button_selection)
Edit_button_selection = “exit”
If (Exit_Button == true)
Then edit_button_selection = “exit”;
If (Process_Changes_Button == true)
Then edit_button_selection = “process”;
If (Create_Work_Order_Button == true)
Then edit_button_selection = “create”;
END FUNCTION
END OF MODULE