Mercurial > hg > orthanc-book

changeset 678:17c1ff4e6ae4 Orthanc-1.9.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Orthanc 1.9.3
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 07 May 2021 12:25:36 +0200
parents 25e44dba9dba
children efc39728af20
files OpenAPI/orthanc-openapi.json Sphinx/source/developers/creating-plugins.rst Sphinx/source/developers/db-versioning.rst Sphinx/source/dicom-guide.rst Sphinx/source/faq/crash.rst Sphinx/source/faq/debugging.rst Sphinx/source/faq/log.rst Sphinx/source/faq/orthanc-storage.rst Sphinx/source/faq/scalability.rst Sphinx/source/plugins/python.rst Sphinx/source/users/advanced-rest.rst Sphinx/source/users/configuration.rst Sphinx/source/users/debian-packages.rst Sphinx/source/users/docker.rst Sphinx/source/users/man-orthanc.txt
diffstat 15 files changed, 38 insertions(+), 38 deletions(-) [+]
line wrap: on
line diff
--- a/OpenAPI/orthanc-openapi.json	Thu May 06 18:53:14 2021 +0200
+++ b/OpenAPI/orthanc-openapi.json	Fri May 07 12:25:36 2021 +0200
@@ -2,7 +2,7 @@
    "info" : {
       "description" : "This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.<p>An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source](https://groups.google.com/g/orthanc-users/c/NUiJTEICSl8/m/xKeqMrbqAAAJ)).",
       "title" : "Orthanc API",
-      "version" : "1.9.2"
+      "version" : "1.9.3"
    },
    "openapi" : "3.0.0",
    "paths" : {
@@ -3137,9 +3137,9 @@
                         "schema" : {
                            "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)",
                            "example" : [
-                              "7a09255e-84f9-4ac8-8f63-81a674ad130e",
-                              "7b065aae-0255-4e51-bdfc-d3273d1c5e78",
-                              "e093b29c-8ac1-4d25-9d9b-2fa73bd408cd",
+                              "28c9f653-b8e3-476c-8237-794905f4711d",
+                              "2fc02948-0e5d-472e-a6d2-2e3af2275cc1",
+                              "3ab8820c-f757-4eb1-8305-4d554c989077",
                               "..."
                            ]
                         }
@@ -13379,7 +13379,7 @@
                "200" : {
                   "content" : {
                      "text/plain" : {
-                        "example" : "orthanc_count_instances 2552 1619185717552\northanc_count_patients 8 1619185717552\northanc_count_series 26 1619185717552\northanc_count_studies 8 1619185717552\northanc_dicom_cache_count 58 1619172290641\northanc_dicom_cache_size 50.601326 1619172290641\northanc_disk_size_mb 1018.65021 1619185717552\northanc_jobs_completed 4 1619185717552\northanc_jobs_failed 0 1619185717552\northanc_jobs_pending 0 1619185717552\northanc_jobs_running 0 1619185717552\northanc_jobs_success 4 1619185717552\northanc_rest_api_active_requests 1 1619185717552\northanc_rest_api_duration_ms 4519 1619185710153\northanc_storage_read_duration_ms 0 1619185717053\northanc_uncompressed_size_mb 1018.65021 1619185717552\n"
+                        "example" : "orthanc_count_instances 2552 1620382972570\northanc_count_patients 8 1620382972570\northanc_count_series 26 1620382972570\northanc_count_studies 8 1620382972570\northanc_dicom_cache_count 180 1620341242884\northanc_dicom_cache_size 89.929306 1620341242884\northanc_disk_size_mb 1018.65021 1620382972570\northanc_jobs_completed 10 1620382972570\northanc_jobs_failed 0 1620382972570\northanc_jobs_pending 0 1620382972570\northanc_jobs_running 0 1620382972570\northanc_jobs_success 10 1620382972570\northanc_rest_api_active_requests 1 1620382972570\northanc_rest_api_duration_ms 6078 1620382966006\northanc_storage_read_duration_ms 346 1620382962068\northanc_uncompressed_size_mb 1018.65021 1620382972570\n"
                      }
                   },
                   "description" : ""
@@ -13398,7 +13398,7 @@
                "200" : {
                   "content" : {
                      "text/plain" : {
-                        "example" : "20210423T134837",
+                        "example" : "20210507T102252",
                         "schema" : {
                            "description" : "The UTC time"
                         }
@@ -13420,7 +13420,7 @@
                "200" : {
                   "content" : {
                      "text/plain" : {
-                        "example" : "20210423T134837",
+                        "example" : "20210507T102253",
                         "schema" : {
                            "description" : "The local time"
                         }
--- a/Sphinx/source/developers/creating-plugins.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/developers/creating-plugins.rst	Fri May 07 12:25:36 2021 +0200
@@ -83,7 +83,7 @@
 that is part of the Orthanc source distribution:
 
 * `Plugins/Include/orthanc/OrthancCPlugin.h
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
 
 `Online documentation <https://sdk.orthanc-server.com/>`__ for this C
 header is available, as generated by `Doxygen
@@ -97,8 +97,8 @@
 ``HAS_ORTHANC_EXCEPTION`` is set to ``0``:
 
 * `Plugins/Samples/Common/OrthanPluginCppWrapper.h
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__
 * `Plugins/Samples/Common/OrthanPluginCppWrapper.cpp
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__
 * `Plugins/Samples/Common/OrthanPluginException.h
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__
--- a/Sphinx/source/developers/db-versioning.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/developers/db-versioning.rst	Fri May 07 12:25:36 2021 +0200
@@ -26,7 +26,7 @@
 Version                           DB v2   DB v3   DB v4   DB v5   DB v6
 ===============================   =====   =====   =====   =====   =====
 Mainline                                  u       u       u       x
-Orthanc 0.9.5 - Orthanc 1.9.2             u       u       u       x
+Orthanc 0.9.5 - Orthanc 1.9.3             u       u       u       x
 Orthanc 0.8.5 - Orthanc 0.9.4             u       u       x
 Orthanc 0.7.3 - Orthanc 0.8.4             u       x
 Orthanc 0.4.0 - Orthanc 0.7.2             x
--- a/Sphinx/source/dicom-guide.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/dicom-guide.rst	Fri May 07 12:25:36 2021 +0200
@@ -657,7 +657,7 @@
 
     $ getscu -v localhost 4242 -aec ORTHANC -k "0008,0052=STUDY" -k "0020,000d=1.2.840.113543.6.6.4.7.64067529866380271256212683512383713111129"
 
-*Note:* As of Orthanc 1.9.2, Orthanc only implements C-Get as a
+*Note:* As of Orthanc 1.9.3, Orthanc only implements C-Get as a
 service class provider (SCP). Using C-Get as a service class user
 (SCU) is not currently supported in Orthanc.
 
--- a/Sphinx/source/faq/crash.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/faq/crash.rst	Fri May 07 12:25:36 2021 +0200
@@ -64,13 +64,13 @@
 above <segfault-plugin>` is available as the ``crash.cpp`` file, here
 is a sample debug session::
 
-  $ wget https://lsb.orthanc-server.com/orthanc/debug/1.9.2/Orthanc
+  $ wget https://lsb.orthanc-server.com/orthanc/debug/1.9.3/Orthanc
   $ chmod +x ./Orthanc
   $ gcc -fPIC -shared ./crash.cpp -I ~/orthanc/Plugins/Include -o crash.so
   $ ulimit -c unlimited
   $ echo '{ "Plugins" : ["crash.so"] }' > Configuration.json
   $ rm -f core ; ./Orthanc Configuration.json
-  W0427 15:43:24.215783 main.cpp:1436] Orthanc version: 1.9.2
+  W0427 15:43:24.215783 main.cpp:1436] Orthanc version: 1.9.3
   W0427 15:43:24.215910 main.cpp:1279] Performance warning: Non-release build, runtime debug assertions are turned on
   W0427 15:43:24.217585 OrthancConfiguration.cpp:61] Reading the configuration from: "Configuration.json"
   W0427 15:43:24.254733 main.cpp:700] Loading plugin(s) from: crash.so
--- a/Sphinx/source/faq/debugging.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/faq/debugging.rst	Fri May 07 12:25:36 2021 +0200
@@ -45,13 +45,13 @@
 to debug Orthanc without compiling from sources. Here is a sample
 debug session::
 
-  $ wget https://lsb.orthanc-server.com/orthanc/debug/1.9.2/Orthanc
+  $ wget https://lsb.orthanc-server.com/orthanc/debug/1.9.3/Orthanc
   $ chmod +x ./Orthanc
   $ gdb ./Orthanc Configuration.json
   (gdb) catch throw
   Catchpoint 1 (throw)
   (gdb) run
-  W0513 15:24:42.374349 main.cpp:1436] Orthanc version: 1.9.2
+  W0513 15:24:42.374349 main.cpp:1436] Orthanc version: 1.9.3
   ---> Reproduce your error case <---
   Thread 15 "Orthanc" hit Catchpoint 1 (exception thrown), 0x00007ffff6de68bd in __cxa_throw () from /usr/lib/x86_64-linux-gnu/libstdc++.so.6
   (gdb) backtrace
--- a/Sphinx/source/faq/log.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/faq/log.rst	Fri May 07 12:25:36 2021 +0200
@@ -58,7 +58,7 @@
 2. Stop the Orthanc service. The actual process depends on your
    version of Windows.
 
-3. Copy the just-downloaded ``Orthanc-1.9.2-Release.exe`` together
+3. Copy the just-downloaded ``Orthanc-1.9.3-Release.exe`` together
    with your configuration file (that is by default located in
    ``C:\Orthanc\Configuration.json``) into the same folder
    (e.g. ``C:\Temp``).
@@ -67,7 +67,7 @@
    ``Orthanc.log`` file::
 
    $ cd C:\Temp
-   $ Orthanc-1.9.2-Release.exe --verbose Configuration.json > Orthanc.log 2<&1
+   $ Orthanc-1.9.3-Release.exe --verbose Configuration.json > Orthanc.log 2<&1
 
 5. Once the log has been generated (by default, it is available as
    ``C:\Temp\Orthanc.log``), stop Orthanc and possibly restart the
--- a/Sphinx/source/faq/orthanc-storage.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/faq/orthanc-storage.rst	Fri May 07 12:25:36 2021 +0200
@@ -57,9 +57,9 @@
 database schema is kept as simple as possible, and can be found in the
 following two files of the source code of Orthanc:
 `PrepareDatabase.sql
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Sources/Database/PrepareDatabase.sql>`__
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Sources/Database/PrepareDatabase.sql>`__
 and `InstallTrackAttachmentsSize.sql
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__.
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__.
 
 
 Direct access
--- a/Sphinx/source/faq/scalability.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/faq/scalability.rst	Fri May 07 12:25:36 2021 +0200
@@ -54,7 +54,7 @@
 Here is a generic setup that should provide best performance in the
 presence of large databases:
 
-* Make sure to use the latest release of Orthanc (1.9.2 at the time of
+* Make sure to use the latest release of Orthanc (1.9.3 at the time of
   writing).
 
 * We suggest to use the latest release of the :ref:`PostgreSQL plugin
--- a/Sphinx/source/plugins/python.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/plugins/python.rst	Fri May 07 12:25:36 2021 +0200
@@ -18,7 +18,7 @@
 Python plugins have access to more features and a more consistent SDK
 than :ref:`Lua scripts <lua>`. The Python API is automatically
 generated from the `Orthanc plugin SDK in C
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
 using the `Clang <https://en.wikipedia.org/wiki/Clang>`__ compiler
 front-end.
 
--- a/Sphinx/source/users/advanced-rest.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/users/advanced-rest.rst	Fri May 07 12:25:36 2021 +0200
@@ -130,7 +130,7 @@
   ``ErrorCode`` and ``ErrorDescription`` fields for more information.
 * ``Paused``: The job has been paused.
 * ``Retry``: The job has failed internally, and has been scheduled for
-  re-submission after a delay. As of Orthanc 1.9.2, this feature is not
+  re-submission after a delay. As of Orthanc 1.9.3, this feature is not
   used by any type of job.
 
 In order to wait for the end of an asynchronous call, the caller will
@@ -139,7 +139,7 @@
 ``Failure``.
 
 Note that the `integration tests of Orthanc
-<https://hg.orthanc-server.com/orthanc-tests/file/Orthanc-1.9.2/Tests/Toolbox.py>`__
+<https://hg.orthanc-server.com/orthanc-tests/file/Orthanc-1.9.3/Tests/Toolbox.py>`__
 give an example about how to monitor a job in Python using the REST
 API (cf. function ``MonitorJob()``).
 
@@ -200,7 +200,7 @@
 Note how we retrieve the content of the archive by accessing the
 ``archive`` output of the job (check out the virtual method
 ``IJob::GetOutput()`` from the `source code
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__
 of Orthanc).
 
 Here is the corresponding sequence of commands to generate a DICOMDIR
@@ -209,7 +209,7 @@
   $ curl http://localhost:8042/studies/27f7126f-4f66fb14-03f4081b-f9341db2-53925988/media -d '{"Asynchronous":true}'
   $ curl http://localhost:8042/jobs/6332be8a-0052-44fb-8cc2-ac959aeccad9/archive > a.zip
 
-As of Orthanc 1.9.2, only the creation of a ZIP or a DICOMDIR archive
+As of Orthanc 1.9.3, only the creation of a ZIP or a DICOMDIR archive
 produces such "outputs".
 
   
--- a/Sphinx/source/users/configuration.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/users/configuration.rst	Fri May 07 12:25:36 2021 +0200
@@ -8,7 +8,7 @@
 Configuring Orthanc simply consists in providing a configuration file.
 Orthanc has numerous configuration that are documented in the `default
 configuration file
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.2/OrthancServer/Resources/Configuration.json>`_. This
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.9.3/OrthancServer/Resources/Configuration.json>`_. This
 file is in the `JSON <https://en.wikipedia.org/wiki/JSON>`_ file
 format. You can generate this file file with the following call::
 
--- a/Sphinx/source/users/debian-packages.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/users/debian-packages.rst	Fri May 07 12:25:36 2021 +0200
@@ -106,10 +106,10 @@
 This can be done with this sequence of commands::
 
   $ sudo service orthanc stop
-  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.9.2/Orthanc --output-document /usr/sbin/Orthanc
+  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.9.3/Orthanc --output-document /usr/sbin/Orthanc
   $ sudo rm -f /usr/share/orthanc/plugins/*.so
-  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.9.2/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so
-  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.9.2/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so
+  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.9.3/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so
+  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.9.3/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so
   $
   $ sudo wget https://lsb.orthanc-server.com/plugin-dicom-web/1.3/libOrthancDicomWeb.so --output-document /usr/share/orthanc/plugins/libOrthancDicomWeb.so
   $ ...
--- a/Sphinx/source/users/docker.rst	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/users/docker.rst	Fri May 07 12:25:36 2021 +0200
@@ -73,7 +73,7 @@
 If more stability is required, you can select the official release of
 Orthanc to be run::
 
-  $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.9.2
+  $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.9.3
 
 Passing additional command-line options (e.g. to make Orthanc verbose)
 can be done as follows (note the ``/etc/orthanc`` option that is
@@ -95,7 +95,7 @@
 
 Or you can also start a specific version of Orthanc for more stability::
 
-  $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins:1.9.2
+  $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins:1.9.3
 
 If you have an interest in the :ref:`Python plugin <python-plugin>`,
 you can use the ``orthanc-python`` image. The latter image is a
@@ -103,7 +103,7 @@
 Python 3.7 interpreter. Here is how to start this image::
 
   $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python
-  $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python:1.9.2
+  $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python:1.9.3
   
 
 Fine-tuning the configuration
@@ -155,7 +155,7 @@
   version: '3.1'  # Secrets are only available since this version of Docker Compose
   services:
     orthanc:
-      image: jodogne/orthanc-plugins:1.9.2
+      image: jodogne/orthanc-plugins:1.9.3
       command: /run/secrets/  # Path to the configuration files (stored as secrets)
       ports:
         - 4242:4242
@@ -204,7 +204,7 @@
 container to some path in the filesystem of your Linux host, e.g.::
 
   $ mkdir /tmp/orthanc-db
-  $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc-db/:/var/lib/orthanc/db/ jodogne/orthanc:1.9.2 
+  $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc-db/:/var/lib/orthanc/db/ jodogne/orthanc:1.9.3 
 
 
 Whole-slide imaging support
@@ -325,4 +325,4 @@
 * The build artifacts can be found in folder ``/root/orthanc/Build``.
 
 * This command launches the mainline version. To start a released version,
-  use e.g. ``jodogne/orthanc-debug:1.9.2``.
+  use e.g. ``jodogne/orthanc-debug:1.9.3``.
--- a/Sphinx/source/users/man-orthanc.txt	Thu May 06 18:53:14 2021 +0200
+++ b/Sphinx/source/users/man-orthanc.txt	Fri May 07 12:25:36 2021 +0200
@@ -128,4 +128,4 @@
        This  is  free  software:  you  are free to change and redistribute it.
        There is NO WARRANTY, to the extent permitted by law.
 
-Orthanc 1.9.2			  April 2021			    ORTHANC(1)
+Orthanc 1.9.3			   May 2021			    ORTHANC(1)