Mercurial > hg > orthanc-book
annotate Sphinx/source/users/lua.rst @ 319:be69f8c86f56
Lua events for deleted/updated resources
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 19 Feb 2020 14:26:05 +0100 |
parents | 443af82172b0 |
children | e4e9cca89c64 |
rev | line source |
---|---|
0 | 1 .. _lua: |
2 | |
3 Server-side scripting with Lua | |
4 ============================== | |
5 | |
6 .. contents:: | |
7 | |
8 Since release 0.5.2, Orthanc supports server-side scripting through | |
25 | 9 the `Lua <https://en.wikipedia.org/wiki/Lua_(programming_language)>`__ |
0 | 10 scripting language. Thanks to this major feature, Orthanc can be tuned |
11 to specific medical workflows without being driven by an external | |
12 script. This page summarizes the possibilities of Orthanc server-side | |
13 scripting. | |
14 | |
15 Many other examples are `available in the source distribution | |
16 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Lua/>`__. | |
17 | |
18 | |
75 | 19 Installing a Lua script |
0 | 20 ----------------------- |
21 | |
22 .. highlight:: bash | |
23 | |
24 A custom Lua script can be installed either by the :ref:`configuration | |
25 file <configuration>`, or by uploading it | |
26 through the :ref:`REST API <rest-samples>`. | |
27 | |
28 To install it by the **configuration file** method, you just have to | |
29 specify the path to the file containing the Lua script in the | |
30 ``LuaScripts`` variable. | |
31 | |
32 To upload a script stored in the file "``script.lua``" through the | |
33 **REST API**, use the following command:: | |
34 | |
35 $ curl -X POST http://localhost:8042/tools/execute-script --data-binary @script.lua | |
36 | |
37 Pay attention to the fact that, contrarily to the scripts installed | |
38 from the configuration file, the scripts installed through the REST | |
39 API are non-persistent: They are discarded after a restart of Orthanc, | |
40 which makes them useful for script prototyping. You can also interpret | |
41 a single Lua command through the REST API:: | |
42 | |
43 $ curl -X POST http://localhost:8042/tools/execute-script --data-binary "print(42)" | |
44 | |
45 *Note:* The ``--data-binary`` cURL option is used instead of | |
46 ``--data`` to prevent the interpretation of newlines by cURL, which is | |
47 `mandatory for the proper evaluation | |
25 | 48 <http://stackoverflow.com/questions/3872427/how-to-send-line-break-with-curl>`__ of the possible |
0 | 49 comments inside the Lua script. |
50 | |
51 | |
52 Lua API | |
53 ------- | |
54 | |
55 | |
56 .. _lua-callbacks: | |
57 | |
58 Callbacks to react to events | |
59 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
60 | |
61 The Lua engine of Orthanc comes invokes the following callbacks that | |
62 are triggered on various events. Here are the **generic events**: | |
63 | |
64 * ``function Initialize()``: Invoked as soon as the Orthanc server is started. | |
65 * ``function Finalize()``: Invoked just before the Orthanc server is stopped. | |
66 | |
67 Some **permission-related events** allow to filter incoming requests: | |
68 | |
69 * ``function ReceivedInstanceFilter(dicom, origin)``: | |
70 Invoked to known whether an incoming DICOM instance should be | |
71 accepted. :ref:`See this section <lua-filter-dicom>`. The ``origin`` | |
72 parameter is :ref:`documented separately <lua-origin>`. | |
73 * ``function IncomingHttpRequestFilter(method, uri, ip, username, | |
74 httpHeaders)``: Invoked to known whether a REST request should be | |
75 accepted. :ref:`See this section <lua-filter-rest>`. | |
76 | |
232 | 77 Some **job-related events** allow to react to :ref:`job <jobs>` completion/failure: |
78 | |
79 * ``function OnJobSubmitted(jobId)``: | |
80 Invoked when a new job has been submitted. Note that this does not | |
81 mean the the job execution has started. | |
82 * ``function OnJobFailure(jobId)``: | |
83 Invoked when a job has failed. | |
84 * ``function OnJobSuccess(jobId)``: | |
85 Invoked when a job has completed successfully. | |
86 | |
0 | 87 Some **DICOM-related events** allow to react to the reception of |
88 new medical images: | |
89 | |
90 * ``function OnStoredInstance(instanceId, tags, metadata, origin)``: | |
91 Invoked whenever a new instance has been stored into Orthanc. | |
92 This is especially useful for :ref:`lua-auto-routing`. The ``origin`` | |
93 parameter is :ref:`documented separately <lua-origin>`. | |
94 * ``function OnStablePatient(patientId, tags, metadata)``: Invoked | |
95 whenever a patient has not received any new instance for a certain | |
96 amount of time (cf. the option ``StableAge`` in the | |
97 :ref:`configuration file <configuration>`). The :ref:`identifier | |
98 <orthanc-ids>` of the patient is provided, together with her DICOM | |
78 | 99 tags and her :ref:`metadata <metadata>`. |
0 | 100 * ``function OnStableSeries(seriesId, tags, metadata)``: Invoked |
101 whenever a series has not received any new instance for a certain | |
102 amount of time. | |
103 * ``function OnStableStudy(studyId, tags, metadata)``: Invoked | |
104 whenever a study has not received any new instance for a certain | |
105 amount of time. | |
106 * ``function IncomingFindRequestFilter(source, origin)``: Invoked | |
107 whenever Orthanc receives an incoming C-Find query through the DICOM | |
108 protocol. This allows to inspect the content of the C-Find query, | |
109 and possibly modify it if a patch is needed for some manufacturer. A | |
110 `sample script is available | |
111 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Lua/IncomingFindRequestFilter.lua>`__. | |
112 | |
319
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
113 Some other **resource-related events** are available: |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
114 |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
115 * ``function OnDeletedPatient(patientId)``: Invoked when a patient has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
116 been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
117 * ``function OnDeletedStudy(studyId)``: Invoked when a study has been |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
118 removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
119 * ``function OnDeletedSeries(seriesId)``: Invoked when a series has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
120 been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
121 * ``function OnDeletedInstance(instanceId)``: Invoked when a instance |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
122 has been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
123 * ``function OnUpdatedPatient(patientId)``: Invoked when some metadata |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
124 or some attachment associated with the given patient has been |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
125 updated (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
126 * ``function OnUpdatedStudy(studyId)``: Invoked when some metadata or |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
127 some attachment associated with the given study has been updated |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
128 (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
129 * ``function OnUpdatedSeries(seriesId)``: Invoked when some metadata |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
130 or some attachment associated with the given series has been updated |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
131 (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
132 * ``function OnUpdatedInstance(instanceId)``: Invoked when some |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
133 metadata or some attachment associated with the given instance has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
134 been updated (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
135 |
64
a3df3c2b68cf
import the documentation of the Worklists sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
136 Furthermore, whenever a DICOM association is negotiated for C-Store |
0 | 137 SCP, several callbacks are successively invoked to specify which |
138 **transfer syntaxes** are accepted for the association. These | |
139 callbacks are listed in `this sample script | |
140 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Lua/TransferSyntaxEnable.lua>`__. | |
141 | |
142 *Note:* All of these callbacks are guaranteed to be **invoked in | |
143 mutual exclusion**. This implies that Lua scripting in Orthanc does | |
144 not support any kind of concurrency. | |
145 | |
146 | |
147 .. _lua-rest: | |
148 | |
149 Calling the REST API of Orthanc | |
150 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
151 | |
152 Lua scripts have :ref:`full access to the REST API <rest>` of Orthanc | |
153 through the following functions: | |
154 | |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
155 * ``RestApiGet(uri, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
156 * ``RestApiPost(uri, body, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
157 * ``RestApiPut(uri, body, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
158 * ``RestApiDelete(uri, builtin, headers)`` |
0 | 159 |
237 | 160 Here is a description of the parameters: |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
161 |
237 | 162 * ``uri`` specifies the resource being accessed |
163 (e.g. ``/instances``). It must not include the URL schema | |
164 (protocol), hostname or port. | |
0 | 165 |
237 | 166 * In the context of a POST or PUT request, ``body`` is a string |
167 containing the body of the request | |
168 (e.g. ``{"Keep":"StudyDate"}``). This string will often correspond | |
169 to a JSON-formatted version of a `Lua table | |
170 <http://lua-users.org/wiki/TablesTutorial>`__. The ``DumpJson()`` | |
171 function (see below) is very useful to achieve this conversion from | |
172 a Lua table to a plain string. | |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
173 |
237 | 174 * ``builtin`` is an optional Boolean that specifies whether the |
175 request targets only the built-in REST API of Orthanc (if set to | |
176 ``true``), or the full the REST API after being tainted by plugins | |
177 (if set to ``false``). | |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
178 |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
179 * ``headers`` is an optional argument and was added in release |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
180 1.5.7. It allows to provide the REST API endpoint with HTTP headers. |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
181 |
237 | 182 .. highlight:: bash |
183 | |
184 For instance:: | |
185 | |
186 RestApiPost('/instances/5af318ac-78fb-47ff-b0b0-0df18b0588e0/anonymize', '{}') | |
187 | |
0 | 188 |
189 General-purpose functions | |
190 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
191 | |
192 The Lua engine of Orthanc contain several general-purpose ancillary | |
193 functions: | |
194 | |
195 * ``PrintRecursive(v)`` recursively prints the content of a `Lua table | |
196 <http://www.lua.org/pil/2.5.html>`__ to the log file of Orthanc. | |
197 * ``ParseJson(s)`` converts a string encoded in the `JSON format | |
198 <https://en.wikipedia.org/wiki/JSON>`__ to a Lua table. | |
199 * ``DumpJson(v, keepStrings)`` encodes a Lua table as a JSON string. | |
200 Setting the optional argument ``keepStrings`` (available from | |
201 release 0.9.5) to ``true`` prevents the automatic conversion of | |
202 strings to integers. | |
203 * ``GetOrthancConfiguration()`` returns a Lua table containing the | |
204 content of the :ref:`configuration files <configuration>` of | |
205 Orthanc. | |
206 | |
207 | |
208 Similarly to the functions to :ref:`call the REST API of Orthanc | |
209 <lua-rest>`, several functions are available to make generic HTTP | |
210 requests to Web services: | |
211 | |
90 | 212 * ``HttpGet(url, headers)`` |
213 * ``HttpPost(url, body, headers)`` | |
214 * ``HttpPut(url, body, headers)`` | |
215 * ``HttpDelete(url, headers)`` | |
0 | 216 * ``SetHttpCredentials(username, password)`` can be used to setup the |
217 HTTP credentials. | |
218 | |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
219 The ``headers`` argument is optional and was added in release |
91 | 220 1.2.1. It allows to set the HTTP headers for the HTTP client request. |
0 | 221 |
283 | 222 Example:: |
223 | |
224 local preview = RestApiGet('/instances/' .. instanceId .. '/preview') | |
225 local headers = { | |
226 ["content-type"] = "image/png", | |
227 } | |
228 HttpPost("http://localhost/my-web-service/instance-preview", preview, headers) | |
229 | |
0 | 230 .. _lua-origin: |
231 | |
232 Origin of the instances | |
233 ^^^^^^^^^^^^^^^^^^^^^^^ | |
234 | |
235 Whenever Orthanc decides whether it should should store a new instance | |
236 (cf. the ``ReceivedInstanceFilter()`` callback), or whenever it has | |
237 actually stored a new instance (cf. the ``OnStoredInstance`` | |
238 callback), an ``origin`` parameter is provided. This parameter is a | |
239 `Lua table <http://www.lua.org/pil/2.5.html>`__ that describes from | |
240 which Orthanc subsystem the new instance comes from. | |
241 | |
242 There are 4 possible subsystems, that can be distinguished according | |
243 to the value of ``origin["RequestOrigin"]``: | |
244 | |
245 * ``RestApi``: The instance originates from some HTTP request to the REST | |
246 API. In this case, the ``RemoteIp`` and ``Username`` fields are | |
247 available in ``origin``. They respectively describe the IP address | |
248 of the HTTP client, and the username that was used for HTTP | |
249 authentication (as defined in the ``RegisteredUsers`` | |
250 :ref:`configuration variable <configuration>`). | |
251 * ``DicomProtocol``: The instance originates from a DICOM C-Store. | |
252 The fields ``RemoteIp``, ``RemoteAet`` and ``CalledAet`` | |
253 respectively provide the IP address of the DICOM SCU (client), the | |
254 application entity title of the DICOM SCU client, and the | |
255 application entity title of the Orthanc SCP server. The | |
256 ``CalledAet`` can be used for :ref:`advanced auto-routing scenarios | |
257 <lua-auto-routing>`, when a single instance of Orthanc acts as a | |
258 proxy for several DICOM SCU clients. | |
259 * ``Lua``: The instance originates from a Lua script. | |
260 * ``Plugins``: The instance originates from a plugin. | |
261 | |
262 | |
263 .. _lua-filter-dicom: | |
264 | |
75 | 265 Filtering incoming DICOM instances |
0 | 266 ---------------------------------- |
267 | |
268 .. highlight:: lua | |
269 | |
270 Each time a DICOM instance is received by Orthanc (either through the | |
271 DICOM protocol or through the REST API), the | |
272 ``ReceivedInstanceFilter()`` Lua function is invoked. If this callback | |
273 returns ``true``, the instance is accepted for storage. If it returns | |
274 ``false``, the instance is discarded. This mechanism can be used to | |
275 filter the incoming DICOM instances. Here is an example of a Lua | |
276 filter that only allows incoming instances of MR modality:: | |
277 | |
278 function ReceivedInstanceFilter(dicom, origin) | |
279 -- Only allow incoming MR images | |
280 if dicom.Modality == 'MR' then | |
281 return true | |
282 else | |
283 return false | |
284 end | |
285 end | |
286 | |
287 The argument dicom corresponds to a `Lua table | |
288 <http://www.lua.org/pil/2.5.html>`__ (i.e. an associative array) that | |
289 contains the DICOM tags of the incoming instance. For debugging | |
290 purpose, you can print this structure as follows:: | |
291 | |
292 function ReceivedInstanceFilter(dicom, origin) | |
293 PrintRecursive(dicom) | |
294 -- Accept all incoming instances (default behavior) | |
295 return true | |
296 end | |
297 | |
298 The argument ``origin`` is :ref:`documented separately <lua-origin>`. | |
299 | |
300 | |
301 .. _lua-filter-rest: | |
302 | |
75 | 303 Filtering incoming REST requests |
0 | 304 -------------------------------- |
305 | |
306 .. highlight:: lua | |
307 | |
308 Lua scripting can be used to control the access to the various URI of | |
309 the REST API. Each time an incoming HTTP request is received, the | |
310 ``IncomingHttpRequestFilter()`` Lua function is called. The access to | |
311 the resource is granted if and only if this callback script returns | |
312 ``true``. | |
313 | |
314 This mechanism can be used to implement fine-grained `access control | |
25 | 315 lists <https://en.wikipedia.org/wiki/Access_control_list>`__. Here is |
0 | 316 an example of a Lua script that limits POST, PUT and DELETE requests |
317 to an user that is called "admin":: | |
318 | |
319 function IncomingHttpRequestFilter(method, uri, ip, username, httpHeaders) | |
320 -- Only allow GET requests for non-admin users | |
321 | |
322 if method == 'GET' then | |
323 return true | |
324 elseif username == 'admin' then | |
325 return true | |
326 else | |
327 return false | |
328 end | |
329 end | |
330 | |
331 Here is a description of the arguments of this Lua callback: | |
332 | |
333 * ``method``: The HTTP method (GET, POST, PUT or DELETE). | |
334 * ``uri``: The path to the resource (e.g. ``/tools/generate-uid``). | |
335 * ``ip``: The IP address of the host that has issued the HTTP request (e.g. ``127.0.0.1``). | |
336 * ``username``: If HTTP Basic Authentication is enabled in the | |
337 :ref:`configuration file <configuration>`, the name of the user that | |
338 has issued the HTTP request (as defined in the ``RegisteredUsers`` | |
339 configuration variable). If the authentication is disabled, this | |
340 argument is set to the empty string. | |
341 * ``httpHeaders``: The HTTP headers of the incoming request. This | |
342 argument is available since Orthanc 1.0.1. It is useful if the | |
343 authentication should be achieved through tokens, for instance | |
344 against a `LDAP | |
345 <https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol>`__ | |
346 or `OAuth2 <https://en.wikipedia.org/wiki/OAuth>`__ server. | |
347 | |
348 | |
349 .. _lua-auto-routing: | |
350 | |
75 | 351 Auto-routing of DICOM images |
0 | 352 ---------------------------- |
353 | |
354 .. highlight:: lua | |
355 | |
356 Since release 0.8.0, the routing of DICOM flows can be very easily | |
357 automated with Orthanc. All you have to do is to declare your | |
358 destination modality in the :ref:`configuration file <configuration>` | |
359 (section ``DicomModalities``), then to create and install a Lua | |
360 script. For instance, here is a sample script:: | |
361 | |
362 function OnStoredInstance(instanceId, tags, metadata) | |
363 Delete(SendToModality(instanceId, 'sample')) | |
364 end | |
365 | |
366 If this script is loaded into Orthanc, whenever a new DICOM instance | |
367 is received by Orthanc, it will be routed to the modality whose | |
368 symbolic name is ``sample`` (through a Store-SCU command), then it | |
369 will be removed from Orthanc. In other words, this is a **one-liner | |
370 script to implement DICOM auto-routing**. | |
371 | |
372 Very importantly, thanks to this feature, you do not have to use the | |
373 REST API or to create external scripts in order to automate simple | |
374 imaging flows. The scripting engine is entirely contained inside the | |
375 Orthanc core system. | |
376 | |
377 Thanks to Lua expressiveness, you can also implement conditional | |
378 auto-routing. For instance, if you wish to route only patients whose | |
379 name contains "David", you would simply write:: | |
380 | |
381 function OnStoredInstance(instanceId, tags, metadata) | |
382 -- Extract the value of the "PatientName" DICOM tag | |
383 local patientName = string.lower(tags['PatientName']) | |
384 | |
385 if string.find(patientName, 'david') ~= nil then | |
386 -- Only route patients whose name contains "David" | |
387 Delete(SendToModality(instanceId, 'sample')) | |
388 | |
389 else | |
390 -- Delete the patients that are not called "David" | |
391 Delete(instanceId) | |
392 end | |
393 end | |
394 | |
395 Besides ``SendToModality()``, a mostly identical function with the | |
396 same arguments called ``SendToPeer()`` can be used to route instances | |
397 to :ref:`Orthanc peers <peers>`. It is also possible to modify the | |
398 received instances before routing them. For instance, here is how you | |
399 would replace the ``StationName`` DICOM tag:: | |
400 | |
401 function OnStoredInstance(instanceId, tags, metadata) | |
402 -- Ignore the instances that result from a modification to avoid | |
403 -- infinite loops | |
404 if (metadata['ModifiedFrom'] == nil and | |
405 metadata['AnonymizedFrom'] == nil) then | |
406 | |
407 -- The tags to be replaced | |
408 local replace = {} | |
409 replace['StationName'] = 'My Medical Device' | |
410 | |
411 -- The tags to be removed | |
412 local remove = { 'MilitaryRank' } | |
413 | |
414 -- Modify the instance, send it, then delete the modified instance | |
415 Delete(SendToModality(ModifyInstance(instanceId, replace, remove, true), 'sample')) | |
416 | |
417 -- Delete the original instance | |
418 Delete(instanceId) | |
419 end | |
420 end | |
421 | |
422 | |
75 | 423 Important remarks about auto-routing |
424 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
19
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
425 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
426 The ``SendToModality()``, ``SendToPeer()``, ``ModifyInstance()`` and |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
427 ``Delete()`` functions are for the most basic cases of auto-routing |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
428 (implying a single DICOM instance, and possibly a basic modification |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
429 of this instance). The ``ModifyInstance()`` function `could also lead |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
430 to problems |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
431 <https://groups.google.com/d/msg/orthanc-users/hmv2y-LgKm8/oMAuGJWMBgAJ>`__ |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
432 if it deals with tags wrongly interpreted as numbers by Lua. |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
433 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
434 For more evolved auto-routing scenarios, remember that Lua scripts |
191 | 435 :ref:`have full access to the REST API of Orthanc <lua-rest>`. This is |
19
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
436 illustrated by the ``AutoroutingModification.lua`` sample available in |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
437 the source distribution of Orthanc:: |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
438 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
439 function OnStoredInstance(instanceId, tags, metadata, origin) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
440 -- Ignore the instances that result from the present Lua script to |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
441 -- avoid infinite loops |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
442 if origin['RequestOrigin'] ~= 'Lua' then |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
443 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
444 -- The tags to be replaced |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
445 local replace = {} |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
446 replace['StationName'] = 'My Medical Device' |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
447 replace['0031-1020'] = 'Some private tag' |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
448 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
449 -- The tags to be removed |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
450 local remove = { 'MilitaryRank' } |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
451 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
452 -- Modify the instance |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
453 local command = {} |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
454 command['Replace'] = replace |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
455 command['Remove'] = remove |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
456 local modifiedFile = RestApiPost('/instances/' .. instanceId .. '/modify', DumpJson(command, true)) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
457 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
458 -- Upload the modified instance to the Orthanc database so that |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
459 -- it can be sent by Orthanc to other modalities |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
460 local modifiedId = ParseJson(RestApiPost('/instances/', modifiedFile)) ['ID'] |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
461 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
462 -- Send the modified instance to another modality |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
463 RestApiPost('/modalities/sample/store', modifiedId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
464 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
465 -- Delete the original and the modified instances |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
466 RestApiDelete('/instances/' .. instanceId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
467 RestApiDelete('/instances/' .. modifiedId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
468 end |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
469 end |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
470 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
471 Also note that :ref:`other callbacks are available <lua-callbacks>` |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
472 (``OnStablePatient()``, ``OnStableStudy()`` and ``OnStableSeries()``) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
473 to react to other events than the reception of a single instance |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
474 with ``OnStoredInstance()``. |
75 | 475 |
99
e83da2f99e45
added 'troubleshooting C-Find queries' in the worklist section
amazy
parents:
91
diff
changeset
|
476 .. _lua-fix-cfind: |
75 | 477 |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
478 Fixing C-Find requests |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
479 ---------------------- |
75 | 480 |
481 :ref:`C-Find requests <dicom-find>` are sometimes interpreted | |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
482 differently by different DICOM servers (e.g. the ``*`` wildcard, as |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
483 `reported by users |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
484 <https://groups.google.com/d/msg/orthanc-users/3g7V7kqr3g0/IREL88RWAwAJ>`__), |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
485 and sometimes a querying modality might set unexpected DICOM tags |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
486 (cf. `this real-world example |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
487 <https://groups.google.com/d/msg/orthanc-users/PLWKqVVaXLs/n_0x4vKhAgAJ>`__). In |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
488 such situations, it is possible to dynamically fix incoming or |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
489 outgoing C-Find queries using a Lua script. |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
490 |
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
491 Sanitizing incoming C-Find requests can be done by implementing the |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
492 ``IncomingFindRequestFilter(query, origin)`` callback that is called |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
493 whenever the Orthanc C-Find SCP is queried by a remote modality. For |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
494 instance, here is Lua script to remove a private tag that is specified |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
495 by some manufacturer:: |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
496 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
497 function IncomingFindRequestFilter(query, origin) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
498 -- First display the content of the C-Find query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
499 PrintRecursive(query) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
500 PrintRecursive(origin) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
501 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
502 -- Remove the "PrivateCreator" tag from the query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
503 local v = query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
504 v['5555,0010'] = nil |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
505 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
506 return v |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
507 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
508 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
509 The ``origin`` argument contains information about which modality has |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
510 issued the request. |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
511 |
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
512 Note that the ``IncomingFindRequestFilter`` callback is not applied to |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
513 C-Find requests targeting :ref:`modality worklists |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
514 <worklists-plugin>`. Since Orthanc 1.4.2, the corresponding |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
515 ``IncomingWorklistRequestFilter`` callback can be used to sanitize |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
516 C-FIND requests against worklists:: |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
517 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
518 function IncomingWorklistRequestFilter(query, origin) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
519 PrintRecursive(query) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
520 PrintRecursive(origin) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
521 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
522 -- Implements the same behavior as the "FilterIssuerAet" |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
523 -- option of the sample worklist plugin |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
524 query['0040,0100'][1]['0040,0001'] = origin['RemoteAet'] |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
525 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
526 return query |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
527 end |
105
268ec482f051
IncomingFindRequestFilter not applied to worklist plugin
amazy
parents:
99
diff
changeset
|
528 |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
529 Similarly, the callback ``OutgoingFindRequestFilter(query, modality)`` |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
530 is invoked whenever Orthanc acts as a C-Find SCU, which gives the |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
531 opportunity to dynamically fix outgoing C-Find requests before they |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
532 are actually sent to the queried modality. For instance, here is a |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
533 sample Lua callback that would replace asterisk wildcards (i.e. ``*``) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
534 by an empty string for any query/retrieve issued by Orthanc (including |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
535 from Orthanc Explorer):: |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
536 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
537 function OutgoingFindRequestFilter(query, modality) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
538 for key, value in pairs(query) do |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
539 if value == '*' then |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
540 query[key] = '' |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
541 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
542 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
543 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
544 return query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
545 end |