Manage a Project

A Company is required for a Reveal project. Users assigned to projects have been designated permissions by an admin user.

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

Important

If you are a SaaS Customer, it is recommended that you follow the Web-Based instructions below to create Projects within your Reveal instance. If you are an On-Prem customer, you may only have the option to create Projects using the Legacy Web-Based option. If the Web-Based option is not available within your instance, please follow the Legacy Web-Based instructions instead. goes here

Web-Based Instructions

Instructions for creating and managing a company from the Companies page.

Manage a Project (Companies)

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.

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:
   

   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:
      
      - 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.
      

   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 be billed at your contractual cold storage rate. 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.
         

      2. Once deactivated, the projects summary statistics will clear from the screen, though this data still exists on the back end.
         

      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.
         

      5. To re-activate the project, open the project screen and click Re-activate Project. You will be asked to confirm.
         

      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 Web-Based Instructions

Instructions for managing a project from the Legacy Company Admin page.

Manage a Project (Company Admin)

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:
   

   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:
   
   

   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:
   
   

   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:
   

   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.