Overview
Reveal’s Archives feature allows users to export and store all of a previous case’s data for personal records. Data is converted to a .tgz file using the gzip algorithm, which significantly decreases storage requirements and expedites file transfers.
The archival process will save a single copy of your files, even if they exist in multiple locations (e.g. a file is in both Review and in Processing). However, file paths are saved, which allows the files to return to all its prior locations if your project is restored.
Each newly created archives project is uploaded to Reveal’s cloud storage. The archive will compress and store the following information:
Native Files: Original unprocessed files created by the application that generated them such as documents, spreadsheets, presentations, or other file formats.
Image Files: Visual content, such as photos, graphics, and scans.
Text Files: Plain text files, such as documents, emails, or other textual data.
SQL database files: Structured data in a relational database format, often used for managing large datasets.
The Review database: All S3 file references in the Review project (natives, text, images, PDFs, productions, production exports, etc.) including all file references in the database.
The Processing database: All S3 file references in the Processing project (natives, text, images, etc.) including all file references in the database.
The AI database (also known as Reveal AI or RAI): All S3 file references in the AI project (vectors, reports, etc), used for Supervised Machine Learning functions.
Other Content: Other project-specific content like project settings, saved searches, work folders, AI models, etc.
The only content that will not be saved in your archive are your project’s indexing and AI sync, both of which can be rerun upon restoring your project, bringing your project to the state it was in before it was archived. See Restoring an Archived Project for more details.
Note
If your Reveal project does not have RAI enabled, there will be no RAI SQL database file in your downloaded archives. If you did not connect processing to your project, there will be no Processing SQL database file in your downloaded archives.
When to Archive a Project
Archive a project when you want to fully offload it from the platform and minimize storage costs. We recommend archiving only when you are confident the project will not need routine access, as restoring an archived project requires coordination with Customer Support.
Archive Steps
To fully archive a project, you will need to perform the following steps:
Create an archive in the Reveal platform as outlined in Create and Manage Archives.
Download the archive to your computer as outlined in Download Archives – Download Manager.
Optionally, you can extract your archive to uncompress the files as outlined in Extract Archives – Archive Extractor.
Our Archives Quality Control Checks article provides areas where you can check values across the full archive process for each of the above steps.
Archive Permissions
By default, Instance and Company Admins have the ability to manage archives in both the Companies > Archives and Jobs > Archives tabs, while Project and Client Admins can manage archives only within their assigned product via the Jobs > Archives tab.
Two permissions can be toggled on/off for the archives feature.
Manage Case Archives: Can create, download (via the access token), and delete archives.
View Archives: Can only view existing archives. Does not have access to the token, and cannot download Archive Downloader or Archive Extractor.
.png)
Important
Checking the “Manage Case Archives” permissions does not also give users the ability to view archives. Those with management permissions must also have “View Archives” checked in order to access the Archives tabs within Companies and Jobs.
For further instructions on how to change permissions, see our Create Roles article.