changeset 971:ee5976d191ae

EnableMetadataCache
author Alain Mazy <am@osimis.io>
date Thu, 24 Aug 2023 12:57:17 +0200
parents 7abb7c8ff544
children e72f8d52d94b
files Sphinx/source/plugins/dicomweb.rst
diffstat 1 files changed, 24 insertions(+), 19 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/plugins/dicomweb.rst	Wed Aug 23 18:58:43 2023 +0200
+++ b/Sphinx/source/plugins/dicomweb.rst	Thu Aug 24 12:57:17 2023 +0200
@@ -114,24 +114,27 @@
   {
     [...]
     "DicomWeb" : {
-      "Enable" : true,             // Whether DICOMweb support is enabled
-      "Root" : "/dicom-web/",      // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS)
-      "EnableWado" : true,         // Whether WADO-URI (previously known as WADO) support is enabled
-      "WadoRoot" : "/wado",        // Root URI of the WADO-URI (aka. WADO) API
-      "Ssl" : false,               // Whether HTTPS should be used for subsequent WADO-RS requests.
-                                   // If Orthanc is behind a reverse-proxy, the 'forwarded' headers will be used instead of the config.
-      "QidoCaseSensitive" : true,  // For QIDO-RS server, whether search is case sensitive (since release 0.5)
-      "Host" : "",                 // Hard-codes the name of the host for subsequent WADO-RS requests.  
-                                   // e.g: "localhost:8042", "dicomweb.mydomain.org"
-                                   // If empty (default), the plugin will guess it from other configurations or 
-                                   // from the reverse-proxy 'forwarded' headers.
-      "StudiesMetadata" : "Full",  // How study-level metadata is retrieved (since release 1.1, cf. section below)
-      "SeriesMetadata" : "Full",   // How series-level metadata is retrieved (since release 1.1, cf. section below)
-      "PublicRoot": "/dicom-web/", // The public Root URI of the DICOMweb API in case it is different from "Root".
-                                   // This is useful if, e.g, your Orthanc is behind a reverse-proxy and has another 
-                                   // base endpoint than the "Root" one.  Note that, if using a reverse-proxy, make sure to set the "host"
-                                   // and "proto" correctly in the "Forwarded" HTTP headers.
-                                   // (since release 1.8)
+      "Enable" : true,                // Whether DICOMweb support is enabled
+      "Root" : "/dicom-web/",         // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS)
+      "EnableWado" : true,            // Whether WADO-URI (previously known as WADO) support is enabled
+      "WadoRoot" : "/wado",           // Root URI of the WADO-URI (aka. WADO) API
+      "Ssl" : false,                  // Whether HTTPS should be used for subsequent WADO-RS requests.
+                                      // If Orthanc is behind a reverse-proxy, the 'forwarded' headers will be used instead of the config.
+      "QidoCaseSensitive" : true,     // For QIDO-RS server, whether search is case sensitive (since release 0.5)
+      "Host" : "",                    // Hard-codes the name of the host for subsequent WADO-RS requests.  
+                                      // e.g: "localhost:8042", "dicomweb.mydomain.org"
+                                      // If empty (default), the plugin will guess it from other configurations or 
+                                      // from the reverse-proxy 'forwarded' headers.
+      "StudiesMetadata" : "Full",     // How study-level metadata is retrieved (since release 1.1, cf. section below)
+      "SeriesMetadata" : "Full",      // How series-level metadata is retrieved (since release 1.1, cf. section below)
+      "EnableMetadataCache": true,    // Wheter the plugin caches metadata as a gzipped attachment (since release 1.15)
+      "MetadataWorkerThreadsCount": 4,// The number of concurrent threads that are used to extract the metadata in Full mode
+                                      // (since release 1.14)
+      "PublicRoot": "/dicom-web/",    // The public Root URI of the DICOMweb API in case it is different from "Root".
+                                      // This is useful if, e.g, your Orthanc is behind a reverse-proxy and has another 
+                                      // base endpoint than the "Root" one.  Note that, if using a reverse-proxy, make sure to set the "host"
+                                      // and "proto" correctly in the "Forwarded" HTTP headers.
+                                      // (since release 1.8)
     }
   }
 
@@ -184,12 +187,14 @@
   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.
+  slow to populate 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.
 
+* The metadata caching can be disabled by setting ``EnableMetadataCache`` to ``false``.
+
 * 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 good