1dcmqrti(1)                        OFFIS DCMTK                       dcmqrti(1)
2
3
4

NAME

6       dcmqrti - The Terminal Initiator Telnet Client Program
7
8

SYNOPSIS

10       dcmqrti [options] peer...
11

DESCRIPTION

13       The  dcmqrti  program  (telnet  initiator)  is an interactive character
14       based program intended to be used  for  examining  the  dcmqrscp  image
15       databases and sending images contained within these databases to Vendor
16       nodes.  During  a  DICOM  Demonstration  the  dcmqrti  program  can  be
17       activated by a Vendor by logging onto the computer running the dcmqrscp
18       program. Each vendor will have their own login account and the  dcmqrti
19       program will be started instead of a normal shell when they login.
20
21       The  dcmqrti  program  takes  one main argument, the hostname or vendor
22       symbolic name (from the VendorTable in the  configuration  file)  of  a
23       Vendor.  It  then  searches in the configuration file for all AE titles
24       associated with this hostname or vendor name,  and  all  storage  areas
25       accessible  to  these AE titles. Thus only the accessible databases and
26       peer applications discovered in the configuration file are available as
27       choices within the dcmqrti user interface.
28

PARAMETERS

30       peer  peer host name or symbolic name from cfg file
31

OPTIONS

33   general options
34         -h    --help
35                 print this help text and exit
36
37               --version
38                 print version information and exit
39
40               --arguments
41                 print expanded command line arguments
42
43         -q    --quiet
44                 quiet mode, print no warnings and errors
45
46         -v    --verbose
47                 verbose mode, print processing details
48
49         -d    --debug
50                 debug mode, print debug information
51
52         -ll   --log-level  [l]evel: string constant
53                 (fatal, error, warn, info, debug, trace)
54                 use level l for the logger
55
56         -lc   --log-config  [f]ilename: string
57                 use config file f for the logger
58
59         -c    --config  [f]ilename: string
60                 use specific configuration file
61                 (default: /usr/local/etc/dcmqrscp.cfg)
62
63   network options
64         -to   --timeout  [s]econds: integer (default: unlimited)
65                 timeout for connection requests
66
67         -ta   --acse-timeout  [s]econds: integer (default: 30)
68                 timeout for ACSE messages
69
70         -td   --dimse-timeout  [s]econds: integer (default: unlimited)
71                 timeout for DIMSE messages
72
73         -xi   --propose-implicit
74                 propose implicit VR little endian TS only
75
76         -aet  --aetitle  [a]etitle: string
77                 set my AE title (default: TELNET_INITIATOR)
78
79         -pdu  --max-pdu  [n]umber of bytes: integer (4096..131072)
80                 set max receive pdu to n bytes
81                 (default: use value from configuration file)
82
83   other options
84         -u    --disable-new-vr
85                 disable support for new VRs, convert to OB
86
87         -rmt  --remote  [t]itle: string
88                 connect to remote database defined in cfg file
89

dcmqrti_NOTES

91   Commands
92       All  commands can be abbreviated. An abbreviation is allowed if it does
93       not conflict with another command.
94
95   'help' Command
96       The 'help' command gives a  summary  of  all  available  commands.  Its
97       output  is  shown  underneath.  In  order to separate the examples from
98       surrounding text, all examples are bracketed  by  dashed  lines.  These
99       lines do not appear when running the program.
100
101       ------------------------------------------------------------
102       Command Summary:
103       help                list this summary
104       ?                   short help
105       title [#]           list [set] current peer AE title
106       database [#]        list [set] current database
107       study [#]           list [set] current study
108       series [#]          list [set] current series
109       image [#]           list [set] current image
110       display [#]         display current [specific] image
111       send study [#]      send current [specific] study
112       send series [#]     send current [specific] series
113       send image [#]      send current [specific] image
114       echo [#]            verify connectivity [# times]
115       quit                quit program
116       exit                synonym for quit
117       ------------------------------------------------------------
118
119   'title' Command
120       The  'title'  command  without  an argument allows the user to list the
121       known remote Application Entities (AE). An example  output  might  look
122       like:
123
124       ------------------------------------------------------------
125       Peer AE Titles:
126            Peer AE          HostName:PortNumber
127       * 0) ACME1            (swallow:2001)
128         1) ACME2            (swallow:2002)
129         2) UNITED1          (kolibri:2001)
130         3) UNITED2          (kolibri:2002)
131       ------------------------------------------------------------
132
133       The current peer AE is marked with an asterisk (*). Each peer AE has an
134       index (second column) which can be used as an argument to  the  'title'
135       command in order to set the current peer AE. The third column gives the
136       AE title of the peer AE. The  fourth  column  shows  the  hostname  and
137       TCP/IP port number of the peer AE.
138
139       When  invoked  with an argument index, the 'title' command will set the
140       current peer AE. The  dcmqrti  program  will  attempt  to  initiate  an
141       association   to   the   current   peer   AE   when  asked  to  send  a
142       study/series/image or to send an echo.
143
144   'database' Command
145       The 'database' command without an argument allows the user to list  the
146       know local databases (these correspond to dcmqrscp's Application Entity
147       Titles). An example output might look like:
148
149       ------------------------------------------------------------
150       Database Titles:
151            Database
152       * 0) COMMON
153         1) ACME_QUERY
154         2) ACME_STORE
155         3) UNITED_QUERY
156       ------------------------------------------------------------
157
158       The current database is marked with an asterisk (*). Each database  has
159       an  index  (second  column)  which  can  be  used as an argument to the
160       'database' command in order to set  the  current  database.  The  third
161       column  shows  the  name of the database (i.e. the dcmqrscp Application
162       Entity title for the particular storage area).
163
164       When invoked with an argument index, the 'database'  command  will  set
165       the  current  database.  The  current database is used as the basis for
166       further database specific actions.
167
168   'study' Command
169       The 'study' command with no argument lists the studies in  the  current
170       database. An example output might look like:
171
172       ------------------------------------------------------------
173             Patient                        PatientID    StudyID
174       *  0) JACKSON^ANDREW^^^              M4997106     20001
175          1) GRANT^MARY^^^                  F4997108     20002
176          2) ARTHUR^CHESTER^^^              M4997107     20003
177          3) JEFFERSON^THOMAS^^^            M4997096     9465
178          4) MADISON^DOLLY^^^               F4997097     9443
179
180       4 Studies in Database: COMMON
181       ------------------------------------------------------------
182
183       The  current  study  is  marked with an asterisk (*). Each study has an
184       index (second column) which can be used as an argument to  the  'study'
185       command  in  order to set the current study. The third column shows the
186       patient name, the fourth column the patient ID and the fifth column the
187       study ID.
188
189       When  invoked  with an argument index, the 'study' command will set the
190       current study. The current study is used as the basis for further study
191       specific actions.
192
193   'series' Command
194       The  'series'  command with no argument lists the series in the current
195       study. An example output might look like:
196
197       ------------------------------------------------------------
198             Series Modality SeriesInstanceUID
199       *  0) 1      MR       1.2.840.113654.2.3.1993.201
200          1) 2      MR       1.2.840.113654.2.3.1993.202
201          2) 3      MR       1.2.840.113654.2.3.1993.203
202          3) 4      MR       1.2.840.113654.2.3.1993.204
203          4) 5      MR       1.2.840.113654.2.3.1993.205
204
205       5 Series in StudyID 05381,
206         Patient: MONROE^JAMES^^^ (Database: COMMON)
207       ------------------------------------------------------------
208
209       The current series is marked with an asterisk (*). Each series  has  an
210       index  (second column) which can be used as an argument to the 'series'
211       command in order to set the current series. The third column shows  the
212       series  number,  the  fourth  column the series modality, and the fifth
213       column the series instance UID.
214
215       When invoked with an argument index, the 'series' command will set  the
216       current  series.  The  current  series is used as the basis for further
217       series specific actions.
218
219   'image' Command
220       The 'image' command with no argument lists the images  in  the  current
221       series. An example output might look like:
222
223       ------------------------------------------------------------
224             Image ImageInstanceUID
225       *  0) 1     1.2.840.113654.2.3.1993.9.123.6.2674
226          1) 2     1.2.840.113654.2.3.1993.9.123.6.2675
227          2) 3     1.2.840.113654.2.3.1993.9.123.6.2676
228          3) 4     1.2.840.113654.2.3.1993.9.123.6.2677
229          4) 5     1.2.840.113654.2.3.1993.9.123.6.2678
230          5) 6     1.2.840.113654.2.3.1993.9.123.6.2679
231          6) 7     1.2.840.113654.2.3.1993.9.123.6.2680
232          7) 8     1.2.840.113654.2.3.1993.9.123.6.2681
233          8) 9     1.2.840.113654.2.3.1993.9.123.6.2682
234          9) 10    1.2.840.113654.2.3.1993.9.123.6.2683
235         10) 11    1.2.840.113654.2.3.1993.9.123.6.2684
236         11) 12    1.2.840.113654.2.3.1993.9.123.6.2685
237         12) 13    1.2.840.113654.2.3.1993.9.123.6.2686
238
239       13 Images in MR Series, StudyID 05381,
240         Patient: MONROE^JAMES^^^ (Database: COMMON)
241       ------------------------------------------------------------
242
243       The  current  image  is  marked with an asterisk (*). Each image has an
244       index (second column) which can be used as an argument to  the  'image'
245       command  in  order to set the current image. The third column shows the
246       image number, and  the  fourth  column  the  image  instance  UID  (SOP
247       Instance UID).
248
249       When  invoked  with an argument index, the 'image' command will set the
250       current image. The current image is used as the basis for further image
251       specific actions.
252
253   'display' Command
254       The  display command serves no purpose in the current version of DCMTK.
255       It was used in prior releases to request the  CTN  Display  Program  to
256       display an image.
257
258   'send' Command
259       The  'send'  command allows a complete study/series or individual image
260       to be stored on a remote AE. When this command is invoked, the  dcmqrti
261       program  will  operate  as a SCU of the DICOM Storage Service Class and
262       attempt to initiate an association with the current  peer  AE  (defined
263       via  the  'title'  command).  Presentation  contexts  for  all relevant
264       Storage SOP Classes will be proposed. An attempt will be made to  store
265       all  specified  images.  If no association could be negotiated an error
266       message will be printed.  If  an  storage  operation  fails  or  if  no
267       appropriate presentation context is available and error message will be
268       printed.
269
270       The "send" command exists in three forms:
271
272               send study [#]
273               send series [#]
274               send image [#]
275
276       The 'study' keyword means send all images in the  current  study.  When
277       invoked  with  an  argument  index,  the specified study in the current
278       database will be stored. The 'series' keyword means send all images  in
279       the  current series. When invoked with an argument index, the specified
280       series in the current study will be stored. The 'image'  keyword  means
281       send  the  current  image.  When  invoked  with  an argument index, the
282       specified image in the current series will be stored.
283
284       When an image is stored, a message will be printed of the form:
285
286       ------------------------------------------------------------
287       New Association Started (swallow:2001,ACME1)
288       [MsgID 1] Store,
289         PatientName: JACKSON^ANDREW^^^, StudyID: 20001,
290         Series: 2, Modality: CR, Image: 1,
291         Image UID: 1.2.840.113654.2.3.1993.9.123.6.1834
292         0%________25%_________50%__________75%________100%
293         --------------------------------------------------
294       [MsgID 1] Complete [Status: Success]
295       Released Association (swallow:2001,ACME1)
296       ------------------------------------------------------------
297
298
299   'echo' Command
300       The 'echo' command allows the user  to  verify  connectivity  with  the
301       current  peer  AE  (defined via the 'title' command). When invoked, the
302       dcmqrti program acts as an SCU of the Verification Service Class.
303
304       When invoked without an argument, only one C-ECHO message is generated.
305       When  invoked with an argument, the specified number of C-ECHO messages
306       will be sent. A message will be printed of the form:
307
308       ------------------------------------------------------------
309       New Association Started (localhost:2001,CMOVE)
310       [MsgID 1] Echo, Complete [Status: Success]
311       Released Association (localhost:2001,CMOVE)
312       ------------------------------------------------------------
313
314   'quit', 'exit' Commands
315       The 'quit' and 'exit' commands have the same effect. They terminate the
316       dcmqrti program.
317
318   DICOM Conformance
319       The  dcmqrti application supports the same set of SOP Classes as an SCU
320       as the dcmqrscp application - see dcmqrscp documentation.
321
322       The dcmqrti application will propose presentation contexts for  all  of
323       the abovementioned supported SOP Classes using the transfer syntaxes:
324
325       LittleEndianImplicitTransferSyntax  1.2.840.10008.1.2
326       LittleEndianExplicitTransferSyntax  1.2.840.10008.1.2.1
327       BigEndianExplicitTransferSyntax     1.2.840.10008.1.2.2
328
329       The dcmqrti application does not support extended negotiation.
330
331   Configuration
332       The  dcmqrti  program  uses the same configuration file as the dcmqrscp
333       program. See the documentation on configuration  for  more  information
334       (dcmqrcnf.txt and the example configuration file dcmqrscp.cfg).
335

LOGGING

337       The  level  of  logging  output  of  the various command line tools and
338       underlying libraries can be specified by the  user.  By  default,  only
339       errors  and  warnings  are  written to the standard error stream. Using
340       option --verbose also informational messages  like  processing  details
341       are  reported.  Option  --debug  can be used to get more details on the
342       internal activity, e.g. for debugging purposes.  Other  logging  levels
343       can  be  selected  using option --log-level. In --quiet mode only fatal
344       errors are reported. In such very severe error events, the  application
345       will  usually  terminate.  For  more  details  on the different logging
346       levels, see documentation of module 'oflog'.
347
348       In case the logging output should be written to file  (optionally  with
349       logfile  rotation),  to syslog (Unix) or the event log (Windows) option
350       --log-config can be used.  This  configuration  file  also  allows  for
351       directing  only  certain messages to a particular output stream and for
352       filtering certain messages based on the  module  or  application  where
353       they  are  generated.  An  example  configuration  file  is provided in
354       <etcdir>/logger.cfg.
355

COMMAND LINE

357       All command line tools  use  the  following  notation  for  parameters:
358       square  brackets  enclose  optional  values  (0-1), three trailing dots
359       indicate that multiple values are allowed (1-n), a combination of  both
360       means 0 to n values.
361
362       Command line options are distinguished from parameters by a leading '+'
363       or '-' sign, respectively. Usually, order and position of command  line
364       options  are  arbitrary  (i.e.  they  can appear anywhere). However, if
365       options are mutually exclusive the rightmost appearance is  used.  This
366       behavior  conforms  to  the  standard  evaluation  rules of common Unix
367       shells.
368
369       In addition, one or more command files can be specified  using  an  '@'
370       sign  as  a  prefix to the filename (e.g. @command.txt). Such a command
371       argument is replaced by the content  of  the  corresponding  text  file
372       (multiple  whitespaces  are  treated  as a single separator unless they
373       appear between two quotation marks) prior to  any  further  evaluation.
374       Please  note  that  a command file cannot contain another command file.
375       This simple but effective  approach  allows  one  to  summarize  common
376       combinations  of  options/parameters  and  avoids longish and confusing
377       command lines (an example is provided in file <datadir>/dumppat.txt).
378

ENVIRONMENT

380       The dcmqrti utility  will  attempt  to  load  DICOM  data  dictionaries
381       specified  in the DCMDICTPATH environment variable. By default, i.e. if
382       the  DCMDICTPATH  environment   variable   is   not   set,   the   file
383       <datadir>/dicom.dic  will be loaded unless the dictionary is built into
384       the application (default for Windows).
385
386       The  default  behavior  should  be  preferred   and   the   DCMDICTPATH
387       environment  variable  only used when alternative data dictionaries are
388       required. The DCMDICTPATH environment variable has the same  format  as
389       the  Unix  shell PATH variable in that a colon (':') separates entries.
390       On Windows systems, a semicolon (';') is used as a separator. The  data
391       dictionary  code  will  attempt  to  load  each  file  specified in the
392       DCMDICTPATH environment variable. It is an error if no data  dictionary
393       can be loaded.
394

FILES

396       <docdir>/dcmqrcnf.txt - configuration information
397       <docdir>/dcmqrset.txt - setup information
398       <etcdir>/dcmqrscp.cfg - example configuration file
399

SEE ALSO

401       dcmqrscp(1)
402
404       Copyright  (C)  1993-2022  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
405       Germany.
406
407
408
409Version 3.6.7                   Fri Apr 22 2022                     dcmqrti(1)
Impressum