Compliance Export Beta (E20)

Available in Enterprise Edition E20.

This feature enables compliance exports to be produced from the System Console, containing all messages including those made in direct message channels, as well as file uploads. The exports also include information on channel member history at the time of the message was posted.

By default, Mattermost stores all message history providing an unlimited search history to admins and end users. In Enterprise Edition E20, you may set a custom data retention policy for how long messages and file uploads are kept in Mattermost channels and direct messages.

Those Enterprise deployments who want to archive history beyond the data retention period can enable this add-on to export compliance reports to third-party systems. Integration with Actiance Vantage and Global Relay are currently supported, with integrations with other systems in the roadmap.

Note

This feature will replace the existing Compliance feature in a future release. Compliance exports to CSV will continue to be available in Enterprise Edition E20.

Set Up Guide

Use the following guides to configure exports for Actiance XML or Global Relay EML. Compliance exports are written to the exports subdirectory of the configured Local Storage directory in the chosen format.

Note

The compliance exports do not contain posts sent before the feature was enabled, but you can export past history via the export command line tool. Posts made prior to upgrading to Mattermost v4.5 will have less accurate channel member history information.

Actiance XML

  1. Go to System Console > Advanced > Compliance Export (Beta).
  2. Enable compliance exports, then set the start time of the daily scheduled compliance export job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.
  3. Set the export file format to Actiance XML.
  4. Save the settings. You’re now all set!

If you have chosen your file format to be Actiance XML, you can set up an integration with Actiance Vantage archive system. For more information, see their homepage.

Note

In Actiance XML exports, channel type is prepended to the channel names.

Global Relay EML

  1. Go to System Console > Advanced > Compliance Export (Beta).
  2. Enable compliance exports, then set the start time of the daily scheduled compliance export job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.
  3. Set the export file format to GlobalRelay EML.
  4. Set the Global Relay Customer Account, either A9/Type 9 or A10/Type 10. This is the type of Global Relay customer account your organization has.
  5. Set the Global Relay SMTP username, password and email address as provided by Global Relay.
  6. Save the settings. You’re now all set!

If you have chosen your file format to be Global Relay EML, you can set up an integration with Global Relay archive system. For more information, see their homepage.

Note

Messages larger than 100MB will have their attachments removed because they are too large to send to Global Relay. An error is added to the server logs with id global_relay_attachments_removed. It includes the post ID the attachments were removed from. A ticket is queued to better handle large messages.

For more information on GlobalRelay archive system, see their homepage

Frequently Asked Questions (FAQ)

How do I export past history?

Run the export command line tool. You can specify an exportFrom option to export data from a specified timestamp. All posts that were made after this timestamp will be exported.

What happens if I export data manually?

If the compliance export job is run automatically, manually via the System Console, or manually via the CLI (without the --exportFrom option), it exports all posts that were made since the last post that the previous execution of the job exported. If this is the first time that the job has ever run, all posts that were made since the feature was enabled will be exported.

If the --exportFrom option is specified with the CLI command, all posts that have been made since the supplied timestamp will be exported.