Changes between Initial Version and Version 1 of LCS_specification

Timestamp:

03/08/2020 03:05:33 PM (6 years ago)

Author:

jdalbey

Comment:

v0

LCS_specification

@@ +1 @@
+= Lane Closure System Simulator =
+== Functional Specification ==
+The LCS Simulator is intended to provide TMC Academy students practice at creating an emergency lane closure and documenting changes to the status of a lane closure and notifying the responsible person.  In the real-world LCS, creating a lane closure creates new icons on !QuickMap.
+
+This document will reference the User Interface Prototype extensively.
+
+ 1. Login
+
+The login page has a single text field for the user to enter their username and a Submit button.  The submit button validates that the text field is not empty and then opens the Home page.
+
+ 2. Home
+
+The home page displays message of the day (static fields).   There are only two actions that can be taken from here: Search or Request.
+
+ 3. Request
+
+A new lane closure is created by submitting a request form.  The fields in this form are shown in the UI Prototype. Required fields are marked with an asterisk. Upon submittal the system generates a new closureID and displays a popup dialog with an acknowledgement and the form is reset.
+
+The new closure ID is created in the following format: The uppercase letter "T" (indicating temporary/emergency closure), followed by the highway (route) number, followed by a two letter sequence code that starts with "AA".  A log number is also required, a sequential integer starting at 1.  TBD: ''There needs to be some field in the form for the user to specify that they want a NEW closure (and thus log number = 1) versus an existing closure, in which case the next sequential log number is assigned. ''
+
+ 4. Search
+
+The user will usually be provided a closure ID from someone in the field who calls in a request to update a closure.  If only the closure ID is provided for the search, it should return all associated log numbers.  If both closure ID and log number are provided, return just that specific item.
+
+Any combination of criteria can be provided, include just a start date or just an end date.
+
+ 5. Search Results
+
+The results page lists the closures that match the supplied search criteria. The Radio Call number is not part of the initial Request.  A separate static lookup table is referenced to find the supervisor name and their radio call number.  The "Limits" column is the begin and end location.  "Work Description" is the Type of Work field. To view details, one or more checkboxes may be selected from left column, then click Status History or Status Form to see the corresponding details.
+
+ 6. Status Form
+
+When the Status Form button is clicked, the search results are elaborated with an extra column that contains a form to update the status of the closure. When the Submit Status Form button is clicked, the closure info is updated with the data from the status form, an acknowledgement message is displayed, and the Search Results page is displayed. (Need clarification: does the user need to check the checkbox for desired items to be updated?)
+
+ 7. Status History
+
+A display of the status history for one or more selected closures.  The status history has one to three rows, for possible events 1097, 1022, and 1098. REQ DATE is the start/end time of the original request.  STATUS DATE is the time when the a status update happened (obtained from the status form above).  USER is the value from the "Field Statuser" field of the status form.
+
+== Data Dictionary ==
+All fields in this dictionary are strings, since there are no arithmetic computations required.
+
+closureid - a unique identifier for each closure, format described above.
+
+lognum - a subordinate sequence number.
+
+route - highway number
+
+direction - traffic direction, see options in combobox.
+
+facility - what part of the roadway is affected, see options in combobox. 
+
+startdate - calendar date when the closure will begin. The user enters MMDDYYYY but the value stored in the database must be YYYYMMDD. 
+
+enddate - calendar date when the closure ends. The user enters MMDDYYYY but the value stored in the database must be YYYYMMDD. 
+
+starttime - time of day on the start date when the closure begins.  Format: HHMM (military time) 
+
+endtime - time of day on the end date when the closure ends.  Format: HHMM (military time) 
+
+startcounty - County in which the closure starts.  For now, Orange county is the only option. 
+
+endcounty - County in which the closure ends.  For now, Orange county is the only option. 
+
+startlocation - Cross street used to identify location of the closure.  The options in the drop down are obtained from the postmile book.  It would be nice if the drop down was smart enough to only display cross streets on the selected route. 
+
+endlocation - same as above. closuretype - see options in combobox.
+
+worktype - see options in combobox. 
+
+estdelay - estimated number of minutes of delay caused by the closure. (How long drivers have to wait). 
+
+tmpcozeep - yes or no 
+
+tmpdetour - yes or no 
+
+supervisor - see options in combobox.  obtained from callout map. 
+
+fieldrep - same as above. 
+
+meetingplace - optional, free format field. 
+
+reason - optional, free format field. 
+
+remarks - optional, free format field.
+
+  The remaining fields are for values from the status form.
+
+s1097date  s1097time s1097user s1097phone s1098date s1098time s1098user s1098phone s1022date s1022time s1022user s1022phone