VistA Scheduling Enhancements (VSE)
Technical Manual
December 2019
Version 1.2
Department of Veterans Affairs
VSE Technical Manual i December 2019
Revision History
Date Version Description Author
12/06/2019 1.2 Additional edits requested; resubmitted AbleVets
12/03/2019 1.1 Client comments resolved; resubmitted AbleVets
12/18/2018 1.0 Update versioning AbleVets
04/26/2018 0.1 Initial draft of the artifact AbleVets
Artifact Rationale
A Technical Manual is a required end user document for all Office of Information & Technology
(OIT) software releases. The intended audience for this document is local IT support,
management, and development personnel for nationally released software. It provides sufficient
technical information about the software for developers and technical personnel to operate and
maintain the software with only minimal assistance from Product Support staff.
CLIN Satisfaction Statement
This document is submitted in satisfaction of CLIN 8001AY and CLIN 8001CS.
VSE Technical Manual ii December 2019
Table of Contents
1. Overview .............................................................................................. 1
1.1. Security ......................................................................................................... 1
1.2. Rules of Behavior ........................................................................................ 1
1.3. Orientation .................................................................................................... 1
2. GUI Implementation and Maintenance .............................................. 2
2.1. System Requirements ................................................................................. 2
2.2. Overview ....................................................................................................... 2
2.3. List of GUI Modules and Components Affected ...................................... 28
2.3.1. Common ........................................................................................................................... 28
2.3.1.1. User Controls ............................................................................................................... 29
2.3.1.1.1. IncrementalSearchComboBox ................................................................................ 29
2.3.1.1.2. DateTimePicker Control ........................................................................................... 30
2.3.2. Modules ............................................................................................................................ 33
2.3.2.1. CancelAppt ................................................................................................................... 33
2.3.2.2. ChangeDivision ............................................................................................................ 33
2.3.2.3. CheckIn ......................................................................................................................... 33
2.3.2.4. CheckOut ...................................................................................................................... 33
2.3.2.5. ContactAttempt ............................................................................................................ 33
2.3.2.6. DataAccess ................................................................................................................... 33
2.3.2.7. ExpandedEntry............................................................................................................. 33
2.3.2.8. FindAppt ....................................................................................................................... 33
2.3.2.9. Management ................................................................................................................. 33
2.3.2.10. MarkAsNoShow............................................................................................................ 33
2.3.2.11. Navigation ..................................................................................................................... 33
2.3.2.12. PatientAppt ................................................................................................................... 33
2.3.2.13. PatientSelection ........................................................................................................... 34
2.3.2.14. Prerequisites ................................................................................................................ 34
2.3.2.15. Reports ......................................................................................................................... 34
2.3.2.16. ResourceSelection ...................................................................................................... 34
2.3.2.17. Ribbon ........................................................................................................................... 34
2.3.2.18. Task ............................................................................................................................... 34
2.3.2.19. UserLogin ..................................................................................................................... 34
2.3.2.20. VAR ............................................................................................................................... 34
2.3.3. Unit Tests ......................................................................................................................... 34
2.3.4. ClinSchd ........................................................................................................................... 34
2.3.5. CreateWebServices ........................................................................................................ 35
VSE Technical Manual iii December 2019
2.3.6. InstallerCustomActions .................................................................................................. 35
2.3.7. ClinSchedInstaller ........................................................................................................... 35
2.3.8. VARMobileAppMockup .................................................................................................. 35
2.3.9. Web Services ................................................................................................................... 35
2.3.9.1. VSE_VAR_Client .......................................................................................................... 35
2.3.9.2. VSE_VAR_DataAccessService ................................................................................... 35
2.3.9.3. VSE_VAR_Service ....................................................................................................... 35
2.3.9.4. VSE_VAR_Service_Interfaces .................................................................................... 35
2.3.9.5. VSE_VAR_ServiceConsoleHost ................................................................................. 35
2.3.9.6. VSE_VAR_TestClient ................................................................................................... 35
2.4. Structure of Code Modules ....................................................................... 35
2.4.1. Module Project ................................................................................................................ 36
2.4.2. Module Class ................................................................................................................... 36
2.4.3. Controller Class .............................................................................................................. 37
2.4.4. Service Class ................................................................................................................... 38
2.5. Organization of Rational Streams ............................................................ 39
2.6. Troubleshooting Using the Trace Log ..................................................... 40
2.7. Configuring the GUI ................................................................................... 41
2.7.1. The Section ............................................................................................ 41
2.7.2. The Section .......................................... 42
2.7.3. Command Line Parameters ........................................................................................... 42
2.7.3.1. The /trace Command Line Parameter ........................................................................ 42
2.7.3.2. The /AutoDump Trace Command Line Parameter.................................................... 42
2.7.4. The Application Trace File ............................................................................................. 42
2.8. Client Application Dependencies and Files ............................................. 42
2.9. VS GUI Trace Log ...................................................................................... 45
2.10. Request Management ................................................................................ 48
2.11. Internal Relations ..............................
