<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: DICOM Query/Retrieve Sensor

The DICOM Query/Retrieve sensor monitors the C-FIND capability of Digital Imaging and Communications in Medicine (DICOM) capable systems and devices. It sends a C-FIND request or Modality Worklist (MWL) query to the target device and counts all found items.

i_round_blueYou can specify search levels to only count specific items.

DICOM Query/Retrieve Sensor

DICOM Query/Retrieve Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • Dutch: DICOM Query/Retrieve
  • French: Recherche / récupération (DICOM)
  • German: DICOM-Abfrage
  • Japanese: DICOM クエリ/取得
  • Portuguese: Consulta/recuperação DICOM
  • Russian: Запрос/получение DICOM
  • Simplified Chinese: DICOM 查询/检索
  • Spanish: Consulta/Recuperación DICOM

Remarks

  • This sensor has a high performance impact. Use it with care. We recommend that you use no more than 200 sensors of this sensor type on each probe.
  • This sensor requires Microsoft .NET 4.7.2 or later on the probe system.
  • This sensor supports the IPv6 protocol.

Detailed Requirements

Requirement

Description

.NET 4.7.2 or later

This sensor requires .NET 4.7.2 or later to be installed on the probe system (on every cluster node, if on a cluster probe).

i_round_redIf the framework is missing, you cannot create this sensor.

i_square_cyanFor more information, see the Knowledge Base: Which .NET version does PRTG require?

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis setting is for your information only. You cannot change it.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

i_round_blueIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

i_round_blueFor performance reasons, it can take some minutes until you can filter for new tags that you added.

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • dicom
  • query
  • retrieve

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority (i_priority_1) to the highest priority (i_priority_5).

i_round_blueUsually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.

DICOM Connection

DICOM Connection

DICOM Connection

Setting

Description

Calling Application Entity Title

Enter the Application Entity Title (AET) of PRTG to initialize a DICOM connection.

i_round_blueThe AET is case sensitive and does not support special characters.

Called Application Entity Title

Enter the AET of the target system to initialize a DICOM connection.

i_round_blueThe AET is case sensitive and does not support special characters.

Port

Enter the port of the DICOM interface to use for the connection.

Timeout (Sec.)

Enter a timeout in seconds for the request. Enter an integer. The maximum timeout value is 900 seconds (15 minutes).

i_round_blueIf the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message.

Query/Retrieve Settings

Query/Retrieve Settings

Query/Retrieve Settings

Setting

Description

C-FIND Level

Define the search level of the C-FIND request:

  • Patient: Retrieve data from the patient column via C-FIND. Enter a search key below.
  • Study: Retrieve data from the study column via C-FIND. Enter a search key and a modality below.
  • Series: Retrieve data from the series column via C-FIND. Enter a search key and a modality below.
  • Worklist: Use an MWL query to retrieve data from the worklist. Enter a filter field, a filter string, and a channel field below.

Search Key

This setting is only visible if you select Patient, Study, or Series above. Enter a key that you want to search for, for example, an instance Unique Identifier (UID), series UID, patient UID, or enter an asterisk (*) to search for all items. Enter a string.

Modality

This setting is only visible if select Study or Series above. Enter a modality in short form that you want to search for, for example, CT, MRI, US, or enter an asterisk (*) to search for all modalities. Enter a string.

Filter Field

This setting is only visible if you select Worklist above. Define a field of the worklist that you want to filter for:

  • Station AET
  • Station Name
  • Modality

Filter String

This setting is only visible if you select Worklist above. Enter a string that you want to filter for, for example, a station name, station AET, modality, or an asterisk (*) to filter for all items. Enter a string.

Channel Field

This setting is only visible if you select Worklist above. Define which field you want to use to name the channels:

  • Station AET
  • Station Name
  • Modality

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result: Do not store the sensor result.
  • Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file names are Result of Sensor [ID].txt, Result of Sensor [ID].Data.txt, and Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

Sensor Display

Sensor Display

Sensor Display

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a graph for each channel.
  • Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
    i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Inherited Settings

By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.

Channel

Description

Avg Query Entry Time

The average query entry time in milliseconds (msec)

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.

Max Query Entry Time

The maximum query entry time in msec

Min Query Entry Time

The minimum query entry time in msec

Total

The total number of items found

i_round_blueThis channel is the primary channel by default.

Total Time

The total time of the C-FIND request or MWL query in msec

i_round_blueThe sensor also adds channels for the number of items in each field it finds.

More

i_square_blueKnowledge Base

Which .NET version does PRTG require?

What security features does PRTG include?