Reveal Help Center

Company Admin

The Company Admin page is where administrators can create new companies, clients, users and projects.

603d319e8bb9e.png

Only users who have been designated a Company Admin for at least one company will have this option available. 

Company Projects are displayed on the landing page, with the total project statistics shown at the right.

603d31a04f893.png

Selecting any individual Project offers a chance to Show Stats or Export Stats or open Project details, which includes Project Users and Archives. 

The hierarchy managed here starts with Company at the top; there may be more than one Company per Reveal instance. Each Company may have one or more Clients, each a separately manageable compartment with its own Projects and Users. 

See:

Edit Company

Under Company Admin open the Companies tab to view and modify a Company. Select the company (highlighted below) to see available options.

603d31a21968a.png

On opening the company link administrators may modify the company's name and logo. 

This screen presents a three-tabbed table so that an administrator can also modify or create clients, projects and users on this page.

Clients

The first tab, Clients, lists all clients of the company. Additional Clients may be added to this instance of Reveal. The required pieces of information to create a client are (1) Client Name, (2) Client Number, and (3) Client Company, selected from a picklist. Once created, these values cannot be changed. There are fields below for client address and contact information, as well as Client Notes. The screen focus changes to the Clients tab after creating or editing a client. See Working with Clients for more information.

Projects

The second tab, Projects, lists all projects for the company and its clients for viewing, archiving and modification. Opening a Project shows a statistics pane on the right (below the Edit button, where users are assigned, security set and artificial intelligence enabled for the project), a user list (from which users may be selected for removal) and the project archiving tool. See Creating Projects and Creating Project Archives for more information. The screen focus changes to the Projects tab after creating or editing a project.

Users

The third tab, Users, lists all users, active and inactive, configured under the Company. Clicking on any User record enables viewing and editing of the User account and assignments. See Working with Users for more information. The screen focus changes to the Users tab after creating or editing a user.

See Managing Company for details on setting up a Company under Reveal Review Manager.

Working with Clients

A Client is a partition within the Company instance where multiple projects may be created and managed and users created and assigned within separate virtual spaces. More than one Client may exist per Reveal Company. 

The Clients tab under Company Admin facilitates creating, managing and deleting clients. This is the same functionality found in the Clients tab under Company. 

The pieces of information required to create a client are (1) Client Name, (2) Client Number, and (3) Client Company, selected from a picklist. Once created, these values cannot be changed. There are fields below for client address and contact information, as well as Client Notes. The screen focus changes to the Clients tab after creating or editing a client.

603d31a429255.png
Creating and Managing Projects

Projects are the Reveal database structures within which document review, coding and production take place. There may be multiple projects for each Client (along with multiple Clients for each Reveal Company instance). Client Users are grouped and assigned to Projects, security is set, data are loaded and processed, and archives of projects may be created.

The creation and management of Projects is done by project managers and administrators either in the back-end Reveal Review Manager or in the Company Admin under the Flyout Menu.

Creating a Project

To create a project under Company Admin > Projects:

6064ae82f40c7.png
  • Navigate the Flyout Menu to the Company Admin page. It opens to the Projects tab.

  • Click the Create new project button in the upper left corner. This will launch the create project screen.

    • Name the project (required).

    • Assign a project id (required).

    • Associate the project with a Company, selecting from the dropdown list (required). The User list below populates when the Company is selected.

    • Associate the project with a Client, selecting from the dropdown list (required).

    • Select Enable document-level security to extend Reveal security to individual documents; this must be selected for use.

    • Enable artificial intelligence is enabled for all projects by default.

    • Set your project's review Time Zone to automatically normalize email metadata shown in HTML, extracted text and tiff-on-the-fly views to match the timezone that is set for your project here. Reveal will also normalize email metadata shown in images when performing a production or print job.

    • Assign Users to the project.

    • Select a Group for each user who is added to the project. The group is what is used to assign permissions for the user for this project. You must add at least one user - ideally an Admin or Client Admin - to finish creating a project.

  • Confirm your information and click the Save button to create the project. It will look like this to show that the project is being created:

    6064ae84ae618.png
  • A pop-up will notify that the project has been successfully created.

6064ae86448ef.png
Managing a Project

To view and manage a project click on the Project Name in the Projects table.

The project details screen shows

  1. the case name at the top with the Case ID and Company in the header;

  2. all Users assigned to the case with the assigned Team and Role of each;

  3. Archives made, along with a control to Create archive; and

  4. Summary case statistics in the shaded pane to the right.

In this screen the administrator may

  • select a User or Users for deletion from the project.

  • create a new archive (see Creating Project Archives for more information).

  • select an archive for deletion.

  • click Edit in the upper right corner above the Statistics table to amend security settings, add Users or change their group assignments. See Working with Users for more information.

603d31aa79688.png
Automatic Work Product Creation

When a new project is created, certain items of default work product are automatically created within the project. These items are:

  1. Default Field Profile - A default field profile is made available.

  2. Default Tag Profile - The Standard First Level Review tag profile is created and automatically assigned to the Original Administrators team.

  3. Default Redaction Profile - A default redaction profile is present and is automatically assigned to the Original Administrators team.

Project Statistics and Exporting Billing Stats

After a project is created, you can see your project statistics in the Company Admin/Projects area by clicking 'Show Stats for Selected.'

6064ae8a64c34.png
  • Project Summary statistics in the panel at right includes the size of the project indexes, natives/text files, images, database size, documents stored in the project, and production files/images as well as the total size of all of these together. Each category includes an explanation of what factors are included that total.

6064ae8c74529.png
  • The Export Stats function exports an Excel file containing billing statistics information for all of the projects in your Company. There are two types of Export Stats reports:

    • Case Stats (the default)

6064ae8e640f6.png
  • Peak Billing Info - which exports peak billing statistics between any two dates set in the dialog.

6064ae90357a2.png
  • The information included in each of these billing stats report is the following:

    • Project ID

    • Project Name

    • Company

    • Client

    • Project Created Date

    • Number of Users with Access to the Case

    • Names of the Users with Access to the Case

    • Index Size in Gigabytes

    • Native/text in Gigabytes

    • Image Size in Gigabytes

    • Production Size in Gigabytes

    • Documents Size in Gigabytes

    • Database Size in Gigabytes

    • Total Size of all of the above in Gigabytes

  • The Show Stats function reports statistics for any selected project or group of projects.

6064ae925cfb7.png
Creating Project Archives
  1. Navigate to Client Admin from the Flyout Menu.

  2. Client Admin opens to the Projects tab.

  3. On the Projects table select the project to be archived to open its Details screen.

  4. In the Archives section, click the Create Archive button and confirm that you wish to create an archive when prompted.

  5. An archive job will run and the status next to the job will show Completed.

    603d31b1ea329.png

See Downloading Project Archives and Verifying Project Archives.

Downloading Project Archives
  1. Navigate to Client Admin from the Flyout Menu.

  2. Client Admin opens to the Projects tab.

  3. On the Projects table select the project to be archived to open its Details screen.

  4. In the Archives section, locate the archive that you wish to download (or have just created with reference to Creating Project Archives).

    Project_Archives.png
  5. The archive can now be downloaded and stored online or offline.

    • To download, click an access token to copy it to the clipboard.

    • Click "Get Download Manager" and click Save File when prompted.

    • Download and run the utility.

    • When prompted, paste in the access token.

      603d31b3f2a14.png
    • The download is complete with the Logs and Reports item.

      603d31b634784.png

    See Verifying Project Archives.

Verifying Project Archives

This article details a few methods you can use to check the integrity of a Reveal archive. Each method in this article should be expected to require more manual time than the one before it, but each additional method should provide more assurance of the integrity of the data, which is after all the point of the exercise. 

  1. Does every ZIP verify successfully? 

    After initially downloading all ZIP's it's worth using a tool such as 7-Zip to verify the integrity of every file:

    603d31b8553a9.png

    Should every ZIP verify fine, you should see a message similar to the below:

    603d31bb6ba5b.png

    Note that it is not a problem if some of the ZIP files contain little to no data as long as they verify successfully. The way the archive runs it is possible for smaller cases to end up with empty ZIP files. 

  2. Quick content check.

    Extract every ZIP to the same directory. In both WinRAR and 7-zip you can do this by highlighting every ZIP file and selecting Extract Here. After extraction, you should see two top-level directories similar to this:

    603d31bd6276c.png

    The revealdata-s3store-XXXXXX directory contains the raw natives, text, etc. for the case organized as they existed in our storage location. The Logs and Reports directory contains logging information about the archive. Inside that folder you should see a logs directory and a User Information.csv report. 

    For a final quick content check, in the revealdata-s3store-XXXXXX directory there should be a single directory with a name longer than the rest:

    603d31bff3864.png

    This directory should contain a SQL backup .BAK file for the database:

    603d31c2af0f6.png
  3. Log check 

    Back inside the Logs and Reports directory there should be a subdirectory named logs. Inside this logs directory there should be a log file named archive-creation.log. This log has two fast things to check to make sure no errors happened: 

    1. First do a case sensitive search for ERROR. If any high-level errors were hit in the archive then you should see some entries with that text. However, most likely if a high-level error like this is thrown the archive will already be marked as erroneous in Reveal's web front-end:

      603d31c5333f0.png
    2. At the bottom of this log should be a line that says:  

      Total files expected to be archived not accounting for errors 

      In this extremely small testing example there are expected to be twenty-five files in the archive:

      603d31c8279d8.png

      If you go back to the top of the revealdata-s3store-XXXXXX directory and run a file count, the total number of files should match the log's expectation:

      603d31c9db0d4.png
  4. ZIP hash check 

    This last step will require manual or programmatic effort on the side of the verifier. At time of writing Reveal has no automated local verification program for archives. At time of writing hashes for archive files use the SHA256 algorithm. The below screenshots show the hashing of files via Powershell with the following command: 

    get-filehash -Algorithm SHA256 

    The archive-creation.log file contains hash information for every ZIP and every file successfully archived. Hashes for ZIP files can be pulled by searching for the following text: 

    Ending ZIP file 

    For example: 

    2020-01-11 06:07:48,015 - MainThread - INFO - Ending ZIP file: s3://revealdata-s3store-000500/1000000000/0000000352/Archive/af90dcc1-0aff-4ead-bce4-41f22be29444/62662d9e-7acb-46cc-b4a2-5a8d8bf674d7.zip with hash: 8739c76e681f900923b900c9df0ef75cf421d39cabb54650c4b9ad19b6a76d85 

    Back at where you're storing the ZIP files, the file 62662d9e-7acb-46cc-b4a2-5a8d8bf674d7.zip should have the SHA256 hash 8739c76e681f900923b900c9df0ef75cf421d39cabb54650c4b9ad19b6a76d85:

    603d31cbb68e1.png

    Ideally, by checking each ZIP hash in this manner you are also verifying the hash integrity of every contained document.  

  5. Individual File hash check 

    If you want to go down to a file level for hash checking, search for the following lines in the archive-creation.log file: 

    File archived successfully 

    For example: 

    2020-01-11 06:07:33,193 - MainThread - INFO - File archived successfully:    s3://revealdata-s3store-000500/c99e413f-7bda-42f8-a0a8-de5bf9ba48d0/corp_99999_00000Enron.bak    1414a34c7578ba7b8433b6362a52369a42034ddd5ff1fb70a0384804dc85bd4e 

    In this example, the file located at revealdata-s3store-000500/c99e413f-7bda-42f8-a0a8-de5bf9ba48d0/corp_99999_00000Enron.bak is expected to have the SHA256 hash 1414a34c7578ba7b8433b6362a52369a42034ddd5ff1fb70a0384804dc85bd4e:

    Verifying_Project_Archive_Hash2.png

    In this manner you can parse the archive-creation.log file and verify the integrity of every file in the archive via SHA256 hash.

Deleting a Project

When a project is completed the time comes when it should be deleted. It is generally recommended to create, verify and download an archive first (see Creating Project Archives). This is the process for deleting a project.

603d31cda28b7.png
  • Open Company Admin under the Flyout Menu.

  • The Projects tab appears first.

  • Check the box next to the project you wish to delete.

  • The Projects toolbar appears, with Delete at the right end.

  • Click Delete.

  • A strongly-worded confirmation box appears.

    603d31cfadb9a.png
  • Type DELETE in the text box and click Submit.

  • This will delete all records and artifacts from the case. This cannot be undone.

Working with Users

Users in Reveal are created under the Company and are assigned to Projects. User accounts are maintained and may be assigned under the Users tab in Company Admin. Users may also be managed under the Company screen in the Users sub-tab, or under any Project with respect to participation and group membership in that project.

Create a User

To create a User, click Create User at the upper left corner of the Users table.

603d31d182137.png
  • User Name must be unique (required).

  • First Name (required).

  • Last Name (required).

  • Email address (required).

  • Password may be auto generated or entered and confirmed at your option (required).

  • Enable User is checked by default when a user is created.

  • Two Factor Authentication is optional for verified login.

  • You may Show more optional fields for capturing contact information for the User.

  • Next assign the User to a Company.

    • Can designate User as Regular or a company Admin.

  • The User may be assigned to one or more Projects from this screen as well.

    • In selecting a project, be sure to select the Group in which the User should be placed for that project.

  • Click Save when done.

Modifying a User

Click on the User Name in the Users table to open that User's details screen. In the User Details screen:

  • Can edit a user's First NameLast Name and Email Address, but not the User Name field.

  • Can change a user's Password.

  • Can Enable/Disable a user account.

  • Can turn on Two Factor Authentication.

  • Can add contact information in the optional fields.