Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: DVBAUTLP

DVBAUTLP.m

Go to the documentation of this file. 
  1. DVBAUTLP ;ALB/SBW - Pre/Post Install APIs For CAPRI Templates & AMIE Exams ; 8/MAR/2011
  1.  ;;2.7;AMIE;**166**;Apr 10, 1995;Build 6
  1.  ;;Per VHA Directive 2004-038, this routine should not be modified.
  1.  ;
  1.  ; No direct entry allowed
  1.  Q
  1.  ;
  1.  ; This Pre/Post Install Utility has APIs for Disabling and Activating/
  1.  ; Renaming CAPRI Templates Definition (File #396.18) entries. 
  1.  ; It also has APIs for Inactivating old and Creating new AMIE or 
  1.  ; Updating existing Exams (File # 396.6) entries.
  1.  ;
  1.  ; Note that for Development Test Environments and VAMC Test Sites there
  1.  ; will be a CAPRI Template Definition entry for each Test Patch Version 
  1.  ; and the Released Patch installed. At all VAMC Sites who did not test
  1.  ; the patch there will be just one released version per patch for which
  1.  ; the original or updated template was distributed differentiated
  1.  ; by Patch Number Version Suffix.
  1.  ;
  1.  ;
  1. DISABLE(DVBNM,DVBVERSN,DVBACTR,DVBAMSG) ;Disable matching CAPRI template entries
  1.  ;
  1.  ; This procedure will find each entry in the CAPRI TEMPLATE 
  1.  ; DEFINITIONS (#396.18) file where the first delimited (~) piece 
  1.  ; matches the passed name (DVBNM) of the template being exported. Once
  1.  ; a matching entry is found, it will be disabled if the 396.18 entry 
  1.  ; Version Suffix does not match the Passed (DVBERSN) Version Suffix
  1.  ; to be used for new templates to be added by the patch.
  1.  ; Format for Template Name is:
  1.  ;     Name~Version Suffix (e.g. DBQ TEST EXAMPLE~999T1) 
  1.  ;
  1.  ; An entry will be disabled by doing the following:
  1.  ; - Turning off the SELECTABLE BY USER? field. This will keep the
  1.  ;   entry from showing in the CAPRI GUI template list.
  1.  ; - Looking at DE-ACTIVATION DATE field. If there's no date, set 
  1.  ;   it to today.
  1.  ;
  1.  ;INPUT:
  1.  ;  DVBNM -    Name of CAPRI template entry to be disabled
  1.  ;  DVBVERSN - Patch Version Suffix (e.g. 999 or 999T1)
  1.  ;    Format for version suffix are:
  1.  ;      Released patch will be just Patch Number (e.g 999)
  1.  ;      Test Patch will be Patch Number with a "T" and Test Patch
  1.  ;         Version Number (e.g. 999T1)
  1.  ;INPUT/OUTPUT:
  1.  ;  DVBACTR -  Passed variable which contains the number of 
  1.  ;             CAPRI templates disabled (Incremented by one for 
  1.  ;             each CAPRI template successfully disabled.
  1.  ;  DVBAMSG -  Array variable passed back to calling API with 
  1.  ;             API result messages
  1.  ;
  1.  ;Quit if Template name or Version is not passed
  1.  Q:$G(DVBNM)=""!($G(DVBVERSN)="")
  1.  ;
  1.  N DVBABIEN ;ien of CAPRI TEMPLATE DEFINITIONS file
  1.  N DVBABST  ;template NAME field (i.e. DBQ PARKINSONS~999T1)
  1.  N DVBACH   ;flag used to indicate template was disabled
  1.  N DVBAFDA  ;FDA array for FILE^DIE
  1.  N DVBMCTR  ;status message counter
  1.  ;
  1.  S DVBABIEN=0,DVBMCTR=0
  1.  ;
  1.  ;walk through CAPRI TEMPLATE DEFINITIONS (#396.18) file entries
  1.  F  S DVBABIEN=$O(^DVB(396.18,DVBABIEN)) Q:'DVBABIEN  D
  1.  . S DVBABST=$P($G(^DVB(396.18,DVBABIEN,0)),U,1) ;template name
  1.  . ;if name matches and version is different, then disable entry
  1.  . I $P(DVBABST,"~",1)=DVBNM  I $P(DVBABST,"~",2)'=DVBVERSN  D
  1.  . . S DVBACH=0
  1.  . . ;turn SELECTABLE BY USER (#7) field off
  1.  . . I $P($G(^DVB(396.18,DVBABIEN,6)),U,1)'="0" S DVBAFDA(396.18,DVBABIEN_",",7)="0",DVBACH=1
  1.  . . ;set DE-ACTIVATION DATE (#3) field to TODAY
  1.  . . I $P($G(^DVB(396.18,DVBABIEN,2)),U,2)="" S DVBAFDA(396.18,DVBABIEN_",",3)=DT,DVBACH=1
  1.  . . N DVBAERR  ;Array where error can be stored for Fileman calls
  1.  . . ;output list of disabled templates
  1.  . . I DVBACH=1 D
  1.  . . . D FILE^DIE("K","DVBAFDA","DVBAERR")
  1.  . . . S:$D(DVBAERR("DIERR"))'>0 DVBACTR=+$G(DVBACTR)+1
  1.  . . . S DVBMCTR=DVBMCTR+1
  1.  . . . S DVBAMSG(DVBMCTR)="   Disabling: "_DVBABST
  1.  . . . ; Include Fileman Error message returned if any
  1.  . . . I $D(DVBAERR("DIERR"))>0 D
  1.  . . . . S DVBMCTR=DVBMCTR+1
  1.  . . . . S DVBAMSG(DVBMCTR)="     *** Warning - Unable to disable."
  1.  . . . . D ADDERR(.DVBAMSG,.DVBAERR,.DVBMCTR)
  1.  Q
  1.  ;
  1. RENAME(DVBNM,DVBVERSS,DVBVERSN,DVBACTR,DVBAMSG) ; Rename CAPRI templates loaded
  1.  ; by the patch
  1.  ;
  1.  ; This procedure is used to lookup and rename a template in the
  1.  ; CAPRI TEMPLATE DEFINITIONS (#396.18) file. This is done to 
  1.  ; rename the imported version of a template (i.e. DBQ 
  1.  ; PARKINSONS~999F) to its new name/version (i.e. TEST - DBQ 
  1.  ; PARKINSONS~999T1 or RELEASED - DBQ PARKINSONS~999).
  1.  ; 
  1.  ;INPUT:
  1.  ;  DVBNM -    Name of CAPRI template entry to be disabled
  1.  ;  DVBVERSS - Incoming Patch Version Suffix (e.g. 999F)
  1.  ;  DVBVERSN - Rename Patch Version Suffix (e.g. 999 or 999T1)
  1.  ;    Format for version suffix are (delimiter is "~"):
  1.  ;      New entry to be renamed is Patch Number with a "F" (e.g 999F)
  1.  ;      Released patch will be just Patch Number (e.g 999)
  1.  ;      Test Patch will be Patch Number with a "T" and Test Patch
  1.  ;         Version Number (e.g. 999T1)
  1.  ;INPUT/OUTPUT:
  1.  ;  DVBACTR -  Passed variable which contains the number of 
  1.  ;             CAPRI templates renamed (Incremented by one for 
  1.  ;             each CAPRI template disabled.
  1.  ;  DVBAMSG -  Array variable passed back to calling API with 
  1.  ;             API result messages
  1.  ;
  1.  ;Quit if Template Name, or Incoming Patch Version, or New Patch 
  1.  ;Version is not passed
  1.  Q:$G(DVBNM)=""!($G(DVBVERSS)="")!($G(DVBVERSN)="")
  1.  ;
  1.  N DVBABIEN,DVBABIE2 ;ien of CAPRI TEMPLATE DEFINITIONS file
  1.  N DVBABST  ;incoming template NAME field (e.g. AUDIO~999F)
  1.  N DVBABS2  ;renamed template NAME field (e.g. AUDIO~999T1 or AUDIO~999)
  1.  N DVBACH   ;flag to indicate if template version is found or not
  1.  N DVBAFDA  ;FDA array for FILE^DIE
  1.  N DVBAADT  ;template activation date
  1.  N DVBMCTR  ;status message counter
  1.  ;
  1.  S DVBABIEN=0,DVBMCTR=0
  1.  ;
  1.  ;main loop-walk through CAPRI TEMPLATE DEFINITIONS file entries
  1.  F  S DVBABIEN=$O(^DVB(396.18,DVBABIEN)) Q:'DVBABIEN  D
  1.  . S DVBABST=$P($G(^DVB(396.18,DVBABIEN,0)),U,1) ;template name
  1.  . ;look for template versions just loaded by the patch by
  1.  . ; Checking Version Suffix
  1.  . I $P(DVBABST,"~",1)=DVBNM  I $P(DVBABST,"~",2)=DVBVERSS  D
  1.  . . S DVBABIE2=0,DVBACH=0
  1.  . . ; secondary loop-walk through CAPRI TEMPLATE DEFINITIONS file 
  1.  . . ; entries
  1.  . . F  S DVBABIE2=$O(^DVB(396.18,DVBABIE2)) Q:'DVBABIE2  D
  1.  . . . ;Template Name
  1.  . . . S DVBABS2=$P($G(^DVB(396.18,DVBABIE2,0)),U,1)
  1.  . . . ; if new version of template exists in file, set flag
  1.  . . . I $P(DVBABS2,"~",1)=DVBNM,$P(DVBABS2,"~",2)=DVBVERSN S DVBACH=1
  1.  . . ; if new version already exists, delete the imported version 
  1.  . . ; (abort rename)
  1.  . . N DVBAERR  ;Array where error can be stored for Fileman calls
  1.  . . I DVBACH=1 D
  1.  . . . S DVBMCTR=DVBMCTR+1
  1.  . . . S DVBAMSG(DVBMCTR)="      Found existing "_DVBNM_DVBVERSN_". No modifications made."
  1.  . . . S DVBAFDA(396.18,DVBABIEN_",",.01)="@"
  1.  . . . D FILE^DIE("","DVBAFDA","DVBAERR")
  1.  . . ;
  1.  . . ; Otherwise, if new version isn't found, rename imported 
  1.  . . ; template name to the new version name (e.g. 
  1.  . . ; DBQ PARKINSONS~999F --> DBQ PARKINSONS~999T1)
  1.  . . I DVBACH=0 D
  1.  . . . S DVBAADT=$P($G(^DVB(396.18,DVBABIEN,2)),U)
  1.  . . . S DVBAFDA(396.18,DVBABIEN_",",.01)=DVBNM_"~"_DVBVERSN
  1.  . . . I DVBAADT=""!(DVBAADT<DT) S DVBAFDA(396.18,DVBABIEN_",",2)=DT
  1.  . . . D FILE^DIE("K","DVBAFDA","DVBAERR")
  1.  . . . S:$D(DVBAERR("DIERR"))'>0 DVBACTR=+$G(DVBACTR)+1
  1.  . . . ;Include status message
  1.  . . . S DVBMCTR=DVBMCTR+1
  1.  . . . S DVBAMSG(DVBMCTR)="    Activating: "_$P($G(^DVB(396.18,DVBABIEN,0)),U,1)
  1.  . . . I $D(DVBAERR("DIERR"))>0 D
  1.  . . . . S DVBMCTR=DVBMCTR+1
  1.  . . . . S DVBAMSG(DVBMCTR)="      *** Warning - Unable to activate."
  1.  . . ;
  1.  . . ; Include Fileman Error message returned if any
  1.  . . I $D(DVBAERR("DIERR"))>0 D ADDERR(.DVBAMSG,.DVBAERR,.DVBMCTR)
  1.  ;
  1.  Q
  1.  ;
  1. INACTEXM(DVBIEN,DVBEXM,DVBAMSG) ;Inactivate old (current) AMIE Exam 
  1.  ; (#396.6) Entries
  1.  ;
  1.  ;INPUT:
  1.  ;  DVBIEN -   Internal Entry Number of AMIE Exam to be inactivated
  1.  ;  DVBEXM -   Exam Name of entry to to be inactivated
  1.  ;INPUT/OUTPUT:
  1.  ;  DVBAMSG -  Array variable passed back to calling API with 
  1.  ;             action result message
  1.  ;
  1.  N DVBAFDA,DVBMCTR,DVBAERR
  1.  S DVBMCTR=0
  1.  ; Quit if valid IEN and Exam (.01 field) not passed
  1.  Q:$G(DVBIEN)'>0!($G(DVBEXM)']"")
  1.  ;If passed Exam Name different from .01 field, send warning msg
  1.  I $P($G(^DVB(396.6,+DVBIEN,0)),U,1)'=DVBEXM D
  1.  . ; Create error message if Exam Name in Entry is different
  1.  . S DVBMCTR=DVBMCTR+1
  1.  . S DVBAMSG(DVBMCTR)="    *** Warning - Entry #"_DVBIEN_" for exam"
  1.  . S DVBMCTR=DVBMCTR+1
  1.  . S DVBAMSG(DVBMCTR)="                  "_DVBEXM
  1.  . S DVBMCTR=DVBMCTR+1
  1.  . S DVBAMSG(DVBMCTR)="                  could not be inactivated. Check Exam Name!"
  1.  ;If passed Exam Name is same as .01 fld update Status to Inactive
  1.  I $P($G(^DVB(396.6,+DVBIEN,0)),U,1)=DVBEXM D
  1.  . S DVBAFDA(396.6,+DVBIEN_",",.5)="I"
  1.  . D FILE^DIE("K","DVBAFDA","DVBAERR")
  1.  . ; Create status message if update successful
  1.  . I $D(DVBAERR("DIERR"))'>0 D
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="    Entry #"_DVBIEN_" for exam "_DVBEXM
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="      successfully inactivated."
  1.  . ; Create status message if error with update
  1.  . I $D(DVBAERR("DIERR"))>0 D
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="    *** Warning - Unable to inactivate Entry #"_DVBIEN_" for exam"
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="                  "_DVBEXM_"."
  1.  . . ; Include Fileman Error message returned if any
  1.  . . D ADDERR(.DVBAMSG,.DVBAERR,.DVBMCTR)
  1.  Q
  1.  ;
  1. NEWEXAM(DVBIEN,DVBEXM,DVBPNM,DVBBDY,DVBROU,DVBSTAT,DVBWKS,DVBAMSG) ;
  1.  ; Add new exam entries to AMIE EXAM (#396.6) File
  1.  ;INPUT:
  1.  ;  DVBIEN -  Internal Entry Number of AMIE Exam entry to be added
  1.  ;  DVBEXM -  Name of AMIE Exam entry to be added
  1.  ;  DVBPNM -  Print Name of AMIE Exam entry to be added
  1.  ;  DVBBDY -  Body System of AMIE Exam entry to be added
  1.  ;  DVBROU -  Reporting Program Name of AMIE Exam entry to be added
  1.  ;  DVBSTAT - Status of AMIE Exam entry to be added
  1.  ;  DVBWKS -  AMIE Worksheet # of AMIE Exam entry to be added 
  1.  ;INPUT/OUTPUT:
  1.  ;  DVBAMSG - Array variable passed back to calling API with 
  1.  ;            API result messages
  1.  ;
  1.  N DVBAFDA,DVBAIEN,DVBMCTR,DVBAERR
  1.  S DVBMCTR=0
  1.  ;
  1.  ; Quit if valid IEN and Exam (.01 field) not passed
  1.  Q:$G(DVBIEN)'>0!($G(DVBEXM)']"")
  1.  ; Update existing entry
  1.  I $D(^DVB(396.6,DVBIEN,0))>0 D
  1.  . S DVBMCTR=DVBMCTR+1
  1.  . S DVBAMSG(DVBMCTR)="    You have an Entry #"_DVBIEN_"."
  1.  . S DVBMCTR=DVBMCTR+1
  1.  . S DVBAMSG(DVBMCTR)="    Updating "_DVBEXM_"."
  1.  . S DVBAFDA(396.6,+DVBIEN_",",.01)=$G(DVBEXM)
  1.  . S DVBAFDA(396.6,+DVBIEN_",",.07)=$G(DVBWKS)
  1.  . S DVBAFDA(396.6,+DVBIEN_",",.5)=$G(DVBSTAT)
  1.  . S DVBAFDA(396.6,+DVBIEN_",",2)=$G(DVBBDY)
  1.  . S DVBAFDA(396.6,+DVBIEN_",",6)=$G(DVBPNM)
  1.  . S DVBAFDA(396.6,+DVBIEN_",",7)=$G(DVBROU)
  1.  . D FILE^DIE("K","DVBAFDA","DVBAERR")
  1.  . I $D(DVBAERR("DIERR"))'>0 D
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="    Successfully updated Entry #"_DVBIEN_" for exam"
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="       "_DVBEXM_"."
  1.  . I $D(DVBAERR("DIERR"))>0 D
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="    *** Warning - Unable to update Entry."
  1.  ;
  1.  ; Add new entry
  1.  I $D(^DVB(396.6,DVBIEN,0))'>0 D
  1.  . S DVBAIEN(1)=DVBIEN
  1.  . S DVBAFDA(396.6,"+1,",.01)=$G(DVBEXM)
  1.  . S DVBAFDA(396.6,"+1,",.07)=$G(DVBWKS)
  1.  . S DVBAFDA(396.6,"+1,",.5)=$G(DVBSTAT)
  1.  . S DVBAFDA(396.6,"+1,",2)=$G(DVBBDY)
  1.  . S DVBAFDA(396.6,"+1,",6)=$G(DVBPNM)
  1.  . S DVBAFDA(396.6,"+1,",7)=$G(DVBROU)
  1.  . D UPDATE^DIE("","DVBAFDA","DVBAIEN","DVBAERR")
  1.  . I $D(DVBAERR("DIERR"))'>0 D
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="    Successfully added Entry #"_DVBIEN_" for exam"
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="       "_DVBEXM_"."
  1.  . I $D(DVBAERR("DIERR"))>0 D
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="    *** Warning - Unable to add Entry #"_DVBIEN
  1.  . . S DVBMCTR=DVBMCTR+1
  1.  . . S DVBAMSG(DVBMCTR)="                  for exam "_DVBEXM_"."
  1.  ;
  1.  ;Include FILE^DIE or UPDATE^DIE error message in DVBAMSG array
  1.  I $D(DVBAERR("DIERR"))>0 D ADDERR(.DVBAMSG,.DVBAERR,.DVBMCTR)
  1.  Q
  1.  ;
  1. ADDERR(DVBMSG,DVBERR,DVBCTR) ;Include passed FM error message into DVBMSG 
  1.  ;array
  1.  ;INPUT:
  1.  ;  DVBERR - Passed error Array from Fileman call
  1.  ;INPUT/OUTPUT:
  1.  ;  DVBMSG - Passed array with status messages. Passed FM Error will
  1.  ;           be added to array and returned to calling API
  1.  ;  DVBCTR - Passed Counter Variable to used for DVBMSG array. Updated
  1.  ;           Counter will be returned to call API.
  1.  ;Quit if DVBERR isn't defined
  1.  Q:$D(DVBERR)'>0
  1.  N DVBMSG1,CTR
  1.  D MSG^DIALOG("AE",.DVBMSG1,"","","DVBERR")
  1.  S CTR=0
  1.  F  S CTR=$O(DVBMSG1(CTR)) Q:CTR'>0  D
  1.  . S DVBCTR=$G(DVBCTR)+1
  1.  . S DVBMSG(DVBCTR)="        "_DVBMSG1(CTR)
  1.  Q