Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/housekeeper.rst @ 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 2f8ee0aef0a6
children 937450f76f8d
comparison
equal deleted inserted replaced
968:4ce37a89b212 969:7abb7c8ff544
1 .. _housekeeper-plugin: 1 .. _housekeeper-plugin:
2 2
3 3
4 Housekeeper plugin (new in Orthanc 1.11.0) 4 Housekeeper plugin
5 ========================================== 5 ==================
6 6
7 This page describes the **official sample plugin** that performs 7 This page describes the **official sample plugin** that performs
8 housekeeping in the Database and Storage. 8 housekeeping in the Database and Storage.
9 9
10 When changing some configuration or when upgrading Orthanc, it 10 When changing some configuration or when upgrading Orthanc, it
14 * when changing the list of indexed :ref:`MainDicomTags <main-dicom-tags>` 14 * when changing the list of indexed :ref:`MainDicomTags <main-dicom-tags>`
15 * when changing the ``StorageCompression`` configuration 15 * when changing the ``StorageCompression`` configuration
16 * when changing the ``IngestTranscoding`` configuration 16 * when changing the ``IngestTranscoding`` configuration
17 * to remove unnecessary attachments like the ``dicom-as-json`` that were 17 * to remove unnecessary attachments like the ``dicom-as-json`` that were
18 used in Orthanc prior to 1.9.1. 18 used in Orthanc prior to 1.9.1.
19 * when upgrading the :ref:`DICOMweb plugin <dicomweb>` from 1.14 to a later version.
19 20
20 Note that these housekeeping operations are not mandatory. Orthanc will 21 Note that these housekeeping operations are not mandatory. Orthanc will
21 continue to work without these cleanups. However, running the plugin 22 continue to work without these cleanups. However, running the plugin
22 might improve performances and storage usage. 23 might improve performances and storage usage.
23 24
72 // configure events that can trigger a housekeeping processing 73 // configure events that can trigger a housekeeping processing
73 "Triggers" : { 74 "Triggers" : {
74 "StorageCompressionChange": true, 75 "StorageCompressionChange": true,
75 "MainDicomTagsChange": true, 76 "MainDicomTagsChange": true,
76 "UnnecessaryDicomAsJsonFiles": true, 77 "UnnecessaryDicomAsJsonFiles": true,
77 "IngestTranscodingChange": true 78 "IngestTranscodingChange": true,
79 "DicomWebCacheChange": true // new in 1.12.2
78 } 80 }
79 } 81 }
80 } 82 }
81 83
82 Scheduling/throttling 84 Scheduling/throttling
97 * if ``MainDicomTagsChange`` or ``UnnecessaryDicomAsJsonFiles`` is triggered, 99 * if ``MainDicomTagsChange`` or ``UnnecessaryDicomAsJsonFiles`` is triggered,
98 the plugin will call the ``/studies/.../reconstruct`` route on every study 100 the plugin will call the ``/studies/.../reconstruct`` route on every study
99 one by one. Orthanc will read the DICOM tags from the DICOM files again and update 101 one by one. Orthanc will read the DICOM tags from the DICOM files again and update
100 their value in the DB. 102 their value in the DB.
101 103
104 * if ``DicomWebCacheChange`` is triggered (this happens when upgrading from
105 the :ref:`DICOMweb plugin <dicomweb>` from 1.14 to a later version), the plugin will call the
106 ``/studies/../update-dicomweb-cache`` route on every study one by one.
107
102 * if any other change is detected, the plugin will again call the ``reconstruct`` route 108 * if any other change is detected, the plugin will again call the ``reconstruct`` route
103 but, this time, with the ``ReconstructFiles`` option enabled. Orthanc will then, 109 but, this time, with the ``ReconstructFiles`` option enabled. Orthanc will then,
104 read the DICOM file from the storage, compress/uncompress/transcode it and it will 110 read the DICOM file from the storage, compress/uncompress/transcode it and it will
105 save it again to disk. The new file will be stored using the new Storage settings 111 save it again to disk. The new file will be stored using the new Storage settings
106 (``StorageCompression`` and ``IngestTranscoding``). 112 (``StorageCompression`` and ``IngestTranscoding``).