Create and Manage a Project - Reveal 2024

This article provides both visual and written instructions for setting up a new project.


Projects in Reveal are databases often equivalent to a specific legal matter, investigation, or analytical assessment. The Project is where users will review and classify documents for analytics and production.

A Company is required in order to create a new Reveal project. Users assigned to the company may then be assigned to projects created within that company and given appropriate role permissions. Clients can be created within the company as well to facilitate billing reporting.

This document will set out how to create and manage projects in Reveal.

Getting Started

An Instance or Company Administrator will open Reveal to this landing page listing currently available Projects (under Discovery) as a default for all users. Instance and Company Administrators will also see an Admin section in which they can administer Companies and, under each Company, its Users, Clients and Projects. Note that Instance or Company Administrators can see all projects in their purview, whether they are explicitly added to projects or not. Also note that the “Company Admin” link in the navigation sidebar is to the legacy Reveal Company Admin area only.  

200 - 01 - Admin Landing Page-1

On this initial administrator landing page you may use Search to filter the list based on Project Name. You can click a star next to a project to mark it as a favorite which displays it by default on opening Reveal, or when toggling between the Favorites and All selector. 

200 - 01a - Admin Landing Page - Favorites

To create and manage Projects, an administrator must be in the Admin > Companies > [Company] area. Note that this also means that a Project listed under a Company’s Projects cannot be opened directly from there.

Setting Up Projects

  1. Open Companies in the Admin box on the landing page.
    admin companies button
  2. In the Companies screen, select the company whose projects are to be administered. This will open to the company’s Overview screen.
  3. Click Projects in the Company screen navigation bar to create, configure and populate matters for Reveal. 
    203 - 00 - Company Project Overview page showing Projects button
  4. The Projects screen displays, in addition to the +Add Project button and Search filter:
    1. Name of project, sortable by clicking the heading and searchable. Clicking the project name will open the project details, not the project itself, as noted above.
    2. ID is the unique identifier of the project.
    3. Documents is the current total number of documents in the project database.
    4. Status shows whether the project is Active or in Cold Storage. Cold Storage, new in Reveal 2024.7, takes a project offline so that it cannot be opened and makes it invisible to users other than administrators, in order that the project not be billed if in Cold Storage for the entire month. If requesting or implementing Cold Storage, please check with your consulting or sales representative as to process and implications. This will be discussed further under Managing a Project below.
    5. Edit opens the project details for editing.
      203 - 01 - Project Page-1
  5. You may click Add Project to enter the following information:203 - 02 - Create Project-1 
    1. Name{required} The project name. NOTE that project names may be descriptive labels that include spaces, but not any of the following characters: : * ? \\ / < > | " 
    2. Id {required} Short alphanumeric identifier for the project.
    3. Company – {required} Sets the company within which the project is created for Reveal and Processing.
    4. Client{required} Sets the client within which the project is created for Reveal and Processing.
    5. Features – There are two checkboxes here, neither checked by default:
      1. Enable Document-Level Security to extend Reveal security for Document Access to individual documents.
      2. Use as Template for Future Projects to name and reuse these project settings.
    6. Time Zone - {required} Sets the time zone for project data in Reveal and Processing to automatically normalize email metadata shown in HTML, extracted text and tiff-on-the-fly views to match the time zone that is set for your project here. Reveal will also normalize email metadata shown in images when performing a production or print job. NOTE: The time zone cannot be changed after case creation.
    7. Processing Template – Select an existing Processing project template from the drop-down menu.
    8. Save when completed.
  6. A create project status box will open and display the progress of the various stages during the creation of a Reveal project. This includes its processing, database, and analytics components. When complete, the project can be loaded and is ready to be populated with data for review.
    create project 1 of 5-1

    Managing a Project

    As noted above, a Reveal Project is managed under Admin > Companies > [Company] > Projects in the user interface. There is also the legacy Company Admin area, which offers project Peak Billing Info and Case Status reports. Below we will set out the access and use of each project administration area and its tools. 

    Updated Companies > [Company] > Project Interface

    1. Open Companies in the Admin box on the landing page.
    2. In the Companies screen, select the company whose projects are to be administered. This will open to the company’s Overview screen.
    3. Click Projects in the Company screen navigation bar.
    4. To open a project, click on its Name. This will open a project summary view presenting:
      203 - 07 - Project Summary Screen (New)
      1. The project ID (not editable).
      2. The Company (linked).
      3. The Client (linked).
      4. Time Zone – set at project creation, not editable.
      5. Edit (which may also be opened from the Edit control at the right of the project’s table entry). The only project items that may be updated here are:
        203 - 08 - Edit Project
        - The Name.
        - Enable Document-Level Security checkbox.
        - Use as Template for Future Projects checkbox.
      6. Usage Statistics for the various storage categories – TOTAL, Indexes, Native/Text, Images, Databases, Documents and Production – are presented as figures, graphically, and are available for download, currently only for the last 30 days.
        203 - 13 - Project Stats Export
      7. Cold Storage is the last item on the screen. As noted above, Cold Storage takes a project offline so that it cannot be opened making it invisible to users other than administrators. The project will not be billed if it remains in Cold Storage for the entire month. If requesting or implementing Cold Storage, please check with your consulting or sales representative as to process and implications.
        1. To place a project in Cold Storage, click the Move to Cold Store button at the bottom of the project summary screen. You will be asked to confirm.
          203 - 09 - Move to Cold Storage
        2. Once deactivated, the projects summary statistics will clear from the screen, though this data still exists on the back end.
          203 - 10 - Deactivated Project screen
        3. To exit the project summary screen, click the Projects button in the navigation sidebar.
        4. The project status will now show Cold Storage. Only administrators will see this.
          203 - 11- Cold Storage Project status
        5. To re-activate the project, open the project screen and click Re-activate Project. You will be asked to confirm.
          203 - 12 - Re-Activate Project
        6. The project will be fully enabled with all data, users and settings as previously. Note that a project will be fully billable for any part of a month in which it is Active, even if only part of a single day.  

    NOTE: Projects may be moved into and out of cold storage as often as needed, with no limits. Users are locked out instantly when the project is moved into cold storage and receive access back instantly upon re-activation with all permissions intact. Only a browser refresh may be required on the user’s part to re-enter the project. Usage tracking does not change and all logs are maintained. The only thing that changes is a flag indicating whether the project was in cold storage for that day.  

    Legacy Company Admin > Projects Interface

    1. Log in to Reveal as an Administrator.
    2. Select Company Admin at the landing page sidebar.
    3. The opening Projects tab lists all the current projects; the Summary pane on the right provides information for the amount of data utilized. Any column in the table may be filtered by example. The columns displayed are: 
      203 - 03 - Company Admin - Projects
      1. ID – A unique alphanumeric identifier for the project.
      2. Name – The project’s descriptive name is a clickable link to the project detail screen.
      3. Company – The company under which the project was created.
      4. Client – The company client under which the project was created.
      5. Created Date – The date on which the project was created.
      6. Users – The current number of users actively assigned to the project.
      7. Timezone – The normalized time zone setting for the project; this value cannot be changed.
    4. In addition, there are two controls above the Projects table if no projects are selected:
      1. Create new project – Another way to access the project creation workflow described above. 
      2. Export stats – Choose which project report to generate:
        1. Peak Billing Info – Selecting this will prompt for a Start Date and an End Date to report maximum usage over the specified period.
        2. Case Stats – Outputs project table data plus storage statistics in each Summary category for each project.
    5. If a project in the table is selected (or multiple projects are selected), additional controls are displayed above the table:
      203 - 04 - Show Selected Project stats
      1. Create new project.
      2. Export stats.
      3. Show stats – Displays a pop-up report of storage statistics for the project(s) selected.
      4. Details – Opens the Project Details screen, the same as clicking on the Project Name in the table.
      5. Edit – Opens the project directly to its Edit screen for updating.
      6. Delete – Removes the selected project(s). It is advised to apply this action with extreme caution only after verifying that no useful active data exists in the project.
    6. To view and manage a project click on the Project Name in the Projects table. The Project details screen displays:
      203 - 05 - Project Details screen
      1. The case name at the top with the Case ID and Company in the header;
      2. A listing of all Users assigned to the case with the assigned Team(s) and Role of each; and
      3. Summary case statistics in the shaded pane to the right.
      4. To manage project users or settings click Edit at the upper right of the screen.
    7. In the Edit Project screen the administrator may view the Project Name, ID and Time Zone; these values may not be changed after the project is created. Items which may be edited for the Project are: 
      203 - 06 - Edit Project
      1. Name is the display name of the project, which cannot be amended.
      2. ID is the internal identifier of the project, which cannot be edited.
      3. Company selects the Company with which the Project is associated.
      4. Client selects the Company Client with which the Project is associated.
      5. Time Zone for the project may be viewed but not changed.
      6. Document Access sets document level security on or off.
      7. Artificial Intelligence sets access to AI analysis; this is set ON by default.
      8. Users is where available users may be assigned to or removed from the project. Users assigned must have a security group specified in order to access the project. See How to Create & Manage Users for more information.
      9. Click SAVE when modifications are complete. 

     

    Last Updated 10/17/2024