Skip to content

Commit 18615ca

Browse files
Add missing DataRetentionSettings configuration settings
Add 7 missing DataRetentionSettings configuration options to the compliance documentation: - TimeBetweenBatchesMilliseconds - RetentionIdsBatchSize - BoardsRetentionDays - EnableMessageDeletion - EnableFileDeletion - EnableBoardsDeletion - BatchSize These settings provide better control over data retention job execution and performance. Fixes #8160 Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
1 parent a9a56ee commit 18615ca

File tree

1 file changed

+126
-0
lines changed

1 file changed

+126
-0
lines changed

source/configure/compliance-configuration-settings.rst

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,132 @@ Run deletion job now
114114

115115
Start a Data Retention deletion job immediately. You can monitor the status of the job in the data deletion job table within the Policy Log section.
116116

117+
.. config:setting:: time-between-batches-milliseconds
118+
:displayname: Time between batches (Data Retention)
119+
:systemconsole: Compliance > Data Retention Policies
120+
:configjson: .DataRetentionSettings.TimeBetweenBatchesMilliseconds
121+
:environment: MM_DATARETENTIONSETTINGS_TIMEBETWEENBATCHESMILLISECONDS
122+
:description: The time in milliseconds between batches processed during data retention job execution. Used to control the rate at which data is deleted to reduce database load. Default is 100 milliseconds.
123+
124+
Time between batches
125+
~~~~~~~~~~~~~~~~~~~~~
126+
127+
The time in milliseconds between batches processed during data retention job execution. This setting helps control the rate at which data is deleted to reduce database load during retention operations.
128+
129+
Default is 100 milliseconds.
130+
131+
+--------------------------------------------------------------------------------------------------------------------------+
132+
| This feature's ``config.json`` setting is ``"TimeBetweenBatchesMilliseconds": 100`` with numerical input. |
133+
+--------------------------------------------------------------------------------------------------------------------------+
134+
135+
.. config:setting:: retention-ids-batch-size
136+
:displayname: Retention IDs batch size (Data Retention)
137+
:systemconsole: Compliance > Data Retention Policies
138+
:configjson: .DataRetentionSettings.RetentionIdsBatchSize
139+
:environment: MM_DATARETENTIONSETTINGS_RETENTIONIDSBATCHSIZE
140+
:description: The number of retention IDs to process in a single batch during data retention job execution. Default is 1000.
141+
142+
Retention IDs batch size
143+
~~~~~~~~~~~~~~~~~~~~~~~~~
144+
145+
The number of retention IDs to process in a single batch during data retention job execution. This setting controls how many items are processed together for optimal performance.
146+
147+
Default is 1000.
148+
149+
+-----------------------------------------------------------------------------------------------------------+
150+
| This feature's ``config.json`` setting is ``"RetentionIdsBatchSize": 1000`` with numerical input. |
151+
+-----------------------------------------------------------------------------------------------------------+
152+
153+
.. config:setting:: boards-retention-days
154+
:displayname: Boards retention days (Data Retention)
155+
:systemconsole: Compliance > Data Retention Policies
156+
:configjson: .DataRetentionSettings.BoardsRetentionDays
157+
:environment: MM_DATARETENTIONSETTINGS_BOARDSRETENTIONDAYS
158+
:description: Set how long Mattermost keeps boards data. Default is 0 (disabled).
159+
160+
Boards retention days
161+
~~~~~~~~~~~~~~~~~~~~~
162+
163+
Set how long Mattermost keeps boards data. When set to a value greater than 0, boards data older than the specified number of days will be deleted during retention job execution.
164+
165+
Default is 0 (disabled).
166+
167+
+-----------------------------------------------------------------------------------------------------+
168+
| This feature's ``config.json`` setting is ``"BoardsRetentionDays": 0`` with numerical input. |
169+
+-----------------------------------------------------------------------------------------------------+
170+
171+
.. config:setting:: enable-message-deletion
172+
:displayname: Enable message deletion (Data Retention)
173+
:systemconsole: Compliance > Data Retention Policies
174+
:configjson: .DataRetentionSettings.EnableMessageDeletion
175+
:environment: MM_DATARETENTIONSETTINGS_ENABLEMESSAGEDELETION
176+
:description: Enable or disable message deletion during data retention job execution. Default is true.
177+
178+
Enable message deletion
179+
~~~~~~~~~~~~~~~~~~~~~~~
180+
181+
Enable or disable message deletion during data retention job execution. When set to false, messages will not be deleted regardless of other retention settings.
182+
183+
Default is true.
184+
185+
+-----------------------------------------------------------------------------------------------------------+
186+
| This feature's ``config.json`` setting is ``"EnableMessageDeletion": true`` with boolean input. |
187+
+-----------------------------------------------------------------------------------------------------------+
188+
189+
.. config:setting:: enable-file-deletion
190+
:displayname: Enable file deletion (Data Retention)
191+
:systemconsole: Compliance > Data Retention Policies
192+
:configjson: .DataRetentionSettings.EnableFileDeletion
193+
:environment: MM_DATARETENTIONSETTINGS_ENABLEFILEDELETION
194+
:description: Enable or disable file deletion during data retention job execution. Default is true.
195+
196+
Enable file deletion
197+
~~~~~~~~~~~~~~~~~~~~
198+
199+
Enable or disable file deletion during data retention job execution. When set to false, files will not be deleted regardless of other retention settings.
200+
201+
Default is true.
202+
203+
+--------------------------------------------------------------------------------------------------------+
204+
| This feature's ``config.json`` setting is ``"EnableFileDeletion": true`` with boolean input. |
205+
+--------------------------------------------------------------------------------------------------------+
206+
207+
.. config:setting:: enable-boards-deletion
208+
:displayname: Enable boards deletion (Data Retention)
209+
:systemconsole: Compliance > Data Retention Policies
210+
:configjson: .DataRetentionSettings.EnableBoardsDeletion
211+
:environment: MM_DATARETENTIONSETTINGS_ENABLEBOARDSDELETION
212+
:description: Enable or disable boards deletion during data retention job execution. Default is true.
213+
214+
Enable boards deletion
215+
~~~~~~~~~~~~~~~~~~~~~~
216+
217+
Enable or disable boards deletion during data retention job execution. When set to false, boards data will not be deleted regardless of other retention settings.
218+
219+
Default is true.
220+
221+
+----------------------------------------------------------------------------------------------------------+
222+
| This feature's ``config.json`` setting is ``"EnableBoardsDeletion": true`` with boolean input. |
223+
+----------------------------------------------------------------------------------------------------------+
224+
225+
.. config:setting:: batch-size-data-retention
226+
:displayname: Batch size (Data Retention)
227+
:systemconsole: Compliance > Data Retention Policies
228+
:configjson: .DataRetentionSettings.BatchSize
229+
:environment: MM_DATARETENTIONSETTINGS_BATCHSIZE
230+
:description: The number of records to process in a single batch during data retention job execution. Default is 1000.
231+
232+
Batch size
233+
~~~~~~~~~~
234+
235+
The number of records to process in a single batch during data retention job execution. This setting controls how many records are processed together for optimal performance.
236+
237+
Default is 1000.
238+
239+
+-------------------------------------------------------------------------------------------------+
240+
| This feature's ``config.json`` setting is ``"BatchSize": 1000`` with numerical input. |
241+
+-------------------------------------------------------------------------------------------------+
242+
117243
----
118244

119245
Compliance export

0 commit comments

Comments
 (0)