Mercurial > hg > orthanc-book

changeset 872:f72b2dd172da Orthanc-1.11.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Orthanc 1.11.2
author Alain Mazy <am@osimis.io>
date Wed, 31 Aug 2022 12:06:15 +0200
parents ab39093b898f
children 0eaa040fb76d
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/orthanc-storage.rst Sphinx/source/faq/scalability.rst Sphinx/source/plugins/python.rst Sphinx/source/users/advanced-rest.rst Sphinx/source/users/anonymization.rst Sphinx/source/users/configuration.rst Sphinx/source/users/debian-packages.rst Sphinx/source/users/rest.rst
diffstat 14 files changed, 34 insertions(+), 34 deletions(-) [+]
line wrap: on
line diff
--- a/OpenAPI/orthanc-openapi.json	Tue Aug 30 14:16:48 2022 +0200
+++ b/OpenAPI/orthanc-openapi.json	Wed Aug 31 12:06:15 2022 +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.11.1"
+      "version" : "1.11.2"
    },
    "openapi" : "3.0.0",
    "paths" : {
@@ -3598,9 +3598,9 @@
                         "schema" : {
                            "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)",
                            "example" : [
-                              "003e5852-af2b-42af-8190-2e333b8f8bbb",
-                              "1114a97d-0a79-40de-be60-a3af5d4ba680",
-                              "1dec255c-7736-41ec-8560-e1486aa941ce",
+                              "23a80b32-d72d-47cd-93d2-88d12e064ff6",
+                              "2db25003-6758-4509-a828-e74d70773c5e",
+                              "3f1aa2c2-fca5-4d83-bb47-f4eafe85ae24",
                               "..."
                            ]
                         }
@@ -15223,7 +15223,7 @@
                "200" : {
                   "content" : {
                      "text/plain" : {
-                        "example" : "orthanc_count_instances 2552 1656599741752\northanc_count_patients 8 1656599741752\northanc_count_series 26 1656599741752\northanc_count_studies 8 1656599741752\northanc_dicom_cache_count 344 1656589511558\northanc_dicom_cache_size 127.937477 1656589511556\northanc_disk_size_mb 1018.65021 1656599741752\northanc_jobs_completed 10 1656599741752\northanc_jobs_failed 5 1656599741752\northanc_jobs_pending 0 1656599741752\northanc_jobs_running 0 1656599741752\northanc_jobs_success 5 1656599741752\northanc_rest_api_active_requests 1 1656599741751\northanc_rest_api_duration_ms 385 1656599740245\northanc_storage_read_duration_ms 16 1656599738604\northanc_uncompressed_size_mb 1018.65021 1656599741752\n"
+                        "example" : "orthanc_count_instances 2552 1661940227313\northanc_count_patients 8 1661940227313\northanc_count_series 26 1661940227313\northanc_count_studies 8 1661940227313\northanc_dicom_cache_count 587 1661939724041\northanc_dicom_cache_size 127.833656 1661939724040\northanc_disk_size_mb 1018.65021 1661940227313\northanc_jobs_completed 10 1661940227313\northanc_jobs_failed 2 1661940227313\northanc_jobs_pending 0 1661940227313\northanc_jobs_running 0 1661940227313\northanc_jobs_success 8 1661940227313\northanc_rest_api_active_requests 1 1661940227312\northanc_rest_api_duration_ms 3036 1661940225539\northanc_storage_read_duration_ms 57 1661940217477\northanc_uncompressed_size_mb 1018.65021 1661940227313\n"
                      }
                   },
                   "description" : ""
@@ -15242,7 +15242,7 @@
                "200" : {
                   "content" : {
                      "text/plain" : {
-                        "example" : "20220630T143541",
+                        "example" : "20220831T100347",
                         "schema" : {
                            "description" : "The UTC time"
                         }
@@ -15264,7 +15264,7 @@
                "200" : {
                   "content" : {
                      "text/plain" : {
-                        "example" : "20220630T143541",
+                        "example" : "20220831T100347",
                         "schema" : {
                            "description" : "The local time"
                         }
--- a/Sphinx/source/developers/creating-plugins.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/developers/creating-plugins.rst	Wed Aug 31 12:06:15 2022 +0200
@@ -15,7 +15,7 @@
 Native Orthanc plugins must use the `plugin SDK
 <https://sdk.orthanc-server.com/>`__ whose interface is available as a
 `C header
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__.
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__.
 As a consequence, an Orthanc plugin will typically be written using C
 or C++, although it is also possible to create native plugins using
 languages that feature compatibility with C headers and with `FFI of
@@ -96,7 +96,7 @@
 that is part of the Orthanc source distribution:
 
 * `Plugins/Include/orthanc/OrthancCPlugin.h
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
 
 `Online documentation <https://sdk.orthanc-server.com/>`__ for this C
 header is available, as generated by `Doxygen
@@ -110,8 +110,8 @@
 ``HAS_ORTHANC_EXCEPTION`` is set to ``0``:
 
 * `Plugins/Samples/Common/OrthanPluginCppWrapper.h
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__
 * `Plugins/Samples/Common/OrthanPluginCppWrapper.cpp
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__
 * `Plugins/Samples/Common/OrthanPluginException.h
-  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__
+  <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__
--- a/Sphinx/source/developers/db-versioning.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/developers/db-versioning.rst	Wed Aug 31 12:06:15 2022 +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.11.1            u       u       u       x
+Orthanc 0.9.5 - Orthanc 1.11.2            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	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/dicom-guide.rst	Wed Aug 31 12:06:15 2022 +0200
@@ -665,7 +665,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.11.1, Orthanc only implements C-Get as a
+*Note:* As of Orthanc 1.11.2, 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	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/faq/crash.rst	Wed Aug 31 12:06:15 2022 +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.11.1/Orthanc
+  $ wget https://lsb.orthanc-server.com/orthanc/debug/1.11.2/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.11.1
+  W0427 15:43:24.215783 main.cpp:1436] Orthanc version: 1.11.2
   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	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/faq/debugging.rst	Wed Aug 31 12:06:15 2022 +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.11.1/Orthanc
+  $ wget https://lsb.orthanc-server.com/orthanc/debug/1.11.2/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.11.1
+  W0513 15:24:42.374349 main.cpp:1436] Orthanc version: 1.11.2
   ---> 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/orthanc-storage.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/faq/orthanc-storage.rst	Wed Aug 31 12:06:15 2022 +0200
@@ -59,9 +59,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.11.1/OrthancServer/Sources/Database/PrepareDatabase.sql>`__
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Sources/Database/PrepareDatabase.sql>`__
 and `InstallTrackAttachmentsSize.sql
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__.
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__.
 
 
 Direct access
--- a/Sphinx/source/faq/scalability.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/faq/scalability.rst	Wed Aug 31 12:06:15 2022 +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.11.1 at the time of
+* Make sure to use the latest release of Orthanc (1.11.2 at the time of
   writing) running on a GNU/Linux distribution.
 
 * We suggest to use the latest release of the :ref:`PostgreSQL plugin
--- a/Sphinx/source/plugins/python.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/plugins/python.rst	Wed Aug 31 12:06:15 2022 +0200
@@ -18,7 +18,7 @@
 Python plugins have access to more features and a more consistent SDK
 than :ref:`Lua scripts <lua>`. The largest part of the Python API is
 automatically generated from the `Orthanc plugin SDK in C
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/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	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/users/advanced-rest.rst	Wed Aug 31 12:06:15 2022 +0200
@@ -89,7 +89,7 @@
 the ``MediaArchiveSize`` configuration that defines the maximum
 number of ZIP/media archives that are maintained by Orthanc, as a 
 response to the asynchronous creation of archive.  As of Orthanc
-1.11.1, this value is ``1`` by default !
+1.11.2, this value is ``1`` by default !
 
 .. _jobs-monitoring:
 
@@ -139,7 +139,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.11.1, this feature is not
+  re-submission after a delay. As of Orthanc 1.11.2, this feature is not
   used by any type of job.
 
 In order to wait for the end of an asynchronous call, the caller will
@@ -148,7 +148,7 @@
 ``Failure``.
 
 Note that the `integration tests of Orthanc
-<https://hg.orthanc-server.com/orthanc-tests/file/Orthanc-1.11.1/Tests/Toolbox.py>`__
+<https://hg.orthanc-server.com/orthanc-tests/file/Orthanc-1.11.2/Tests/Toolbox.py>`__
 give an example about how to monitor a job in Python using the REST
 API (cf. function ``MonitorJob()``).
 
@@ -221,7 +221,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.11.1/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__
 of Orthanc).
 
 Here is the corresponding sequence of commands to generate a DICOMDIR
@@ -230,7 +230,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.11.1, only the creation of a ZIP or a DICOMDIR archive
+As of Orthanc 1.11.2, only the creation of a ZIP or a DICOMDIR archive
 produces such "outputs".
 
   
--- a/Sphinx/source/users/anonymization.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/users/anonymization.rst	Wed Aug 31 12:06:15 2022 +0200
@@ -80,7 +80,7 @@
 **Implementation:** Internally, the setup of the anonymization
 profiles can be found in the methods ``SetupAnonymizationXXX()`` of
 the class ``Orthanc::DicomModification`` (cf. `source code
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancFramework/Sources/DicomParsing/DicomModification.cpp>`__).
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancFramework/Sources/DicomParsing/DicomModification.cpp>`__).
 
 
 Modification of a Single Instance
--- a/Sphinx/source/users/configuration.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/users/configuration.rst	Wed Aug 31 12:06:15 2022 +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.11.1/OrthancServer/Resources/Configuration.json>`_. This
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/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	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/users/debian-packages.rst	Wed Aug 31 12:06:15 2022 +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.11.1/Orthanc --output-document /usr/sbin/Orthanc
+  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.2/Orthanc --output-document /usr/sbin/Orthanc
   $ sudo rm -f /usr/share/orthanc/plugins/*.so
-  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.1/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so
-  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.1/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so
+  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.2/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so
+  $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.2/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so
   $
   $ sudo wget https://lsb.orthanc-server.com/plugin-dicom-web/1.6/libOrthancDicomWeb.so --output-document /usr/share/orthanc/plugins/libOrthancDicomWeb.so
   $ ...
--- a/Sphinx/source/users/rest.rst	Tue Aug 30 14:16:48 2022 +0200
+++ b/Sphinx/source/users/rest.rst	Wed Aug 31 12:06:15 2022 +0200
@@ -98,7 +98,7 @@
     $ curl -X POST -H "Expect:" http://localhost:8042/instances --data-binary @CT.X.1.2.276.0.7230010.dcm
 
 The code distribution of Orthanc contains a `sample Python script
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`__
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`__
 that recursively upload the content of some folder into Orthanc using
 the REST API::
 
@@ -110,7 +110,7 @@
 import the content of ``.zip``, ``.tar.gz`` or ``.tar.bz2`` archives
 without having to uncompress them first. It also provides more
 comprehensive command-line options. `Check this script out
-<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.1/OrthancServer/Resources/Samples/ImportDicomFiles/OrthancImport.py>`__.
+<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.11.2/OrthancServer/Resources/Samples/ImportDicomFiles/OrthancImport.py>`__.
     
 
 .. highlight:: perl