diff Sphinx/source/plugins/housekeeper.rst @ 969:7abb7c8ff544

doc for upcoming dicomweb 1.15
author Alain Mazy <am@osimis.io>
date Wed, 23 Aug 2023 18:58:43 +0200
parents 2f8ee0aef0a6
children 937450f76f8d
line wrap: on
line diff
--- 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