Mercurial > hg > orthanc-book

changeset 969:7abb7c8ff544

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc for upcoming dicomweb 1.15
author Alain Mazy <am@osimis.io>
date Wed, 23 Aug 2023 18:58:43 +0200
parents 4ce37a89b212
children bc531449c024 ee5976d191ae
files Sphinx/source/faq/features.rst Sphinx/source/plugins/dicomweb.rst Sphinx/source/plugins/housekeeper.rst
diffstat 3 files changed, 26 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/faq/features.rst	Wed Aug 16 21:23:10 2023 +0200
+++ b/Sphinx/source/faq/features.rst	Wed Aug 23 18:58:43 2023 +0200
@@ -320,6 +320,7 @@
   configuration option ``StorageCompression`` is ``true``, or if the
   storage area plugin doesn't support range reads. This allows to
   avoid downloading the full DICOM instance if not necessary.
+* ``Attachment 4301`` is used by the :ref:`DICOMweb plugin <dicomweb>` to cache WADO-RS series metadata (starting from v 1.15 of the plugin).
 * ``Attachment 9997`` is used by the :ref:`Osimis WebViewer plugin <osimis_webviewer>` to store series information.
 * ``Attachment 9998`` is used by the :ref:`Osimis WebViewer plugin <osimis_webviewer>` to store instance information.
 * ``Attachment 9999`` is used by the :ref:`Osimis WebViewer plugin <osimis_webviewer>` to store annotations.
--- a/Sphinx/source/plugins/dicomweb.rst	Wed Aug 16 21:23:10 2023 +0200
+++ b/Sphinx/source/plugins/dicomweb.rst	Wed Aug 23 18:58:43 2023 +0200
@@ -179,13 +179,20 @@
   instances of the study/series of interest from the :ref:`storage
   area <orthanc-storage>`, which gives fully accurate results but
   requires all the individual instances to be read and parsed from the
-  filesystem, leading to slow performance (cf. `issue 162
-  <https://bugs.orthanc-server.com/show_bug.cgi?id=162>`__). This is
-  the default mode.
+  filesystem, leading to slow performance for earliers version of the plugin.
+  From version 1.15 of the plugin in which we have introduced caching, this mode 
+  is the most accurate and fastest one provided that you have run the 
+  :ref:`Housekeeper plugin <housekeeper-plugin>` on data ingested with prior
+  versions of the plugin - otherwise, the first access to the route might still be
+  slow while populating the cache while later accesses will be much faster.
+
+* Starting from version 1.15 of the plugin and provided that the cache has been
+  populated for all prior studies, you should favor the ``Full`` mode.  The following
+  recommandations are kept for prior version of the plugin only.
 
 * If ``MainDicomTags`` mode is used, the plugin will only report the
   main DICOM tags that are indexed by the Orthanc database. The DICOM
-  files are not read from the disk, which provides best
+  files are not read from the disk, which provides good
   performance. However, this is a small subset of all the tags that
   would be retrieved if using the ``Full`` mode: A DICOMweb viewer
   might need more tags.  **Important Note:** From Orthanc 1.11.0 and DICOMweb plugin 1.8,
@@ -215,11 +222,12 @@
   ``StudiesMetadata`` to ``MainDicomTags`` and ``SeriesMetadata`` to ``MainDicomTags``
   as demonstrated in this `sample <https://github.com/orthanc-server/orthanc-setup-samples/tree/master/docker/stone-viewer/docker-compose.yml>`__.
 
+* If using the ``Extrapolate`` mode, the predefined tags are provided
+  using the ``StudiesMetadataExtrapolatedTags`` and
+  ``SeriesMetadataExtrapolatedTags`` configuration options as follows
+  
+Sample configuration for the ``Extrapoate`` mode:: 
 
-If using the ``Extrapolate`` mode, the predefined tags are provided
-using the ``StudiesMetadataExtrapolatedTags`` and
-``SeriesMetadataExtrapolatedTags`` configuration options as follows::
-  
   {
     [...]
     "DicomWeb" : {
--- a/Sphinx/source/plugins/housekeeper.rst	Wed Aug 16 21:23:10 2023 +0200
+++ b/Sphinx/source/plugins/housekeeper.rst	Wed Aug 23 18:58:43 2023 +0200
@@ -1,8 +1,8 @@
 .. _housekeeper-plugin:
 
 
-Housekeeper plugin (new in Orthanc 1.11.0)
-==========================================
+Housekeeper plugin
+==================
 
 This page describes the **official sample plugin** that performs
 housekeeping in the Database and Storage.
@@ -16,6 +16,7 @@
 * when changing the ``IngestTranscoding`` configuration
 * to remove unnecessary attachments like the ``dicom-as-json`` that were
   used in Orthanc prior to 1.9.1.
+* when upgrading the :ref:`DICOMweb plugin <dicomweb>` from 1.14 to a later version.
 
 Note that these housekeeping operations are not mandatory.  Orthanc will
 continue to work without these cleanups.  However, running the plugin
@@ -74,7 +75,8 @@
         "StorageCompressionChange": true,
         "MainDicomTagsChange": true,
         "UnnecessaryDicomAsJsonFiles": true,
-        "IngestTranscodingChange": true
+        "IngestTranscodingChange": true,
+        "DicomWebCacheChange": true   // new in 1.12.2
       }
     }
   }
@@ -99,6 +101,10 @@
   one by one.  Orthanc will read the DICOM tags from the DICOM files again and update 
   their value in the DB.
 
+* if ``DicomWebCacheChange`` is triggered (this happens when upgrading from 
+  the :ref:`DICOMweb plugin <dicomweb>` from 1.14 to a later version), the plugin will call the 
+  ``/studies/../update-dicomweb-cache`` route on every study one by one.
+
 * if any other change is detected, the plugin will again call the ``reconstruct`` route
   but, this time, with the ``ReconstructFiles`` option enabled.  Orthanc will then,
   read the DICOM file from the storage, compress/uncompress/transcode it and it will