20.1 Launch from the Command Line

Attention! On macOS, command line parameters are not supported.

If the DICOM Viewer has already been launched on the computer, the command line parameters will be sent to the program that has been launched. The program will not be launched again (see ??).

Launching the program from the command line allows you to set specific parameters for the current session of the program, change the settings and get help information about the command line options. To launch the DICOM Viewer use the following syntax on the command line:

[<path_to_the_program>]< executable_program> [ --help] | [--study-folder <path> [--open-series-images | --open-series-mpr | --open-series-volume | --open-series-endoscopy [--series-uid <uid> | --series-index <index>]]] | [--pacs-aetitle <aetitle> [--patient-id <patientID>] [--study-uid <studyUID>] [--series-index <seriesIndex> | --series-uid <seriesUID>] [--open-series-images] ] | [--aet <aet>] | [--import-settings <path> [--use-imported-listener-aetitle | --aet <aet>] [--update-scu-aetitle]] | [--export-settings <path>]

• --help: display the help information about the command line options, exit the program.

• --study-folder <path>: display the study (studies) contained in the specified folder. If there are several studies, then the following options are applied to the first study in the list:

  • --open-series-images: display the first series in the flat image view window

  • --open-series-mpr: display the first series in the multiplanar reconstruction window

  • --open-series-volume: display the first series in the volume reconstruction window

  • --open-series-endoscopy(PRO): display the first series in the virtual endoscopy window

  • Any of these parameters can be used with the following parameters:

    • --series-uid <seriesUID>: show the series with the specified seriesUID

    • --series-index <seriesIndex>: show the series with the specified seriesIndex

• --pacs-aetitle <aetitle>: attempt to open study list from PACSServer which AE Title matches the specified AE Title. The following options can be used with this option in different combinations:

  • --patient-id <patientID>: show the study with the specified patientID. Parameter has higher priority than --study-uid

  • --study-uid <studyUID>: show the series with the specified studyUID

  • --series-uid <seriesUID>: select the series with the specified seriesUID. If several studies are found, the first one on the list is used

  • --series-index <seriesIndex>: select the series with the specified seriesIndex. If several studies are found, the first one on the list is used

  • --open-series-images: display the selected series in the flat image view window. If a series is not selected, the first one of the first study is used

Example: C:\Users\user\DICOMViewerPro1.9.1\viewer.exe --study-folder D:\dicom_data --open-series-images --series-index 1 shows series with seriesIndex 1 of the first study from the D:\dicom_data folder in the Flat images view window.

If the option is wrong, then the help information about the command line options is displayed, and the program exits. If the option value is wrong (e.g. there are not DICOM data in the specified folder, there is no series with the specified seriesUID or seriesIndex), then this and all subsequent options are ignored.

Attention! If some AE Titles of several PACSServers match, then data will be searched on the first PACSServer on the list. PACSServers are sorted by the "Server nickname" field.

For details on how to set up connection to PACSServer, see Section 13.2.

The length of AE Title value shall not exceed 16 characters. Cyrillic letters and "\" symbols in AE titles are not allowed.

The following options are used to change the settings. After executing any of these commands, the program exits. In case of a successful execution, the word Done appears on the command line.

• --aet <aetitle>: parameter AE Title for DICOM Listener is set to <aetitle>

• --import-settings <file>: imports settings from <file>

  • --use-imported-listener-aetitle: parameter AE Title for DICOM Listener is set to value from <file>

    • if the option --aet <aetitle> is used at the same time then AE Title for DICOM Listener is set to <aetitle>

  • --update-scu-aetitle: Client name (SCU) for PACS Servers of the DICOM Listener will remain the current

    • if the option --aet <aetitle> is used at the same time then Client name (SCU) for PACS Servers is set to <aetitle>

• --export-settings <file>: exports settings to <file>.