DG Gateway Installation Guide

Transcription

1 DG Gateway Installation Guide September 2012

2 Contents Introduction 3 Before Installing 4 Installation Instructions 5-7 Edit Gateway Properties 8 2

3 Introduction This guide is an overview of how to install a DG Gateway and is intended as a reference for site administrators. The Gateway application is a Windows software application installed on a server, workstation, or virtual machine that securely links an entity s physical local area network to the DG Cloud. DG Gateway communicates with DICOM devices (PACS, modalities, workstations, etc.) to send and receive medical images across the network. DG Gateway compresses/decompresses and encrypts/decrypts medical images transferred to and from the DG Cloud. Support support@dicomgrid.com

4 Before Installing Installers should confirm that they have the required access and permissions before initiating a DG Gateway installation. DG Requirements The DG organization, location, or group to which the DG Gateway will belong already exists in DG. Installer s DG user role must include the following permissions: Edit gateways, View gateways. Installer s role in the DG organization, location, or group to which the DG Gateway will belong must include the following permissions: Edit gateways, View gateways. Local Device Requirements The installer has local administrator rights to install software on the device. The device has a Windows operating system (installed or virtual). The device has a static or reserved IP address on the local area network. The device can access the Internet. Port availability: Local ports 104, 4006, 8161 and are free/nothing else is running on these ports. In addition, outbound communication to the internet over port 443 must be allowed to the DG Cloud without going through a proxy server. Port 443 is used for secure (TLS/SSL) web browser communication. Port 104 is the ACR-NEMA port used for communication with PACS and modalities. If port 104 is in use, port 4006 is the next selection. Port 8161 is used internally for communication with our queue service. Port is used for HL7 communication. 4

5 Installation Instructions Get the software Sign in at: Navigate to Administration > Gateways. Click the Download Gateway Software button. The file setup.exe will download. Install the software Run, or Save and Run, the setup.exe file. The window: Setup - DICOM Grid Gateway Watchdog will appear. Click Next. Select the destination location, and click Next (default location: C:\Program Files\DICOMGrid). Select the Start Menu folder options, and click Next. Select additional task options, and click Next. On the Ready to Install window, your selections are listed. Click Install to install the DG Gateway Watchdog. When the installation is complete, click Finish. 1: Launch Create Gateway On your desktop, find and double click the Create Gateway icon. 2: Create the Gateway The window: Gateway Watchdog Serial Information will appear. Click Create Gateway. The DG Sign In page will open in your web browser. 5

6 3: Name the Gateway Sign in to DG. You will automatically be taken to the Create Gateway page. On that page, in the Gateway Owner dropdown menu, select the appropriate DG organization, location, or group to which the Gateway will belong. Enter a name in the Gateway name field. Typically, this is the name of the DG organization, location, or group. In the Type dropdown menu, select Gateway. Click Save. 4: Copy/paste the serial number The pop-up: Gateway Installation Instructions will appear. Using copy/paste, copy the Gateway serial number. Go to the window: Gateway Watchdog Serial Information. Paste the serial number into the Serial Number field. Click Validate and Save. The window: Serial number is valid will appear (not shown on left). Click OK in the Serial number is valid window. Click Continue at the bottom of the Gateway Installation Instructions pop-up. Click Sign Out in the upper right corner of the DG web application. Close the web browser. 5: Find the Gateway you created Sign in to DG. Navigate to: Administration > Gateways. You should see the Gateway you created in the list. For most Gateway installs, you can now go to the next step: Connecting a source DICOM (PACS or modality) to the Gateway. If you need to edit your Gateway s properties, click the Edit button to the right of your Gateway s name. Editing options are described in the Edit Gateways Properties section on page 8. 6

7 6: Connecting a Source DICOM Device to the DG Gateway In your source DICOM device (PACS or modality), you will need to enter the following information to connect the source to the DG Gateway: Name A custom name for the Gateway. AE Title The AE Title of the Gateway. By default it is DG_HARVESTER. IP address The IP address of the machine on which the Gateway is being installed. Port number The listening port on the machine on which the Gateway is installed. It must always be one of the ports in the listening_ports field on the Edit Gateway page. Unless changed, it will be ports 104 and To check, in the DG web application, navigate to the Edit Gateway page. Automatically pushing all studies Automatically pushing all studies to the Gateway requires configuration of your DICOM device. This configuration should be set by your PACS administrator. If the DICOM device is only sending studies, the Gateway installation is complete. If the DICOM device is receiving studies, proceed to step 7. 7: Destinations Destinations are DICOM devices that can request or receive studies from a DG Gateway located on the same local area network as the DICOM device. It is not required to enter a destination for DICOM devices that only push studies to DG. Destinations are created after the Gateway is installed. Name A custom name for the destination DICOM device. AE Title The application entity title of the destination DICOM device. IP address The IP address of the destination DICOM device. Port number The designated port used for DICOM communication by the DICOM device. Gateway The DG Gateway that exists on the same local area network as the DICOM device, and from which the DICOM device will request or receive studies. Query/Retrieve Support Indicates whether the DICOM device supports query/retrieve study requests from the DG Gateway. This is only used in conjunction with an HL7 feed. 7

8 Edit Gateway Properties Please note that in most cases, the default settings are fine, and the settings below do not need to be adjusted. If you are considering adjusting the settings below, we advise consulting with DG Support. Gateway name: A custom name for the Gateway. Type: Always Gateway. ae_title: The application entity title of the Gateway. create_phantoms: A true/false value that determines whether studies in progress are shown or not shown. dicom_buffer_size: Used for internal DICOM communication. Value should not be changed unless there is a problem. download_max_threads: The maximum number of threads to use for downloading images to the Gateway from the DG Cloud. download_root_path: The local directory path where downloaded images are stored before being pushed to their end destination. dropbox_root_path: The local directory path where DICOM files to be processed by the Dropbox feature are placed. dropbox_search_interval: The interval, in milliseconds, that the Gateway checks the dropbox_root_path for the existence of DICOM files prior to processing. dropbox_temp_path: The local directory path where DICOM files are temporarily stored by the Dropbox feature during processing. enable_gzip: A true/false value that enables the compression of DICOM images prior to upload. hl7_accession_field: The field in an HL7 message that determines the accession number. hl7_listening_ports: The designated local port used for HL7 communication by the Gateway. hl7_upload_max_attempts: The maximum number of attempts the HL7 component will try to upload HL7 data. hl7_upload_retry_coefficient: The factor in seconds, used to determine the delay before consequent retry attempts. The retry delay is determined by the number of attempts cubed times the HL7_upload_retry_coefficient value; i.e.: [retry delay] = [retry count]3 x [hl7_ upload_retry_coefficient]. implementation_version_name: The DICOM implementation version name for the Gateway. Should never be changed. implementation_version_uid: The DICOM implementation version UID for the Gateway. Should never be changed. ingress_filter: A JSON structure that defines which images will be filtered out based on the value contained in the element specified. listening_ports: The designated local port(s) used for DICOM communication by the Gateway. max_clients: The maximum number of simultaneous DICOM connections permitted by the Gateway. move_client_max_threads: The maximum number of studies that will move from the Gateway to a DICOM device simultaneously. ping_interval: The interval, in milliseconds, that the Gateway attempts to confirm basic communication with, and receive instructions from, the DG Cloud. queue_recovery_interval: The amount of time in milliseconds the Gateway will attempt to recover items that could not make it into the queue system. storage_root_path: The local directory path where DICOM files are stored after processing and then uploaded by the Gateway. submit: An administrative setting, should never be changed. type: Always Harvester. Should never be changed. upload_max_threads: The maximum number of simultaneous uploads by the Gateway to the DG Cloud. use_all_transfer_syntaxes: Enables the Gateway to use an extended set of DICOM transfer syntaxes when transferring images to DICOM destinations. 8