Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/worklists-plugin.rst @ 358:011b01ccf52d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fixing external hyperlinks
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 30 Mar 2020 18:47:35 +0200
parents b879a6274065
children d217af5e6cb3
comparison
equal deleted inserted replaced
357:6b432ce3a56e 358:011b01ccf52d
10 :ref:`FAQ <worklist>`. 10 :ref:`FAQ <worklist>`.
11 11
12 The sample plugin will serve the worklists stored in some folder on 12 The sample plugin will serve the worklists stored in some folder on
13 the filesystem. This mimics the behavior of the ``wlmscpfs`` 13 the filesystem. This mimics the behavior of the ``wlmscpfs``
14 command-line tool from the `DCMTK software 14 command-line tool from the `DCMTK software
15 <http://support.dcmtk.org/docs/wlmscpfs.html>`__. 15 <https://support.dcmtk.org/docs/wlmscpfs.html>`__.
16 16
17 The worklists to be served must be put inside the folder of interest 17 The worklists to be served must be put inside the folder of interest
18 by an external application or script (note: files must have a ``.wl`` extension). ``dump2dcm`` might be a very 18 by an external application or script (note: files must have a ``.wl`` extension). ``dump2dcm`` might be a very
19 `useful companion tool 19 `useful companion tool
20 <http://support.dcmtk.org/docs/dump2dcm.html>`__ to generate such 20 <https://support.dcmtk.org/docs/dump2dcm.html>`__ to generate such
21 worklist files. Whenever a C-Find SCP request is issued to Orthanc, 21 worklist files. Whenever a C-Find SCP request is issued to Orthanc,
22 the plugin will read the content of the folder of interest to locate 22 the plugin will read the content of the folder of interest to locate
23 the worklists that match the request. As a consequence, the external 23 the worklists that match the request. As a consequence, the external
24 application can dynamically modify the content of this folder while 24 application can dynamically modify the content of this folder while
25 Orthanc is running to add/remove worklists. 25 Orthanc is running to add/remove worklists.
60 The folder ``WorklistsDatabase`` of the `source distribution of 60 The folder ``WorklistsDatabase`` of the `source distribution of
61 Orthanc 61 Orthanc
62 <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/ModalityWorklists/>`__ 62 <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/ModalityWorklists/>`__
63 contains a database of sample worklists, that comes from the DCMTK 63 contains a database of sample worklists, that comes from the DCMTK
64 source distribution, as described in the `FAQ entry #37 of the DCMTK 64 source distribution, as described in the `FAQ entry #37 of the DCMTK
65 project <http://forum.dcmtk.org/viewtopic.php?t=84>`__. 65 project <https://forum.dcmtk.org/viewtopic.php?t=84>`__.
66 66
67 67
68 Tutorial 68 Tutorial
69 -------- 69 --------
70 70
71 .. highlight:: javascript 71 .. highlight:: javascript
72 72
73 - Download `DCMTK utilities 73 - Download `DCMTK utilities
74 <http://dicom.offis.de/download/dcmtk/release/bin/>`__. 74 <https://dicom.offis.de/download/dcmtk/release/bin/>`__.
75 - Download sample `worklist files 75 - Download sample `worklist files
76 <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/ModalityWorklists/>`__ 76 <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/ModalityWorklists/>`__
77 from the Orthanc source code and copy them in a dedicated folder. 77 from the Orthanc source code and copy them in a dedicated folder.
78 - Generate the :ref:`default configuration of Orthanc <configuration>`. 78 - Generate the :ref:`default configuration of Orthanc <configuration>`.
79 - Enable the ModalityWorklist plugin in your configuration file by adding this section:: 79 - Enable the ModalityWorklist plugin in your configuration file by adding this section::
91 "ModalityWorklists.dll" // On GNU/Linux, use libModalityWorklists.so 91 "ModalityWorklists.dll" // On GNU/Linux, use libModalityWorklists.so
92 ], 92 ],
93 93
94 - The tests below will be done using the ``findscu`` command-line tool 94 - The tests below will be done using the ``findscu`` command-line tool
95 from the `DCMTK utilities 95 from the `DCMTK utilities
96 <http://support.dcmtk.org/docs/findscu.html>`__. Assuming 96 <https://support.dcmtk.org/docs/findscu.html>`__. Assuming
97 ``findscu`` and Orthanc runs on the same computer (i.e. on the 97 ``findscu`` and Orthanc runs on the same computer (i.e. on the
98 ``127.0.0.1`` localhost), declare the ``FINDSCU`` AET to the list of 98 ``127.0.0.1`` localhost), declare the ``FINDSCU`` AET to the list of
99 know modalities:: 99 know modalities::
100 100
101 "DicomModalities" : { 101 "DicomModalities" : {
182 Troubleshooting C-Find queries 182 Troubleshooting C-Find queries
183 ------------------------------ 183 ------------------------------
184 184
185 When trying to retrieve worklists from a modality, one usually don't get debugging capabilities from the modality itself. 185 When trying to retrieve worklists from a modality, one usually don't get debugging capabilities from the modality itself.
186 Therefore, it is usually convenient to mimic the modality with ``findscu`` (provided by `DCMTK software 186 Therefore, it is usually convenient to mimic the modality with ``findscu`` (provided by `DCMTK software
187 <http://support.dcmtk.org/docs/wlmscpfs.html>`__). 187 <https://support.dcmtk.org/docs/wlmscpfs.html>`__).
188 188
189 - First, you should make sure that you have configured the Worklist plugin correctly and that you have pushed 189 - First, you should make sure that you have configured the Worklist plugin correctly and that you have pushed
190 at least a ``.wl`` file in the worklist database. For this, you should issue this kind of command:: 190 at least a ``.wl`` file in the worklist database. For this, you should issue this kind of command::
191 191
192 findscu -W 127.0.0.1 4242 -k 0008,0050="*" 192 findscu -W 127.0.0.1 4242 -k 0008,0050="*"