Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compliance Export updates #7719

Merged
merged 3 commits into from
Feb 7, 2025

Conversation

cwarnermm
Copy link
Member

Documentation for: mattermost/mattermost#29789

@cwarnermm cwarnermm added this to the v10.5.0 milestone Jan 30, 2025
@cwarnermm cwarnermm requested a review from cpoile January 30, 2025 20:46
@cwarnermm cwarnermm added the 1: Dev Review Requires review by a core commiter label Jan 30, 2025
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 6cb981e

Copy link
Member

@cpoile cpoile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Carrie, this is super helpful!
I left some comments, can I look at it one more time before we send it off?


Compliance exports are produced from the System Console, containing all messages including:
While Mattermost stores all message history by default, system admins can specify a :doc:`custom data retention policy </comply/data-retention-policy>` for how long messages and file uploads are kept in Mattermost channels and direct messages.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Data retention is something different from compliance exports, though... I wonder if we're confusing the two by having this here?

Copy link
Member Author

@cwarnermm cwarnermm Feb 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Removed.


- Messages sent in direct message channels
- File uploads
- Posts from plugins
- Posts from bots/webhooks

Exports include information on channel member history at the time the message was posted.
Exports include information on channel member history at the time the message was posted.

- Entries for deleted messages and files are included in CSV and Actiance reports. The deleted content is included in the compliance export.
- Global Relay reports include file deletion entries but message deletion entries are excluded.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this -- all export formats include deleted message info now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

source/comply/compliance-export.rst Outdated Show resolved Hide resolved
Comment on lines 174 to 191
When the daily compliance export job is finished, a parent directory is created named based on when the export was started and the ``startTimestamp`` and ``endTimestamp`` of the export, e.g, ``compliance-export-2024-08-13-05h08m-1723105062492-1723109100075``. That parent directory contains 1 zip file for each batch, named based on the batch number and the start and end timestamps of the messages in that batch, e.g, ``batch001-1723105062492-1723106622163.zip``. Each zip file contains the same information available in previous Mattermost server releases.

Working from the same example above, the directory would look like this:

.. code-block:: bash

compliance-export-2024-08-13-05h08m-1723105062492-1723109100075
├── batch001-1723105062492-1723106622163.zip
├── batch002-1723106622163-1723108196005.zip
└── batch003-1723108196005-1723109100075.zip

And each batch would look like this:

.. code-block:: bash

batch001-1723105062492-1723106622163.zip
├── 20240808
└── actiance_export.xml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't relevant for Global Relay -- the results will be emailed to the recipient, at least one email per channel (or >1 email if the channel export is too large for one email).
We don't need to explain the format of the email, I think.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

Copy link

github-actions bot commented Feb 4, 2025

Newest code from mattermost has been published to preview environment for Git SHA a7b0a7c

Copy link

github-actions bot commented Feb 4, 2025

Newest code from mattermost has been published to preview environment for Git SHA f09065b

@cwarnermm cwarnermm requested a review from cpoile February 4, 2025 15:14
@cwarnermm
Copy link
Member Author

@cpoile - Can I get your help updating this docs PR to address mattermost/mattermost#28805, please?

@cpoile
Copy link
Member

cpoile commented Feb 4, 2025

@cwarnermm Sure: #7728

@cwarnermm cwarnermm added 3: Reviews Complete All reviewers have approved the pull request and removed 1: Dev Review Requires review by a core commiter labels Feb 7, 2025
@cwarnermm cwarnermm merged commit 8f65d70 into v10.5-documentation Feb 7, 2025
4 checks passed
@cwarnermm cwarnermm deleted the compliance-export-enhancements branch February 7, 2025 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3: Reviews Complete All reviewers have approved the pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants