Skip to content

Commit 082ca2b

Browse files
docs: add data retention support for preserving pinned posts
- Add Preserve pinned posts configuration setting in compliance settings - Update data retention policy documentation to reflect pinned post preservation option - Available from Mattermost server v10.10 onward Closes #8070 Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
1 parent 4611c65 commit 082ca2b

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

source/comply/data-retention-policy.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ To set a global data retention policy:
2222
2. Select **Edit** from the menu located to the right of the **Global retention policy** table.
2323
3. Specify a global retention policy for channel messages and direct messages by selecting a **Channel & direct message retention** option from the dropdown, then set how long to keep those messages in hours, days, or years. When a time is set, messages and file attachments older than the duration you set will be deleted. The minimum retention period is one hour.
2424
4. Select a **File retention** option from the dropdown. Set the number of hours, days, or years to keep files. When a time is set, uploaded files which are older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage**). The minimum retention period is one hour. The global file policy deletes all files regardless of whether they're in a direct message, private, or public channel.
25-
5. Under the **Policy log** section, select **Edit** to specify the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system.
25+
5. *(Available from Mattermost server v10.10)* Optionally enable **Preserve pinned posts** to prevent pinned posts from being deleted by data retention policies, even if they exceed the configured retention period.
26+
6. Under the **Policy log** section, select **Edit** to specify the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system.
2627

2728
Select **Save**. Messages and files older than the duration you set will be deleted at the specified server time, as applicable.
2829

@@ -55,11 +56,15 @@ Frequently Asked Questions (FAQs)
5556
What happens when a message is deleted?
5657
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5758

58-
The message is removed from the Mattermost user interface and deleted from the ``Posts`` table. The message is no longer searchable and cannot be retrieved in pinned posts or saved posts lists.
59+
The message is removed from the Mattermost user interface and deleted from the ``Posts`` table. The message is no longer searchable and cannot be retrieved in saved posts lists.
5960

6061
Replies that did not exceed the message duration are still displayed in the user interface. However, further replies are no longer possible.
6162

62-
If there was a file attached to the message, it will be removed from the user interface only.
63+
If there was a file attached to the message, it will be removed from the user interface only.
64+
65+
.. note::
66+
67+
From Mattermost server v10.10, you can optionally preserve pinned posts when data retention policies delete messages by enabling the **Preserve pinned posts** setting in **System Console > Compliance > Data Retention Policies**. When enabled, pinned posts will not be deleted even if they exceed the configured retention period.
6368

6469
Why can I still see messages that were supposedly deleted?
6570
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/configure/compliance-configuration-settings.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,28 @@ By default, files are kept forever. If **Hours**, **Days**, or **Years** is chos
7979

8080
From Mattermost v9.5, when a ``FileRetentionHours`` value is configured, the ``FileRetentionDays`` value must be 0 in the ``config.json`` file. Conversely, when a ``FileRetentionDays`` value is configured, the ``FileRetentionHours`` value must be ``0``.
8181

82+
.. config:setting:: preserve-pinned-posts
83+
:displayname: Preserve pinned posts (Data Retention)
84+
:systemconsole: Compliance > Data Retention Policies
85+
:configjson: .DataRetentionSettings.PreservePinnedPosts
86+
:environment: MM_DATARETENTIONSETTINGS_PRESERVEPINNEDPOSTS
87+
:description: Controls whether pinned posts are preserved when data retention policies delete messages. Available from Mattermost server v10.10.
88+
89+
Preserve pinned posts
90+
~~~~~~~~~~~~~~~~~~~~~
91+
92+
*Available from Mattermost server v10.10*
93+
94+
Controls whether pinned posts are preserved when data retention policies delete messages. When enabled, pinned posts will not be deleted by data retention policies, even if they exceed the configured retention period.
95+
96+
**True**: Pinned posts are preserved and will not be deleted by data retention policies.
97+
98+
**False**: **(Default)** Pinned posts are deleted according to the configured data retention policy.
99+
100+
+-----------------------------------------------------------------------------------------------------------------+
101+
| This feature's ``config.json`` setting is ``"PreservePinnedPosts": false`` with options ``true`` and ``false``. |
102+
+-----------------------------------------------------------------------------------------------------------------+
103+
82104
.. config:setting:: custom-retention-policy
83105
:displayname: Custom retention policy (Data Retention)
84106
:systemconsole: Compliance > Data Retention Policies

0 commit comments

Comments
 (0)