Changes between Initial Version and Version 1 of ScriptBuilderSRS

Timestamp:

07/25/2017 02:46:27 PM (9 years ago)

Author:

jdalbey

Comment:

draft

ScriptBuilderSRS

@@ +1 @@
+**TMCSimulation Manager Enhancements**
+
+ 
+
+**ScriptBuilder Tool**
+
+**and**
+
+**InstructorElectronic Notebook**
+
+ 
+
+**Requirements,**
+
+**ConceptDevelopment, and **
+
+**Scope**
+
+**CaliforniaPolytechnic State University**
+
+**SanLuis Obispo, California**
+
+Table of Contents
+
+ Glossary       2
+
+\1. Script Builder Tool Requirements    4
+
+1.1 Incidents,          Scripts, and Timelines  4
+
+1.2 Script              Builder File I/O        5
+
+1.3 Support for         TMC Simulation Control  6
+
+1.4 Support for         Student Evaluation      7
+
+1.5 Supporting          Realism in Training     10
+
+1.6 Specifying          Expected Traffic Network Performance    11
+
+1.7 Instructor          Support 11
+
+1.8 Other               Training Goals  12
+
+\2. Instructor Electronic Notebook Requirements 13
+
+2.1 General             Requirements    13
+
+2.2 Simulation          Summary Window  14
+
+2.3 Simulation          Script Window   14
+
+2.4 CHP CAD             Terminal Window 15
+
+2.5 ATMS Display                Window  15
+
+2.6 Simulation          Area Reference Roadway Map Window       16
+
+# 
+
+# 1.Glossary
+
+ATMS    AdvancedTraffic Management System – a tool utilized within Caltrans
+
+CHPCAD  California Highway Patrol (CHP) Computer Aided Dispatch (CAD)
+
+CCTV    Closedcircuit television – used to monitor roadways remotely from a TMC.
+
+CMS     ChangeableMessage Sign
+
+ControlEvent    Control events cause the TMC Simulation Manager to performactions which affect the simulation environment as seen on thesimulation floor, e.g. modify the Paramics simulation, play an audioclip, send a message to CHP CAD, etc.  
+
+EvaluationEvent Evaluation events are used to prompt instructors to perform anevaluation action for students in training, e.g. grade their CMSmessage, phone response, etc.
+
+Event   Anoccurrence at a particular time of an incident. Control events andevaluation events are kinds of event.
+
+EventIcon       An image that represents an event. A/K/A Icon.
+
+Incident        Acomplete set of events associated with a specific incident numberwithin the TMC Simulator.  This ID number shall match the CHP CAD logidentifier. 
+
+Noise   Backgroundevents within a simulation which may not have a significant immediateeffect on traffic but require attention and resources from trafficmanagers working in the TMC.  Examples of noise are things like astalled vehicle on the shoulder, sprinklers spraying in the roadway,maintenance crews working on roadway instructure, etc.
+
+Icon    Animage that represents an event. A/K/A Event icon. 
+
+IncidentNumber  A number that identifies an incident. 
+
+IncidentName    A short name that is used to refer to an incident. 
+
+IncidentLine    A graphical line in the timeline. An incident line represents anincident.
+
+LCS     LaneClosure System – a tool used by Caltrans to manage lane closureswithin the highway system.
+
+Paramics        Atool which performs microscopic traffic simulation of the trafficnetwork.  Note that Paramics is planned for deprecation from the TMCsimulator.
+
+Script  AnXML file containing all details for all events within one or moreincidents.
+
+ScriptFile      A script saved to XML file in a format conformant with the*Simulation Manager & Script XML Schema*.
+
+Timeline        Agraphical display of a script.
+
+TrafficDot      A colored dot as displayed on the ATMS with green indicatingfree-flow traffic, yellow indicating moderate reductions inspeed/flow, and red indicating sever reductions in speed/flow.
+
+TMT     TrafficManagement Team 
+
+# 2.Script Builder Tool Requirements
+
+## 2.1Incidents,Scripts, and Timelines
+
+### Time-basedIncident Display
+
+The Script Builder shall allow the entry andmodification of scripts using a timeline. The timeline will show eachincident in the script as a line. Each event, represented by an icon,will be positioned on its corresponding incident's line.  Thisdisplay shall show all individual events within a script, e.g. CADdata population, radio traffic, instructor/student phone call, etc.,with icons for each type of event. 
+
+All time shall be displayed in hours, minutes, andseconds from the beginning of the timeline, e.g. the beginning of thescript.  The time into the incident and the script shall be displayedto the user as they move their cursor along an incident within thetimeline.
+
+Details of an event shall be displayed in afloating tooltip which appears when the user places their cursor overthe event's icon.  All details of an event shall be editable when theuser clicks on an event icon. 
+
+Color Coding of Incidents
+
+Each incident line shall be color-coded.  Thecolor of each incident line shall be selectable by the user. A colormay be shared by multiple lines. 
+
+Control Event and Evaluation Event Icons
+
+The Script Builder shall utilize distinct icons torepresent all events on the timeline.  The icons shall besufficiently small so that they can be displayed on the incidentlines in the timeline.  The icons shall be sufficiently distinctivefrom one another so that they may be easily differentiated from oneanother by the user.  Evaluation event icons shall be identical totheir corresponding control event icons, except that they will bedifferentiated by a unique feature such as an easily visible additionto the icon, e.g. a checkmark, a dot, etc.
+
+### MergingMultiple Scripts onto Timeline
+
+The Script Builder shall be capable of mergingmultiple independent scripts into a single timeline.  A user shall beable to select which incidents to include into the timeline atimport.  The start times of these incidents shall be selectable bythe user.     
+
+### Extracting a Script from the Timeline
+
+The Script Builder shall be capable of extractinga script from the timeline.     
+
+### IncidentDescription & Summary
+
+The Script Builder shall allow incidents to beentered. When an incident is entered, the user will enter informationregarding that incident. Incident information shall include incidentnumber, incident name, color of the incident's line, a description ofthe incident, the start time of the Incident, and the length of theincident.
+
+Event Entry
+
+The user shall be able to add events to anincident line by selecting the desired type of event using a buttonon the main GUI then placing the event to the desired location on thetimeline.  When the user places an event,  dialog boxes will appearto allow the user to enter information regarding the event.  The usershall be able to place events at any location on an incident line.
+
+Event Removal
+
+The user shall be able to remove events fromincidents, by right-clicking on the event's icon and selecting“remove” from a pop-up menu. The user shall be able to remove anevent by clicking on it and pressing the delete key.
+
+### PageNumbers on Scripts
+
+The Script Builder shall support the ability toput page numbers on generated script notebooks.
+
+## 2.2ScriptBuilder File I/O
+
+### 
+
+### Script File Format
+
+The Script Builder shall read from and savegenerated scripts to an XML file in conformance with the standard asdetailed in the *Simulation Manager & Script XML Schema.*
+
+### Openingan existing Script File
+
+The Script Builder shall allow the user to open ascript using standard Windows controls such as a pull-down menu (File-> Open) and/or an icon. 
+
+### Savinga Script File
+
+The Script Builder shall allow the user to save anscript to file with a name of their choice or save changes to anexisting script using standard Windows controls such as  pull-downmenus (File->Save and File->Save As) and/or an icon.
+
+## 2.3Supportfor TMC Simulation Control
+
+Simulation Control Events - General
+
+The Script Builder shall allow for insertion ofcontrol events which drive TMC simulator systems, including theParamics traffic simulator, the CHP CAD simulator, the TMC SimulatorAudio System, the Activity Log, and the TMC Simulator CCTV videoplayback system. When the user adds a control event, a dialog boxshall be presented to the user allowing entry of details regardingthe added event. The details regarding the added event are specifiedby the XML element corresponding to the added event. These XMLelements are found in the *TMC Simulator XML Script Schema*. 
+
+### ParamicsControl Event
+
+The Script shall allow for the entry of Paramicscontrol events. Paramics control events allow modification ofParamics simulation parameters to create incidents, remove incidents,etc.  
+
+ATMS Driver Control Events
+
+The Script Builder shall allow for control of theATMS back-end directly, bypassing Paramics.  Script Builder controlshall provide the ability to initialize the ATMS from a traffic flowperspective and then create trends, e.g. traffic dots changing fromto green to yellow to red as necessitated by the script.
+
+### CHPCAD Control Event
+
+The Script Builder shall allow for the entry ofCHP CAD control events.  CHP CAD Control Events allow automatedentries and hence automatic population of the data into the TMCSimulator CHP CAD database, as if it were typed by a CHP Dispatcher.
+
+Activity Log Control Event
+
+The Script Builder shall allow for the entry ofActivity Log control events.  Activity Log control events allowautomated entries and hence automatic population of the TMC SimulatorActivity Log, as if it were entered by TMC operators.   
+
+CCTV Control Event
+
+The Script Builder shall allow for the entry ofCCTV control events.  CCTV control events allow direct control of TMCSimulator DVD players to play incident video, resume normaloperations, etc.
+
+CHP Radio, Caltrans Radio, TMT Radio ControlEvent 
+
+The Script Builder shall allow for the entry ofradio control events.  Radio control events  can be CHP, Caltrans, orTMT Events. The Script Builder will be able to generate a printable“voice-actor script” to support the recording of the radiotraffic based upon the radio Event. The “voice-actor script” willinclude the following: the specific words to be read by the voiceactor, including call numbers, etc., the file name that the voicerecording should be saved as, any special instructions to theactor(s), and actor identifier to ensure that all recordings for agiven role in the field are made by the same person.
+
+Tow Truck Control Event
+
+The Script Builder shall allow for the entry ofTow Truck Control Events.   Tow Truck control events allow tows to beadded to the CHP CAD log. 
+
+Unit Control
+Event
+
+The Script Builder shall allow for the entry ofUnit Control Events.  Unit Control Events allow CHP units to bedispatched on the CHP CAD.
+
+Witness Control Event
+
+The Script Builder shall allow for the entry ofWitness Control Events.  Witness Control Events allow witness reportsto be added to the CHP CAD log.
+
+Telephone Call
+Control Event
+
+The Script Builder shall allow for the entry ofTelephone control events.  Telephone Call control events allow thegeneration of “voice scripts” to be included in the instructor’snotebook which allow the instructor to make relevant telephone calls,e.g. radio reporter, Caltrans headquarters, etc. into the TMC atappropriate times during a simulation.
+
+## 2.4Supportfor Student Evaluation
+
+### DecisionTree Support
+
+The Script Builder shall support the concept of adecision tree for script that it is used to build.  Thecontent/structure of the decision tree will be developed inconjunction with the development of the script while using the ScriptBuilder, allowing the team designing the new script to articulatewhat preferred decisions to be made by the students in the simulatorare.   It is anticipated that information such as this decision treewill provide some of the basis for a future trainee scoring scheme. Note that this section required further fleshing out.
+
+### Supportfor Instructor Electronic Notebooks
+
+The Script Builder output shall support the use ofelectronic script notebooks, allowing the existing instructornotebooks to be replaced with electronic versions running on a devicesuch as an iPad, tablet computer, etc.  All files required foroperation of the Instructors Electronic Notebook shall be generatedby the Script Builder.
+
+### TrafficNetwork Scoring
+
+The Script Builder shall support trainee scoringaggregated by highway, direction, time, and speed.  (not sure aboutthe speed here) The end result of such a scheme is that performancewill be scored based on the activity in the traffic network, henceindirectly scoring trainee actions as these actions will affect thetraffic network score. 
+
+### Assignmentof Scoring Metrics to Specific Instructors
+
+The Script Builder shall support the generation ofa script notebook with evaluation events and other evaluation metricsassigned to specific instructors. Other evaluation metrics includesitems to score such as CMS signs, HAR messages, queue protection,etc.
+
+### AssociateScore with Feedback
+
+The Script Builder shall support the ability toassociate a quantitative score assigned to trainees with feedback,e.g. “Here is your score, here is what you did do correctly, andhere is what you did not do”
+
+### Debriefby Position
+
+The Script Builder shall support the ability todebrief students at the end of a training session by position, e.g.CHP CAD, ATMS, Maintenance Radio, PIO, MIO, Facilitator, etc.
+
+Aggregate TMC Operator Functions 
+
+The Script Builder shall support the ability toaggregate multiple TMC operator functions into a individualpositions, allowing the TMC simulator to be run with a smaller groupof trainees on the floor.  All scoring, trainee debriefingfunctionality, etc. shall be aggregated so that scoring options arecoherent with position aggregation, which will be set via GUIcontrols. 
+
+Student Evaluation Events – General
+
+The Script Builder shall allow for insertion ofEvaluation Events which allow instructors to quantitatively andqualitatively measure the performance of student trainees in the TMCSimulator.  These Evaluation Events create points in the TMCSimulator instructor notebooks, which can either be printed orelectronic, where instructors will be prompted to evaluate studentperformance in their use of any TMC Simulator system.  Instructorevaluations will be a quantified numerical rating, such as a scalefrom 1 to 5, and a written qualitative rating where the instructorcan give direct commentary regarding student performance.   Specificmeasures of performance available for each event are articulatedwithin the** ***TMC Simulator XML Script Schema*. Eachcriteria to evaluate each Evaluation Event is specified in the** ***TMCSimulator XML Script Schema*.
+
+ATMS Utilization
+Student Performance Evaluation Event
+
+The Script Builder shallallow for instructors to evaluate student use of the ATMS.   ATMSevaluation events allow instructors to determine how effectivelystudents utilized the ATMS to interpret traffic conditions, set CMSmessages, etc.
+
+Activity Log
+Utilization Student Performance Evaluation Event
+
+The Script Builder shallallow for instructors to evaluate student use of the Activity Log.
+
+CHP CAD
+Utilization Student Performance Evaluation Event
+
+The Script Builder shallallow for instructors to evaluate student use of the CHP CAD.
+
+Such a system might utilize modifications of theSimulator CHP CAD system to allow it to report back when and what CADlogs were utilized to determine if the trainees utilized CHP CAD tothe maximum extent possible.  These features would seek to understandif students responded properly to CHP CAD messages.  Was theirresponse delayed? Were they prompted? Was their response correct?
+
+CMS Utilization
+Student Performance Evaluation Event
+
+The Script Builder shallallow for instructors to evaluate student use of Changeable MessageSigns.
+
+Facilitator
+Student Performance Evaluation Event
+
+The Script Builder shallallow for instructors to evaluate student performance as aFacilitator.
+
+Caltrans Radio, TMTRadio, TMT Radio Utilization Student Performance Evaluation Event
+
+The Script Builder shallallow for instructors to evaluate student use of the each of theradio systems available to them.
+
+CCTV Utilization
+Student Performance Evaluation Event
+
+The Script Builder shallallow for instructors to evaluate student use of the TMC SimulatorCCTV camera selection and viewing capabilities.   These evaluationevents would allow instructors to document how trainees utilizedavailable CCTV imagery as part of their verification of a reportedincident.  
+
+Telephone UtilizationStudent Performance Event
+
+The Script Builder shallallow for instructors to evaluate student use of the telephone.Telephone evaluation events shall allow instructors to determine ifstudents have provided them complete answers to their phone calls,including information such as callback numbers, number of lanesclosed, fatalities, etc.
+
+### 
+
+### Sigalerts
+
+The Script Builder shall allow for instructors toevaluate student use of SigAlerts as appropriate to the simulationenvironment.
+
+## 2.5SupportingRealism in Training
+
+### BackgroundNoise
+
+The Script Builder shall allow background noise tobe added to a script.  Background noise will not be attached to anincident.  It enhances the realism of the simulation by addingunimportant and unrelated events.  Background noise shall includemaintenance radio chatter audio clips, lane closures, TMCAL logs,etc.  Specific background noise events will include animals in theroadway, a wild sprinkler on the freeway, a vehicle with a flat tire,etc.
+
+### AutomaticGeneration of Organization Chart for Training District (D14 – SantaLucia)
+
+The Script Builder shall support the automaticgeneration of an organizational chart which will be used by bothstudents and instructors in the back room and be coherent with allevents in the generated instructor scripts.
+
+### Injectionof Minor Incidents
+
+The Script Builder shall support the automaticgeneration of secondary incidents if queue protection is notimplemented by trainees as appropriate.  This requirement impliesthat the Script Builder can encode for and the Simulation Managershall be capable of dynamically adding an incident during asimulation.
+
+### MinorIncidents
+
+The Script Builder shall be capable of generatinga false incident which students will discover is such when theattempt to user available verification tools.   Potential steps toimplement a false incident are: 1.) start a log entry 2.) dispatch aunit 3.) survey area with surveillance tools, ATMS, etc.  4.)discover the incident does not exist.    Comment 
+
+## 2.6SpecifyingExpected Traffic Network Performance
+
+### DeterminingQueue Length
+
+The Script Builder shall allow the desired queuelength for an incident to be specified.  Potential methods toaccomplish this feature are yet to be determined.  Please note thatthis is related to the ATMS Driver and the control it asserts uponthe ATMS.
+
+## 2.7InstructorSupport
+
+### Assignmentof Reporter Roles to Specific Instructors
+
+The Script Builder shall allow reporter roles tobe assigned to individual instructors.
+
+### ColorCoding Instructor Manuals
+
+The Script Builder shall support showinginstructor roles in the instructor manuals using a unique identifiersuch as color.
+
+## 2.8OtherTraining Goals
+
+### DedicatedCHP CAD Training
+
+The Script Builder shall be capable of supportingthe development of CAD scripts, which the Simulation Manager can useto populate the CAD for the purpose of CAD specific training.
+
+### EOCTraining
+
+The Script Builder shall support EOC training.
+
+### Trainingfor TMC & District Management
+
+The Script Builder shall support the developmentof training scenarios customized to TMC and District Management.
+
+### GeneralizedTransportation Training
+
+The Script Builder shall support the developmentof training scripts related to other modes of transportation, e.g.buses, trains, etc.
+
+# 3.ATMS Driver
+
+## 3.1General Requirements
+
+### Control of the ATMS
+
+The ATMS Driver shall allow direct control trafficspeed data into the ATMS.
+
+### Interface Description
+
+The ATMS Driver shall control the ATMS based onthe yet to be obtained interface descriptions from Caltrans.
+
+### Simulation Manager Interface
+
+The ATMS Driver shall receive all control from theSimulation Manager
+
+### Traffic Modeling Capability
+
+Do we want the ATMS Driver to have some trafficmodeling capability or should all control come from the SimulationManager?  Maybe we want to have the simulation manager give itcommands for a section of roadway such as: initiate free-flow trafficon roadway segment x, begin backing up traffic at rate y on roadwaysegment z, etc.?
+
+ 
+
+# 4.Instructor Electronic Notebook Requirements
+
+## 4.1GeneralRequirements
+
+Information Displays
+
+The Instructor Electronic Notebook shall havedisplays of a simulation summary, the simulation script as it isprogressing, a TMC Simulator CHP CAD terminal, an ATMS display, and anavigable roadway map, e.g. Mapquest, Google Maps, etc.
+
+The Instructor Electronic Notebook shall displaythe current simulation time in hours, minutes, and seconds on aprominent clock which is always visible.
+
+Touch Screen Display
+
+The Instructor Electronic Notebook shall utilize atouch-screen display allowing user interaction  via finger touch,stylus, etc. as is appropriate to the platform selected.
+
+Instructor Login and Simulator Operation Duties
+
+The Instructor Electronic Notebook shallautomatically synchronize to the script that the TMC SimulationManager is running.
+
+The Instructor Electronic Notebook shall allow theoperator to log in as a specific instructor, binding them topre-determined TMC Simulation support roles and evaluationresponsibilities.
+
+Indoor Operation
+
+The Instructor Electronic Notebook shall bereadable and useable in all indoor lighting conditions.
+
+Keyboard and Voice Input
+
+The Instructor Electronic Notebook shall allowkeyboard input, either through an actual keyboard or an electronicscreen-based keyboard.
+
+The Instructor Electronic Notebook shall allowinstructors to record voice messages during a simulation viaindividual microphones for the purposes capturing qualitativefeedback.  
+
+The Instructor Electronic Notebook shall becapable of automatically performing voice recognition functions forrecorded instructor qualitative feedback.  Comment 
+
+Battery Powered Operation
+
+The Instructor Electronic Notebook shall becapable of battery powered operation for periods of at least eighthours.
+
+Finger Size Accessibility
+
+The Instructor Electronic Notebook shallaccommodate a variety of finger sizes for instructor input of dataand navigation between displays/windows.  Small and large fingersshall work equally well for making GUI selections.
+
+## 4.2SimulationSummary Window
+
+Listing of Incidents
+
+The Instructor Electronic Notebook shall provide alisting of all incidents in the script that is running at the presenttime on the Simulation Manager.
+
+Incident Information Displayed
+
+The Instructor Electronic Notebook shall the timethe incident starts, the incident number, the name of the incident,and the description of the incident.  Incident summaries shall beable to be collapsed and expanded with simple GUI controls.
+
+## 4.3SimulationScript Window
+
+Display and Highlighting of Events on RunningScript Window
+
+The Instructor Electronic Notebook shall displaythe events in the script. Each event shall be displayed within aclearly delineated boundary. Using simple GUI controls, the usershall be able to collapse and expand any event. The current eventshall be highlighted with a colored header bar. 
+
+The Instructor Electronic Notebook shall allow theall the events belonging an incident in the script window to becollapsed or expanded using simple GUI controls.
+
+Student Evaluations Performed by Instructor
+
+The Instructor Electronic Notebook shallautomatically prompt the user with pop-up windows for quantitativeand qualitative student evaluations which are currently required bythe instructor logged into the given Instructor Electronic Notebook. Instructors shall only be shown pop-up windows that are applicable tothem.
+
+The Instructor Electronic Notebook shall allow theinstructor to enter quantitative scoring, e.g. on a scale of 1 to 5,with simple one-touch GUI actions.
+
+The Instructor Electronic Notebook shall allow theinstructor to enter qualitative text via a keyboard. 
+
+Jumping to Different Simulation Times in theDisplay
+
+The Instructor Electronic Notebook shall allow theuser to jump directly to the current event using a one-touch GUIaction.
+
+The Instructor Electronic Notebook shall allow theuser to jump directly to a specified time as inputted by the user. 
+
+## 4.4CHPCAD Terminal Window
+
+Standard Functionality
+
+The Instructor Electronic Notebook shall provide aCHP CAD terminal with functionality similar to that of the “standard”TMC Simulator CHP CAD terminal.  
+
+The Instructor Electronic Notebook hall allow theinstructor to view all CHP CAD entries made by students.
+
+The Instructor Electronic Notebook shall allow theinstructor to make CHP CAD entries during a simulation. 
+
+The Instructor Electronic Notebook shallautomatically update as CHP CAD entries are made within the TMCsimulation environment.
+
+Flexibility in CHP CAD Control Implementation
+
+The Instructor Electronic Notebook may utilizedifferent CHP CAD controls than those used by the “standard” CHPCAD window as required by the limitations and capabilities of thespecific device used for the Instructor Electronic Notebook.
+
+## 4.5ATMSDisplay Window
+
+Display Simulation Roadway Area
+
+The Instructor Electronic Notebook shall providean ATMS display window which allows instructors to see vehicledetector status of roadways in the simulation area.
+
+Limited ATMS Functionality
+
+The Instructor Electronic Notebook ATMS displayshall not be zoomable.
+
+The Instructor Electronic Notebook shall not allowcontrol of various field devices, e.g. CMS, CCTV.
+
+## 4.6SimulationArea Reference Roadway Map Window
+
+The Instructor Electronic Notebook shall provide aroadway map with incidents from the simulation area clearly markedfor instructor reference.
+
+Limited Functionality
+
+The Instructor Electronic Notebook shall not bezoomable.