# HG changeset patch # User Sebastien Jodogne # Date 1640360169 -3600 # Node ID e7de02760b5929ddeac2ddebefac5a69070d6faf # Parent f3caa014eb886b022dccb7938044cec924bad2f3 fix revision 783, to solve bug #203 diff -r f3caa014eb88 -r e7de02760b59 Sphinx/source/users/lua.rst --- a/Sphinx/source/users/lua.rst Fri Dec 24 15:18:22 2021 +0100 +++ b/Sphinx/source/users/lua.rst Fri Dec 24 16:36:09 2021 +0100 @@ -199,17 +199,24 @@ Instance modification/routing ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The Lua engine offers a few function to modify and route DICOM instances. -:ref:`See this section ` +The Lua engine offers the following special functions to modify and +route DICOM instances: * ``ModifyInstance(instanceId, replacements, removals, removePrivateTags)`` - modifies an instance. Returns the instanceId of the modified instance + modifies an instance. * ``SendToModality(instanceId, modality)`` performs a C-Store to the - target modality. Returns the instanceId. + target modality. * ``SendToPeer(instanceId, peer)`` sends the instance to a remote Orthanc peer. - Returns the instanceId. * ``Delete(instanceId)`` deletes the instance. +:ref:`See this section ` for examples. As can be +seen in those examples, these special functions can be chained +together, although they return no explicit value. + +Note that these special functions should only be used for basic use +cases: Calls to the REST API :ref:`should always be favored for +auto-routing `. + General-purpose functions ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -454,6 +461,8 @@ end +.. _lua-auto-routing-better: + Important remarks about auto-routing ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^