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

NAME

6       dcmqrti - The Terminal Initiator Telnet Client Program
7

SYNOPSIS

9       dcmqrti [options] peer...
10

DESCRIPTION

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

PARAMETERS

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

OPTIONS

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

NOTES

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

LOGGING

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

COMMAND LINE

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

ENVIRONMENT

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

FILES

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

SEE ALSO

400       dcmqrscp(1)
401
403       Copyright  (C)  1993-2010  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
404       Germany.
405
406
407
408Version 3.6.0                     6 Jan 2011                        dcmqrti(1)
Impressum