Name	Value
NAME	VDEF
PREFIX	VDEF
CURRENT VERSION	1.0
SHORT DESCRIPTION	VISTA Data Extraction Framework
VERSION	1.0 DATE DISTRIBUTED: 2012-05-04 00:00:00 PATCH APPLICATION HISTORY: 3 SEQ #1 DATE APPLIED: 2006-02-13 00:00:00 APPLIED BY: USER,ONE DESCRIPTION: PLEASE READ THE ENTIRE DESCRIPTION AND INSTALLATION INSTRUCTIONS status and the fact that the count stopped at ">100". - The counter for Queued Up has been changed to display the actual number up to a maximum of 1000. If more than 1000 are queued up, the display will show "> 1000". - The description "Requests in the queue" has been changed to "Requests waiting for purge" (example) Request Processor Status MAINTENANCE: Running and not Scheduled 1) Adds the name of the Request Queue to the VDEF Alert message. Current Task # [Proc]: 7399750 [21663B42] Requests waiting for purge: 14 Last request#: 14 Checked Out(0) Queued Up(0) Errored Out(0) 9) Changed the M lock used to protect the VDEF Request Queue so that it doesn't prevent using FileMan to access the VDEF queue file. 10) Creates the new Application "VDEF ALERTS" and the new Mail Group "VDEF NATIONAL ALERTS" and changes the VistA Mail Group for VDEF Alerts from the HL7 group to the new VDEF group. 11) Removed the Scheduled task from the Status of VDEF components [VDEF Status] display and added the TaskMan status of the task. 12) Removed the XQASUPV variable from the alert call so that VDEF alerts are no longer forwarded to unread alerts supervisor mail group. 13) Added the date and time and the TaskMan task status to the VDEF Status display. 2) Eliminates false VDEF Alerts. IRM NOTES: =========== Before installing this patch, make sure you have completely installed XU8.0339 and run the '% program' conversion RELOAD^ZTMGRSET utility. This patch REQUIRES Kernel patch XU8.0339 which fixes a bug in the $$ASKSTOP^%ZTLOAD() API and also creates a new API JOB^%ZTLOAD(). VDEF requires both of these to be updated by the XU8.0339 patch in Order for VDEF13 to install. This VDEF patch uses the $$JOB^%ZTLOAD functionality released with XU8399. Please confirm that the post-KIDS install steps for XU8399 have been done. The following MUMPS code should indicate that XU8399 is in the second line of the %ZTLOAD routine: >ZL %ZTLOAD ZP +1:+2 For the duration of the installation of this patch, all VDEF Request Queue processors that were in the Running state will be temporarily 3) Eliminates the problem of VDEF Request Queue processor not being suspended. The pre-install and post-install routines will suspend and then restart all Request Queue processors that were in the Running state after installation of this patch. VDEF messages will continue to accumulate in the queues during suspension and will start processing again after the patch has completed installation. This is the equivalent of you using the VDEF Configuration and Status Menu option "SusR Suspend/Run Request Queue" to suspend and restart the Request Queues. When you see the message "Waiting for processes to quit . .", there will be approximately a 5 second wait. restarted by TaskMan. PLEASE NOTE: The VDEF Post-install program will not start the VDEF processes on test or Legacy systems that have the Test System flag set. IRM'S POST-INSTALLATION REQUIREMENTS ==================================== 1. NEW MAIL GROUP AND APPLICATION FOR VDEF ALERTS After you have installed this patch, there will be a new Application named VDEF ALERTS which will have the Mail Group VDEF NATIONAL ALERTS assigned to it. The new Mail Group will not have any local members in it. YOU MUST ASSIGN THE LOCAL MEMBERS. It will have the remote member GARDNER.JEFF@DOMAIN.EXT. Please verify these that these two new definitions are correctly set up. If a site does not have the Mail Group VDEF NATIONAL ALERTS, VDEF will continue the alerts to the HL7 Mail Group. 2. MODIFY THE 'VDEF STARTUP OPTION' SCHEDULED TASK. Using the TaskMan option 'Schedule/Unschedule Options', edit the parameters for the task VDEF STARTUP OPTION as indicated in the screen 4) No longer sets the flag for unread VDEF Alerts to be sent to a mail example shown here. Edit Option Schedule Option Name: VDEF STARTUP OPTION Menu Text: VDEF STARTUP OPTION TASK ID: 5998624 ___________________________________________________________________ QUEUED TO RUN AT WHAT TIME: (Enter current date/time + 5 minutes) DEVICE FOR QUEUED JOB OUTPUT: QUEUED TO RUN ON VOLUME SET: RESCHEDULING FREQUENCY: 300S (Enter 300S) group supervisor. TASK PARAMETERS: SPECIAL QUEUEING: Startup Persistent (Change from STARTUP to Startup Persistent This patch addresses the following New Service Request (NSR): ============================================================= There is no NSR associated with this patch. BEFORE INSTALLING THIS PATCH. This patch addresses the following Remedy ticket(s): ==================================================== 65927,99499,100952,102184,102329,103092,103286,104402,105065,106497 106674,107101,107142,107326,107508,107589,107773,107927,108431,108661 108873,108915,109469,109521,109627,109638,109715,109725,110057,110285 110501,110688,110765,110891,111109,112391,112642 Overview of Patch Items: ======================== This patch also includes numerous enhancements to the VistA Data 1) A pre-install routine, PREIN^VDEFKIDS, is included in this patch that suspends VDEF Request Queue processing through the duration of this patch installation. It also stops and deletes the TaskMan tasks driving the processes and the VDEF monitor processes. 2) A post-install routine, POSTIN^VDEFKIDS, is included in this patch that restarts VDEF Request Queues after installation of this patch. It also creates new VDEF monitor tasks. 3) The routine VDEFUTIL has been changed to not set the flag for an Extraction Framework (VDEF) functionality: unread VDEF Alert to be sent to the supervisor. This program has also been changed to prefix the date & time to the VDEF alert text and to use the new VDEF alert mail group to send a MailMan message to the VDEF developer whenever a VDEF alert occurs. 4) The routine VDEFCONT has been changed to eliminate the false VDEF Alerts from being generated. It has also been changed to include the name of the Request Queue in the VDEF Alert message. 5) The routine VDEFREQ has been changed to eliminate the problem of TaskMan not restarting the VDEF Request Queue processor EN^VDEFREQ. Instead, VDEFREQ does not re-schedule itself with TaskMan but uses an M HANG command loop based on the number of seconds in file #579.3, field .05 - CHECK-OUT TIME LIMIT. 6) The routine VDEFMNU has been changed to display the VMS process ID for the Request Queue Task in the Status of VDEF components [VDEF Status] display. The counter for Processed Requests has been dropped from the Status of VDEF components [VDEF Status] display. It was useless information. 1) In the VDEF Configuration and Status Menu [VDEF CONFIGURATION MENU], 7) The routine VDEFQM has been changed to incorporate two VDEF APIs that will requeue requests that are stuck in the Checked Out or Errored Out state. 8) A new routine VDEFMON has been created to monitor the Request Queue process and restart it if it dies as well as automatically re-queuing requests that have Errored Out or get stuck in the Checked Out status. 9) There are no VDEF global changes in this patch. the options marked below with an asterisk now return to the option Test Sites: =========== BAY PINES EL PASO LOUISVILLE MARYLAND (Integrated) MEMPHIS PHILADELPHIA prompt instead of going back to the main VDEF Configuration and Status PHOENIX SAN FRANCISCO LOCATION OF DOCUMENTATION FOR THIS PATCH ======================================== There will be a documentation update for this patch to the VDEF V1.0 Installation & User Configuration Guide and the VDEF V1.0 Technical Manual Menu. INSTALLATION INSTRUCTIONS ========================= Install Time - less than 5 minutes 1. LOAD TRANSPORT GLOBAL --------------------- Choose the PackMan message containing this patch and invoke the INSTALL/CHECK MESSAGE PackMan option. The build includes an Environment check routine VDEFKIDS. Loading Distribution... VDEF1.03 Will first run the Environment Check Routine, VDEFKIDS 2. COMPONENTS SENT WITH PATCH -------------------------- Routine Summary The following routines are included in this patch. The second line Site Site-Wide Parameters of Each of these routines now looks like: ;;1.0;VDEF;3;Dec 28, 2004 Checksum Routine Old New Patch List VDEFCONT 8818367 8818367 3 VDEFKIDS 13711730 5283479 3 VDEFMNU 47567743 14047707 3 VDEFMON 8468795 3113945 3 VDEFQM 12629742 12740824 3 * Req Request Queue Parameters VDEFREQ 7914740 7914740 3 VDEFUTIL 5715842 5715842 3 Sites should use CHECK^XTSUMBLD to verify checksums. NOTE: The above checksums are based on your site having installed VDEF13 v9. If you are installing VDEF13 for the first time or if you did not install VDEF13 v9, your old checksums will not match those in the above list. * ActR Activate/Inactivate Requestor If you are installing VDEF13 for the first time and all your current VDEF* programs are V1.0, your old checksums should be: VDEFCONT 10134570 VDEFKIDS N/A VDEFMNU 12329753 VDEFMON N/A VDEFQM 11427789 VDEFREQ 7981911 VDEFUTIL 1413855 * SusR Suspend/Run Request Queue 3. START UP KIDS ------------- Start up the Kernel Installation and Distribution System Menu [XPD MAIN]: Edits and Distribution Utilities Installation Select Kernel Installation & Distribution System Option: INStallation * Cust VDEF Custodial Package Activate/Inactivate Load a Distribution Print Transport Global Compare Transport Global to Current System Verify Checksums in Transport Global Install Package(s) Restart Install of Package(s) Unload a Distribution Backup a Transport Global * API VDEF Event API Activate/Inactivate Select Installation Option: 4. Select Installation Option: --------------------------- When prompted for the INSTALL NAME, enter VDEF1.03. a. Backup a Transport Global - This option will create a backup message of any routines exported with this patch. It will not backup any other changes such as DD's or templates. b. Compare Transport Global to Current System - This option will Stat Status of VDEF components allow you to view all changes that will be made when this patch is installed. It compares all components of this patch (routines, DD's, templates, etc.). c. Verify Checksums in Transport Global - This option will allow you to ensure the integrity of the routines that are in the transport global. 5. Select Installation Option: Install Package(s) ---------------------------------------------- Select INSTALL NAME: VDEF1.03 Loaded from Distribution * Sch Request Processor Schedule MM/DD/YY@HH:MM => VDEF13 v9 Select Installation Option: INstall Package(s) => VDEF13 v9 This Distribution was loaded on Dec 22, 2005@11:48:44 with header of VDEF13 v9 It consisted of the following Install(s): VDEF1.03 Checking Install for Package VDEF1.03 Will first run the Environment Check Routine, VDEFKIDS Suspending Request Queues and stopping associated TaskMan jobs Stopping the MONITOR^VDEFCONT task Stopping the MONITOR^VDEFMON task 2) A new process, the "VDEF Request Queue Monitor" has been added to Waiting for processes to quit . . . Install Questions for VDEF1.03 Incoming Mail Groups: Enter the Coordinator for Mail Group 'VDEF NATIONAL ALERTS': // <enter your name> monitor the VDEF Request Queue process and restart it when it stops Want KIDS to INHIBIT LOGONs during the install? YES// NO Want to DISABLE Scheduled Options, Menu Options, and Protocols? YES// NO Enter the Device you want to print the Install messages. You can queue the install by enter a 'Q' at the device prompt. Enter a '^' to abort the install. DEVICE: HOME// TCP if the state of the Request Queue is Running. This new monitor is Install Started for VDEF1.03 : Dec 22, 2005@11:50:14 Build Distribution Date: Dec 22, 2005 Installing Routines: Dec 22, 2005@11:50:14 Installing PACKAGE COMPONENTS: automatically started by the VDEF Startup option. This process is Installing MAIL GROUP Installing HL7 APPLICATION PARAMETER Dec 22, 2005@11:50:14 Running Post-Install Routine: POSTIN^VDEFKIDS (NOTE: the next 4 lines will not be displayed in a test or Legacy Environment installation. Instead it will display: hardcoded to run every 10 minutes. The VDEF Request Queue Monitor will "VDEF is not started on test systems." Running Post-Install Routine: POSTIN^VDEFKIDS Starting the Request Queues and associated Tasks Starting the MONITOR^VDEFCONT task Starting the MONITOR^VDEFMON task also automatically requeue any Checked Out and Errored Out VDEF Updating Routine file... Updating KIDS files... VDEF1.03 Installed. Dec 22, 2005@11:50:14 NO Install Message sent requests. 100% Complete Install Completed BUILD COMPONENTS ================= ENVIRONMENT CHECK : VDEFKIDS DELETE ENV ROUTINE: No PRE-INIT ROUTINE : DELETE PRE-INIT ROUTINE: No POST-INIT ROUTINE : POSTIN^VDEFKIDS DELETE POST-INIT ROUTINE: No PRE-TRANSPORT RTN : ROUTINE: VDEFCONT SEND TO SITE VDEFMNU SEND TO SITE VDEFMON SEND TO SITE VDEFQM SEND TO SITE VDEFREQ SEND TO SITE VDEFUTIL SEND TO SITE 3) VDEF Alert messages are now prefixed with the date & time of the REQUIRED BUILDS: ACTION: VDEF 1.0 Don't install, remove global XU8.0339 Don't install, remove global POST INSTALLATION CHECKS: 1) Verify that the three VDEF tasks shown in the example exist after the install is complete. The EN^VDEFREQ and MONITOR^VDEFMON tasks alert in the format MM/DD/YY@HH:MM:SS. should be active while the MONITOR^VDEFCONT task may be scheduled or active. (example task list) Task list Dec 22, 2005 11:26 am Page 1 ---------------------------------------------------------------------- 7399750: EN^VDEFREQ, VDEF Request Processor for MAINTENANCE. No device. DAYT12. From Today at 11:26, By you. Started running Today at 11:26. Job #: 560347970 [21663B42] ---------------------------------------------------------------------- 7399751: MONITOR^VDEFCONT, VDEF Checked Out Monitor. No device. DAYT12,ROU. From Today at 11:26, By you. Scheduled for Today at 11:27 ---------------------------------------------------------------------- 7399752: MONITOR^VDEFMON, VDEF Request Processor Monitor. No device. DAYT12,ROU. From Today at 11:26, By you. Started running Today at 11:26. Job #: 560552879 [21695BAF] ---------------------------------------------------------------------- 4) Original VDEF Alert message texts are clearer in context. 2) Run the Status of VDEF components [VDEF Status] display and verify the following: - Requestor status is Activated - Request Processor Status is "Running" - Task status is "Active-Running" - the Current Task # matches the task # for the EN^VDEFREQ task. (example of the Status of VDEF components [VDEF Status] display) VDEF Status - Dec 22, 2005@11:50:14 DESCRIPTION: Logical Link Status VDEFVIE1: stopped or caught up VDEFVIE2: stopped or caught up VDEFVIE3: stopped or caught up Requestor Status MAINTENANCE: Activated Dest.: VISTA HL7 Req. Queue: MAINTENANCE Request Processor Status 5) New VDEF Alerts have been added. MAINTENANCE: Running Current Task # [Proc]: 7410052 [21A53BA8] Task status: Active- Running Requests waiting for purge: 0 Last request#: Checked Out(0) Queued Up(0) Errored Out(0) IMPORTANT NOTES ON THE Status of VDEF components [VDEF Status] DISPLAY ========================================== The "Request Processor Status" is simply the status flag of the process in a VDEF global. It is possible to have the status "Running" even if the VMS - VDEF CHECKED OUT MONITOR FAILED TO START. CHECK ERROR TRAP. process of the task had died. IF THE REQUEST QUEUE PROCESSOR TASK (EN^VDEFREQ) IS RUNNING: The Request Processor Status will show "Running" and the task status will show "Active-Running". IF THE REQUEST QUEUE PROCESSOR TASK (EN^VDEFREQ) IS SUSPENDED BY SITE USING the VDEF Configuration and Status Menu: The Request Processor Status will show "Suspended" and the task status will show "Interrupted". - RECORD <IEN> IN QUEUE <QUEUE NAME> HUNG IN CHECKED OUT STATUS. VDEF Status - Dec 22, 2005@11:50:14 Logical Link Status VDEFVIE1: stopped or caught up VDEFVIE2: stopped or caught up VDEFVIE3: stopped or caught up Requestor Status MAINTENANCE: Activated Dest.: VISTA HL7 Req. Queue: MAINTENANCE - VDEF REQUEST PROCESS <QUEUE NAME> FAILED TO START. CHECK ERROR Request Processor Status MAINTENANCE: Suspended Current Task # [Proc]: 7410053 [0] Task status: Interrupted Requests waiting for purge: 0 Last request#: Checked Out(0) Queued Up(0) Errored Out(0) IMPORTANT: IF THE REQUEST QUEUE PROCESSOR TASK (EN^VDEFREQ) IS RUNNING BUT THE VMS PROCESS HAS STOPPED: The Request Processor Status will STILL show "Running" and the task status TRAP. will STILL show "Active-Running". This is because of the way that an application communicates with TaskMan to stop a task. It makes a request to TaskMan to stop the task and waits for the status of the task to go to "stop requested". Then the application quits back to TaskMan and only then does TaskMan update the task status to stopped or interrupted. If the VMS process for the EN^VDEFREQ task had died, then the VDEFREQ program is not running and cannot quit back to TaskMan. This is why the TaskMan task status stays "Active-Running". - VDEF QUEUE PROCESS MONITOR DID NOT START. CHECK ERROR TRAP. HOW TO VERIFY THAT THIS PATCH TESTS SUCCESSFULLY ================================================ 1) From the VDEF Configuration and Status Menu, suspend the MAINTENANCE request queue. You should get the two alerts shown below. MM/DD/YY@HH:MM:SS VDEF REQUEST QUEUE PROCESSOR FOR MAINTENANCE HAS EXITED. MM/DD/YY@HH:MM:SS VDEF QUEUE MAINTENANCE IS SUSPENDED. PLEASE START IT. - VDEF HAS REQUEUED CHECKED OUT RECORDS. NO ACTION NEEDED. Note that you may have to wait up to ten minutes to get these alerts. This is the interval that the VDEF process monitor runs at. 2) From the VDEF Configuration and Status Menu, restart the MAINTENANCE Request Queue by changing the status to Running. 3) WITHOUT suspending the VDEF Request Queue 'MAINTENANCE', use the VDEF Status display to identify the VMS process ID for the Request Queue Task. Then use ^RESJOB to kill that job. You should get the following alert: - VDEF HAS REQUEUED ERRORED OUT RECORDS. NO ACTION NEEDED. MM/DD/YY@HH:MM:SS VDEF QUEUE MAINTENANCE AUTO-RESTARTED. NO ACTION REQUIRED. Note that you may have to wait up to ten minutes to get these alerts. This is the interval that the VDEF process monitor runs at. If you kill the process while there is a VDEF Request in the Checked Out status, you may also get this alert: - VDEF QUEUE PROCESS MONITOR HAS EXITED. MM/DD/YY@HH:MM:SS RECORD nnn IN QUEUE MAINTENANCE HUNG IN Checked Out Status. NOTE: Doing this will leave an orphaned TaskMan task for EN^VDEFREQ that you will have to clean and delete. 4) If you do get a Checked Out request alert, use %G and look at the record. If it's a valid alert, the data in piece 2 of the zero node will be "C". ^VDEFHL7(579.3,1,1,record ien,0) = IEN^STATUS^...... ============ - VDEF QUEUE '"_QUEUE_"' AUTO-RESTARTED. NO ACTION REQUIRED. 5) If you get any requests that get hung in the Checked Out or Errored Out Status, they will get requeued by the VDEF queue process monitor which runs every ten minutes. If this monitor does requeue any requests, you will get one or both of these alerts: MM/DD/YY@HH:MM:SS VDEF HAS REQUEUED CHECKED OUT RECORDS. NO ACTION NEEDED. MM/DD/YY@HH:MM:SS VDEF HAS REQUEUED ERRORED OUT RECORDS. NO ACTION - VDEF QUEUE '"_QUEUE_"' IS SUSPENDED. PLEASE START IT. NEEDED. NOTE: Without direct, intentional intervention in the ^VDEFHL7 queue by modifying a record, you will have to wait for a request to get checked out hung or errored out on it's own. If you don't want to wait, instructions on how to do that for the purposes of verifying the testing of this patch are available from the VDEF developer. 6) VDEF alerts will no longer be sent to members of the HL7 mail group - VDEF REQUEST QUEUE PROCESSOR FOR "_$P(QUEUE,U)_" HAS EXITED. but will be sent to the members in the new VDEF NATIONAL ALERTS mail group. 7) You have had the patch in place for 2 weeks and have seen no adverse affects and it has not affected the functionality of any other option(s). 8) You have communicated your test results to the SQA representative and given your approval for its release. 6) All VDEF alerts will send a MailMan message to the VDEF developer On FORUM that includes the alert text, the site name and ID and the date & time of the alert. 7) Includes a new program VDEFKIDS that has two APIs, VDEFKIDS and POSTIN^VDEFKIDS. These APIs are defined in the build as the Environment Check and post install routines. Although the Pre-install routine does pre-installation type functions, it is defined in the build as the Environment Check routine, NOT the Pre-install routine. This is to prevent any VDEF* routines that are in the build from being filed over actively running routines causing an EDITED error trap error. By the time KIDS runs the Pre-Install routine, ALL the routines in the build have already been loaded whereas when the Environment routine is run, no other programs in the build have been installed. This patch fixes 4 problems in the VistA Data Extraction Framework The pre-install routine will: - suspend all VDEF Request Queues - stop the TaskMan tasks associated with these queues - stop the VDEF checked out request monitor - stop the VDEF Request Queue process monitor The post-install routine (in production systems only) will: - un-suspend all VDEF Request Queues (change state to running) - create new TaskMan tasks for these queues - start the VDEF checked out request monitor (VDEF) V1.0 functionality: - start the VDEF Request Queue process monitor 8) The Status of VDEF components [VDEF Status] option screen has been modified. See the example that follows. - The VMS Process ID associated with the VDEF Request Queue process task has been added. - The TaskMan task status has been added. - The counter for Processed requests has been deleted. This was useless information because it was simply a count of the number of records in the VDEF Request Queue that are in the Processed 10 SEQ #2 DATE APPLIED: 2012-03-09 11:00:40 APPLIED BY: USER,SEVENTEEN DESCRIPTION: Please see the National Patch Module on Forum for the patch description. 11 SEQ #3 DATE APPLIED: 2012-08-29 10:44:43 APPLIED BY: USER,SEVENTEEN DESCRIPTION: Please see the National Patch Module for the description. 12 SEQ #4 DATE APPLIED: 2015-06-16 12:21:49 APPLIED BY: USER,SEVENTEEN DESCRIPTION: This patch will fix the input transform utility that inadvertently restricted the values to greater than 30 days and update the REQUEST QUEUE WAKEUP PERIOD description to reflect how the field is defined. 14 SEQ #5 DATE APPLIED: 2017-01-06 12:55:39 APPLIED BY: USER,FIFTYFOUR DESCRIPTION: This patch will fix the VDEF Request Processor so that when it encounters a VDEF REQUEST QUEUE file (#579.3) record NAME VALUE PAIRS MULTIPLE (#579.311) with an internal entry number value other than a one (1) or two (2) it will continue processing as long as the data associated with each respective node is valid. DATE INSTALLED AT THIS SITE: 2005-01-18 00:00:00 INSTALLED BY: USER,ONE DESCRIPTION OF ENHANCEMENTS: This build is for the GOLD disk. It was buld on the FOIVISTA account.
DESCRIPTION	VDEF stands for VistA Data Extraction Framework, a data-driven scripting tool for automated HL7 message generation.

VDEF (199) PACKAGE (9.4)