VistA Imaging System Background Processor User Manual - VA

VistA Imaging SystemBackground Processor User ManualSeptember 2019 – Revision 19MAG*3.0*238Department of Veterans AffairsSystem Design and DevelopmentVistA Imaging

Background Processor User ManualVistA Imaging MAG*3.0*238September 2019Property of the US GovernmentThis is a controlled document. No changes to this document may be made without the express written consent of the VistA Officeof Enterprise Development.While every effort has been made to assure the accuracy of the information provided, this document may include technicalinaccuracies and/or typographical errors. Changes are periodically made to the information herein and incorporated into neweditions of this document.Product names mentioned in this document may be trademarks or registered trademarks of their respective companies, and arehereby acknowledged.VistA Imaging Office of Enterprise DevelopmentDepartment of Veterans AffairsInternet: REDACTEDVA intranet:iiREDACTEDBackground Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019

Revision TableDatePatchRevDescriptionSept 2019Patch 23819Updated Section 6.4.5: Purge Events TableDec 2018Patch 22218Added 5.7.1.6 BP Verifier Debug LogOct 2018Patch 21417Updated Site Parameters window. Encrypted Password.July 2018Patch 19816Updated install section.Jun 2018Patch 19815Updated section: 2.4 Installation – Client Requirements; Addedsection 2.6: New Server Installation; Updated 10:4 Logging; addedsection10.4.1.4 – creating a debugging for VerifierMar 2018Patch 19614Added section 2.4.1 Client Requirements in the 2.4 InstallationSection; added section 4.5.2 Delay Between Queue Processing.Revised sections: 2.1, 2.2, 2.52, 3.1, 3.6.1, 4.5.1, 4.5.3, 4.6.3,5.5.1, 6.4, and 7.5.Sep 2015Patch 15813Added 9.5 because of field testing.June 2015Patch 15812Revised sections 8.5; added sections 9 and 10.Sept 2013Patch 13511Revised sections 2.5.2, 3.1, 3.2.1, 3.6.1, 3.6.3, 3.6.4, 4.6.3.4, 3.7.Added section 8.5.Jan 2012Patch 12110Updated sections 4.1, 4.3, 8.2.2. Added sections 4.6.2.17 and4.6.2.18.Mar 2011Patch 399Revamped content, added new Patch 39 features, merged contentfrom Verifier User Manual. Globally replaced term BP “Workstation”with BP “Server”. 1st, 2nd, and 3rd WPRs completed.May 2006Patch 208Replaced all “VMC” with “VistA Imaging Shares”.Feb 2006Patch 207Updated sections 5.5.3 thru 5.5.5.1 “VistARad”Dec 2005Patch 206Updated Background Processor content in this manual.June 2005Patch 205Updated Background Processor content in this manual. Extractedthe entire Chapter 4 Verifier content and created a new manualwhich contains the extracted content.June 2005Patch 134Expanded and updated Verifier content. Moved Verifier contentfrom the end of initial manual and created a separate manual.May 2004Patch 133Expanded and updated Verifier content. Moved Verifier contentfrom Chapter 4 to end of manual. Appendix B absorbed intoChapters 4 (Purge) and 7 (Verifier)Apr 2004Patch 32Updated section 3.1.8.10 and 5.5.7.6 to reflect transition to long filenames.May 2002Patch 71Updated section 3.1.6.4 “Operational Procedures.”iiiBackground Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019

PrefacePrefaceThe purpose of this manual is to provide users with instructions on using the VistA ImagingBackground Processor (BP) V. 3.0 software and system components. It includes explanations ofthe options and controls available from the VistA Imaging Background Processor. Instructionsare provided about how to perform various system tasks.Note: Additional information about the various VistA Imaging components such as servers,workstations, Remote Procedure Call (RPC) Broker software, and OTG-Disk Extender Jukeboxsoftware can be found in the VistA Imaging Installation Guide.The VistA Imaging System documentation suite includes Release NotesInstallation GuidesSecurity GuideTechnical ManualUser ManualsThis manual is also available at: REDACTEDTerms of UseUse of the Background Processor is subject to the following provisions:Caution: Federal law restricts this device to use by or on the order of either a licensedpractitioner or persons lawfully engaged in the manufacture or distribution of the product.No modifications may be made to the software workstation without the express writtenconsent of the VistA Imaging National Project Manager.Intended AudienceThis software should be maintained by trained Imaging Coordinators who have IT experienceand a thorough knowledge of the Imaging product.ConventionsThis document uses the following conventions:iv Change bars in margins indicate content added or updated since the last revision. Controls, options, and button names are shown in bold. Keyboard key names are shown in bold and in brackets . Sample output is shown in monospace. When this document is used online, hyperlinks are indicated by blue text. Useful or supplementary information is shown in a Tip. Required or important information is shown with the word Note or Important.Background Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019

Preface Critical information is indicated by.Related InformationThe VistA Imaging System documentation suite includes: Release NotesInstallation GuidesSecurity GuideTechnical ManualNote: Additional information about the various VistA Imaging components such as servers,workstations, Remote Procedure Call (RPC) Broker software, and OTG-Disk Extender Jukeboxsoftware can be found in the VistA Imaging Installation Guide.VistA Imaging SupportIf you encounter any problems using VistA Imaging Background Processor, which cannot beresolved follow your local, VISN, or regional procedures for problem resolution/escalation.vBackground Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019

Table of ContentsPreface . ivTable of Contents .7Chapter 1Introduction .11.1. What is the Background Processor? .11.1.1. Background Processor Applications .11.2. VistA Imaging and the Background Processor .21.3. VistA Imaging Functional Flow .21.4. Features of the Background Processor .41.5. The Background Processor Usage and Maintenance of RAID Groups .41.5.1. RAID Group Guidelines .51.5.2. Scheduling a RAID Group Advance.51.5.3. Additional Maintenance of Tier 1 .6Chapter 2Setting Up Your BP System .72.1 Software Requirements .72.2 Hardware Requirements.72.3 Setup Requirements .82.3.1 Windows Security .82.3.2 VistA Security.8Security Keys, RPCs, and Menu Options in VistA .92.4 Installation.92.4.1 Client Requirements.92.5 Configuring BP Servers .102.5.1 Guidelines .102.5.2 Adding a BP Server to the VistA Imaging System .102.5.3 Assigning Tasks (Queues) to a BP Server .122.5.4 Removing a BP Server from the VistA Imaging System .142.5.5 Specifying the Log File Location and Size .142.6 New Server Installation.15Chapter 3Configuring the Application .173.1 Introduction .173.1.1 Overall Guidelines .173.2 Configuring the VistA Imaging Site Parameters .183.2.1 Imaging Site Parameters Window .183.2.2 Administrative Settings.19Storage Functions Settings .21TeleReader Settings .22Clinical Workstation Settings .23Service Accounts Settings.23DICOM Interface Settings .243.3 Configuring Mail Messages .253.3.1 Mail Messages Window .25viiBackground Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019

3.43.53.63.73.8viiiDisplaying Mail Users .26Adding Names .26Removing Names .26Notification Intervals .27Field Descriptions .27Configuring Mail Groups .273.4.1 Mail Groups Window .28Displaying Mail Users .28Guidelines on Adding Mail Groups .29Adding Members to Mail Groups .29Adding Remote Members to Mail Groups.29Deleting Members from Mail Groups.30Specifying Properties for Mail Groups .30Configuring the Purge, Verifier, and RAID Group Advance Settings .323.5.1 Purge Settings .32Guidelines for Setting Retention Days on Files for the Purge .33Configuring the Retention Days Settings .34Configuring Scheduled/Express Purge Settings .35Configuring Purge Date Criteria Settings .36Running the Scheduled Purge .37Running the Auto Purge.383.5.2 Verifier Settings .39Scheduled Verifier Settings .39Guidelines for Setting Parameters for the Scheduled Verifier.40Running the Scheduled Verifier.403.5.3 RAID Group Advance Settings .41Configuring the Scheduled RAID Group Advance Settings .41Parameter Guidelines for the Scheduled RAID Group Advance.42Running the Scheduled RAID Group Advance .42Queue Manager .433.6.1 Queue Manager Operations .443.6.2 Purging a Queue .463.6.3 Re-Queuing a Failed Image File .473.6.4 Refreshing a Queue Display .483.6.5 Setting a Queue Partition .483.6.6 Accessing Import Queue Properties.49Network Location Manager .49Configuring the Network Location Manager .50Tier 1 Tab .51Tier 2 Tab .53Routers Tab .54GCC Tab .56EKG Tab .57URLs Tab .58Diagrams Tab .593.8.2 Adding a New Location to Network Location Manager .60Background Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019

3.8.33.8.43.8.5Chapter 4Editing the Properties of a Network Location .61Adding a RAID Group .62GCC Queue for PhotoID .63Queue Processor .644.14.24.34.44.5Application Description .64Setup Guidelines .64Tasking.65Understanding Processing.72Starting/Running the Application .734.5.1 Starting the Application and Analyzing the Activity.734.5.2 Delay Between Queue Processing. .754.5.3 Getting Help .764.6 Reports .764.6.1 Log Files .76Log File Format .77BackProc Log.78BP Error Log .794.6.2 Email Messages .79Ad Hoc Image Site Usage .79Application Process Failure .80Auto RAID Group Purge .83GCC Copy Error .84Get Next RAID Group Failure .84Image Cache Critically Low .84Image File Size Variance .85INSTALLATION .85Monthly Image Site Usage.85Photo ID Action .86Scheduled Purge Failure .86Scheduled RAID Group Advance Failure .87Scheduled Verifier Failure .87Site Report Task Was Restarted .87VI BP Eval Queue .87VI BP Queue Processor Failure .88“Rescinded” Watermarking Successful .88“Rescinded” Watermarking Failed .894.6.3 Screen-Generated Output .89Server Size .89JBTOHD Report .90IMPORT Queue Status Report .91Purge ReQueue by Type Entries .93508 Compliance .95Chapter 5Verifier .965.1 Application Description .965.2 Setting Up the Verifier .96ixBackground Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019

5.3 Tasking.965.4 Understanding Processing.965.4.1 Reasons for Running the Verifier .985.5 Maintenance Operations .985.5.1 Integrity Checks .99File Integrity.99File Corruption .99Patient Integrity Vs. File Integrity .100Text File Integrity .1015.6 Starting/Running the Verifier .1025.7 Reports .1075.7.1 Log Files .107Scan Log File .108NoArchive Log File .109ScanError Log File .110DFNError Log File .112BP Verifier Kill Journal .113BP Verifier Debug Log .114Imaging Integrity Check Message .115Imaging Site Verification Issue .115Verifier Scan Error Log message .116Chapter 6Purge .1186.16.26.36.4Application Description .118Setting Up .118Tasking.118Understanding Processing.1186.4.1 Setting Purge Parameters .1196.4.2 File Types for Purge.1206.4.3 Purge by Dates .1206.4.4 Express Purge Options .1206.4.5 Purge Events Table .1216.5 Starting/Running the Purge .1226.6 Reports .1286.6.1 Log Files .128Log File Format .128Purge Log File.129PurgeError Log File .1306.6.2 Emails .130Scheduled Purge Failure Message .1306.6.3 Screen-Generated Output .131Purge Results .131Chapter 7System Monitoring .1357.1 Description of the BP Server Monitor Utility .1357.1.1 Evaluating EVAL Queues.1357.1.2 Reporting Using Mail Messages .135xBackground Processor User Manual, Rev 19VistA Imaging MAG*3.0*238September 2019