Skip to content

Commit 67e6daa

Browse files
Update DataRetentionSettings configuration defaults and add possible values
- Updated RetentionIdsBatchSize default from 1000 to 100 - Updated BoardsRetentionDays default from 0 to 365 days - Updated EnableMessageDeletion default from true to false - Updated EnableFileDeletion default from true to false - Updated EnableBoardsDeletion default from true to false - Updated BatchSize default from 1000 to 3000 - Added possible values information for all settings Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
1 parent bd4942f commit 67e6daa

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

source/configure/compliance-configuration-settings.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Time between batches
126126

127127
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.
128128

129-
Default is 100 milliseconds.
129+
Default is 100 milliseconds. Possible values are any positive integer (≥ 0).
130130

131131
+--------------------------------------------------------------------------------------------------------------------------+
132132
| This feature's ``config.json`` setting is ``"TimeBetweenBatchesMilliseconds": 100`` with numerical input. |
@@ -137,107 +137,107 @@ Default is 100 milliseconds.
137137
:systemconsole: Compliance > Data Retention Policies
138138
:configjson: .DataRetentionSettings.RetentionIdsBatchSize
139139
: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.
140+
:description: The number of retention IDs to process in a single batch during data retention job execution. Default is 100.
141141

142142
Retention IDs batch size
143143
~~~~~~~~~~~~~~~~~~~~~~~~~
144144

145145
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.
146146

147-
Default is 1000.
147+
Default is 100. Possible values are any positive integer (≥ 0).
148148

149149
+-----------------------------------------------------------------------------------------------------------+
150-
| This feature's ``config.json`` setting is ``"RetentionIdsBatchSize": 1000`` with numerical input. |
150+
| This feature's ``config.json`` setting is ``"RetentionIdsBatchSize": 100`` with numerical input. |
151151
+-----------------------------------------------------------------------------------------------------------+
152152

153153
.. config:setting:: boards-retention-days
154154
:displayname: Boards retention days (Data Retention)
155155
:systemconsole: Compliance > Data Retention Policies
156156
:configjson: .DataRetentionSettings.BoardsRetentionDays
157157
:environment: MM_DATARETENTIONSETTINGS_BOARDSRETENTIONDAYS
158-
:description: Set how long Mattermost keeps boards data. Default is 0 (disabled).
158+
:description: Set how long Mattermost keeps boards data. Default is 365 days.
159159

160160
Boards retention days
161161
~~~~~~~~~~~~~~~~~~~~~
162162

163163
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.
164164

165-
Default is 0 (disabled).
165+
Default is 365 days. Possible values are any non-negative integer (≥ 0).
166166

167167
+-----------------------------------------------------------------------------------------------------+
168-
| This feature's ``config.json`` setting is ``"BoardsRetentionDays": 0`` with numerical input. |
168+
| This feature's ``config.json`` setting is ``"BoardsRetentionDays": 365`` with numerical input. |
169169
+-----------------------------------------------------------------------------------------------------+
170170

171171
.. config:setting:: enable-message-deletion
172172
:displayname: Enable message deletion (Data Retention)
173173
:systemconsole: Compliance > Data Retention Policies
174174
:configjson: .DataRetentionSettings.EnableMessageDeletion
175175
:environment: MM_DATARETENTIONSETTINGS_ENABLEMESSAGEDELETION
176-
:description: Enable or disable message deletion during data retention job execution. Default is true.
176+
:description: Enable or disable message deletion during data retention job execution. Default is false.
177177

178178
Enable message deletion
179179
~~~~~~~~~~~~~~~~~~~~~~~
180180

181181
Enable or disable message deletion during data retention job execution. When set to false, messages will not be deleted regardless of other retention settings.
182182

183-
Default is true.
183+
Default is false. Possible values are true or false.
184184

185185
+-----------------------------------------------------------------------------------------------------------+
186-
| This feature's ``config.json`` setting is ``"EnableMessageDeletion": true`` with boolean input. |
186+
| This feature's ``config.json`` setting is ``"EnableMessageDeletion": false`` with boolean input. |
187187
+-----------------------------------------------------------------------------------------------------------+
188188

189189
.. config:setting:: enable-file-deletion
190190
:displayname: Enable file deletion (Data Retention)
191191
:systemconsole: Compliance > Data Retention Policies
192192
:configjson: .DataRetentionSettings.EnableFileDeletion
193193
:environment: MM_DATARETENTIONSETTINGS_ENABLEFILEDELETION
194-
:description: Enable or disable file deletion during data retention job execution. Default is true.
194+
:description: Enable or disable file deletion during data retention job execution. Default is false.
195195

196196
Enable file deletion
197197
~~~~~~~~~~~~~~~~~~~~
198198

199199
Enable or disable file deletion during data retention job execution. When set to false, files will not be deleted regardless of other retention settings.
200200

201-
Default is true.
201+
Default is false. Possible values are true or false.
202202

203203
+--------------------------------------------------------------------------------------------------------+
204-
| This feature's ``config.json`` setting is ``"EnableFileDeletion": true`` with boolean input. |
204+
| This feature's ``config.json`` setting is ``"EnableFileDeletion": false`` with boolean input. |
205205
+--------------------------------------------------------------------------------------------------------+
206206

207207
.. config:setting:: enable-boards-deletion
208208
:displayname: Enable boards deletion (Data Retention)
209209
:systemconsole: Compliance > Data Retention Policies
210210
:configjson: .DataRetentionSettings.EnableBoardsDeletion
211211
:environment: MM_DATARETENTIONSETTINGS_ENABLEBOARDSDELETION
212-
:description: Enable or disable boards deletion during data retention job execution. Default is true.
212+
:description: Enable or disable boards deletion during data retention job execution. Default is false.
213213

214214
Enable boards deletion
215215
~~~~~~~~~~~~~~~~~~~~~~
216216

217217
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.
218218

219-
Default is true.
219+
Default is false. Possible values are true or false.
220220

221221
+----------------------------------------------------------------------------------------------------------+
222-
| This feature's ``config.json`` setting is ``"EnableBoardsDeletion": true`` with boolean input. |
222+
| This feature's ``config.json`` setting is ``"EnableBoardsDeletion": false`` with boolean input. |
223223
+----------------------------------------------------------------------------------------------------------+
224224

225225
.. config:setting:: batch-size-data-retention
226226
:displayname: Batch size (Data Retention)
227227
:systemconsole: Compliance > Data Retention Policies
228228
:configjson: .DataRetentionSettings.BatchSize
229229
:environment: MM_DATARETENTIONSETTINGS_BATCHSIZE
230-
:description: The number of records to process in a single batch during data retention job execution. Default is 1000.
230+
:description: The number of records to process in a single batch during data retention job execution. Default is 3000.
231231

232232
Batch size
233233
~~~~~~~~~~
234234

235235
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.
236236

237-
Default is 1000.
237+
Default is 3000. Possible values are any positive integer (≥ 0).
238238

239239
+-------------------------------------------------------------------------------------------------+
240-
| This feature's ``config.json`` setting is ``"BatchSize": 1000`` with numerical input. |
240+
| This feature's ``config.json`` setting is ``"BatchSize": 3000`` with numerical input. |
241241
+-------------------------------------------------------------------------------------------------+
242242

243243
----

0 commit comments

Comments
 (0)