Production Pilot - Smoke Test v11

Document Purpose

There are four types of Pilots that the SSE team supports. Two of the Pilot Types is Production and Live. These Pilot Types require a production environment so that the prospect can test the full Reveal Platform.

This document will provide the steps to properly smoke test a new production environment prior to providing it to the client. This will consist of three tests for the Discovery Manager, Uploader, and the Review Manager.

Technical Documentation

To access all technical documentation within the Reveal Discovery Platform, please go to our Online Help Portal.

High Level Process Overview

Below provides the high-level illustration of this entire process.

Access to Load Machine

All Load Machine access is administered through Perimeter 81. To access a Load Machine, you can follow the high-level steps below.

1. https://landing.revealdata.com
2. Use your Reveal Universal ID to login
3. Find/click on the icon for your Load Machine by searching for the MSA.
4. If you cannot find or access your Load Machine, please email support@revealdata.com and ask for access.

Stage Smoke Test Data

There are three steps to stage the Smoke Test Data.

1. Download the test data to the Load Machine.
2. Copy/Unzip the data to the root of the Z:\ drive on the Load Machine.
3. Copy the Smoke Test Data to the Pilot’s S3 Bucket.

Download Test Data

Follow the steps below to download the Test Data.

1. On the Pilot’s Load Machine, use the following link in Chrome to download the Test Data,
   
   1. https://revealdata-public-test-data.s3.us-east-1.amazonaws.com/%21Smoke%20Tests.zip

Copy/Unzip the Data

1. After downloading the zip file, copy it to the Z:\ drive of the Load Machine.
2. Unzip this file to the root of the Z:\ drive so it looks like the below.
   1. 
   2. 

Copy Smoke Test Data to S3

The Smoke Test for Discovery Manager requires processing from the MSA's S3 Bucket. Follow the steps below to copy the Smoke Test Data from the Z:\ drive to the proper S3 Bucket.

1. On the Pilot’s Load Machine, open the S3 Browser, and access the Temporary folder for the S3 Staging Bucket for the MSA you are smoke testing. If you have not accessed the S3 Browser before, please see this video.
   1. Please note that this video is specifically for the SSE team.
   2. If you are not on this team and you are unsure of how to access the proper S3 Bucket, please contact support@revealdata.com. Make sure to provide support the MSA for the environment.
2. Connect to the S3 Staging Bucket for the MSA.
3. Open the unzipped !Smoke Tests folder, and drag and drop the SmokeTestData subfolder into the Temporary folder in the MSA's Bucket. Please do not copy the _RapidPilot folder to S3.
   1. 

Smoke Test Setup

Reveal Review Manager is used to administer your instance of Reveal Review. In Review Manager, you can do any number of functions associated with the administration of Review such as create databases, manage users, load large amounts of data, set analytics and more. To see more information about this, please see Reveal Review Manager Overview.

Create Company

The Reveal Company may already exist. If it does exist, please skip this step, otherwise create the Company Reveal using the steps below.

A Company is the highest level of organization in our permission structure. Please create a Company named Reveal.

1. Open Review Manager on the Load Machine
2. Expand Instance Setup
3. Click Companies
4. Click the Add New tab
5. Enter Reveal as the Company name, and click Insert
   1. 

Create Client

This Client may already exist. If it does exist, please skip this step, otherwise create the Client Reveal using the steps below.

A Client is only associated with one Company. A Client can have multiple projects associated with it and is a way to keep a logical structure to the projects.

1. Open Review Manager on the Load Machine
2. Expand Instance Setup
3. Click Clients
4. Click the Add New tab, enter Reveal as the Client name, enter a Client Number (typically a number, recommended to use date created in YYYYMMDD format), associate the Client with a Company, and Click Insert
   1. 

Create Rapid Pilot (RP) Enron Project

After creating or using a previously created Company and Client, follow the steps below to create a new Rapid Pilot.

1. Open Review Manager on the Load Machine
2. Expand Instance Setup, select Projects
3. Click the New tab
4. Enter the Project Name (use ‘RP_’ as the prefix, the client's MSA_Enron as the project name, i.e. RP_81010001_Enron), enter a Project ID (typically a number, recommended to use date created in YYYYMMDD format), associate the Company/Client, choose the Reveal InControl Standard Template, and UTC for Time Zone.
5. Click Create Case
   1. 

Rapid Pilot (RP) Enron User Setup

After creating the project, there are a few things that must be done prior to importing the data.

Create Review Account and Add to Rapid Pilot Project

Create a Review account for yourself and make your user a Company Admin as detailed below.

Open Review Manager on the Load Machine

1. Expand Project Setup
2. Click Users
3. Click Add
4. Click Create New, fill in the Create a new User ID form, and click Create
   1. 
5. Choose the Review Account, and click Add
   1. 
6. Change Group to Administrators
   1. 

Company Admin Rights

A user must have Company Admin rights to create users or a project within Review. To make a user a Company Admin follow the steps below.

1. Open Review Manager on the Load Machine
2. Expand Instance Setup, and select Companies

3. Ensure the Company created associated with Rapid Pilot is the one selected

4. Click the Users By Company tab
5. Click Add User, and choose your user
6. After adding the user select the checkbox Is Admin.
   1. 

Checking for Company Admin Rights in Review

If a user does not have access to the Load Machine, but wants to check for Company Admin rights, the user can check within Review.

1. Log into Review
   1. You can get the URL to Review to any environment in Review Manager by expanding Advanced Options, click System Settings, and in the Value column type 'indexserverserviceclient'. When copying this URL result, exclude '/review_indexserver' from the result.
2. Click Admin
   1. 
3. Click the Menu button in the upper left-hand corner and look for Company Admin.
   1. 

Initiate Smoke Tests

There will be a total of 3 smoke tests. The first two smoke tests use the data within the folder SmokeTestData, and we will compare the results to make sure they match. The final smoke test of the Review Manager uses the Rapid Pilot data set. This test is more involved, as this will be a project we use for the clients when it comes to administering demos, training, etc. during the Pilot.

Smoke Tests High Level Overview

Uploader Smoke Test

We will upload the data within the folder SmokeTestData into a new project created in Review. To accomplish, follow the steps below.

Create Project in Review

1. On the Load Machine, login to Review
2. Choose Menu -> Company Admin
3. Click
4. Enter the Project Name (use ‘RP_’ as the prefix, the client's MSA_ST_Uploader as the project name, i.e. RP_135176_ST_Uploader), enter a Project ID (typically a number, recommended to use date created in YYYYMMDD format)
   1. You will always choose Reveal as the client and company, but the MSA in the case you create will be different. The MSA provided in this document of 135176 is there for instructional purposes. 
5. Choose the Review Account and assign to the Admin Group
6. Click Save 
   1. 

Upload Data

1. After creating the project, switch to the project in the drop down.
   1. 
2. Click Menu -> Upload Data and upload the two zip files in the folder Z:\SmokeTestData separately, and use the zip file name as the custodian name.
   
   1. 
   2. 

Monitor Progress

1. To monitor the process, go to Menu -> Jobs -> Upload. The job will be complete when the jobs have green check marks. Make sure the counts in your project match the counts in the screen shot below. 
   1. 
2. After the upload completes go to Menu -> Jobs -> Index, select View All Jobs, and you will see the indexing process of the upload. Make sure the counts in your project match the counts in the screen shot below. 
   1. 
3. After the index completes go to Menu -> Jobs -> AI Document Sync, select View All Jobs, and you will see the indexing process of the upload. Make sure the counts in your project match the counts in the screen shot below. 
4. Run the term depart* to make sure 34 documents are returned.
   1. 

Discovery Manager Smoke Test

We will upload the data within the folder SmokeTestData into a new project created in Discovery Manager. To accomplish this, follow the steps below.

Add Review Credentials in Discovery Manager

1. On the Load Machine, open the Discovery Manager
2. If the following pop up is shown, please enter in the Review Account username and password. If the pop up does not appear, open Review Account in Discovery Manager and enter in your credentials. 
   1. 

Associate Reveal Client in Discovery Manager

1. On the Load Machine, open the Discovery Manager
2. Click the button Edit/Delete Clients in the Home Ribbon
3. Select the client Reveal if not selected and click the Edit Selected Client button.
4. Click Change Review Client Association and choose Reveal from the Select Review Client drop down.

Create Project in Discovery Manager

1. Click the New Project button
2. Leave the default template of -Default Settings-
3. Choose the Client Reveal from the drop down. If the client does not exist, create the client by clicking the Create Client button.
4. Enter the Project Name (use ‘RP_’ as the prefix, the client's MSA_ST_Discovery Manager as the project name, i.e. RP_135176_ST_Discovery Manager)
5. Click Associate with Review Case
6. Select Create New Case, enter a Project ID (typically a number, recommended to use date created in YYYYMMDD format), choose the Company Reveal, choose the Database Template Reveal InControl Standard, the checkbox for Artificial Intelligence, and click Next > and choose all the settings below.
7. Do not click Finish, click Next. Only change the settings with a red box around them. All other settings, or missing wizard pages can be ignored and left to their default settings. 
    
   1. 
   2. 
   3. 
   4. 
   5. 
   6. 
   7. 

 Import Data

1. After creating the project, go into the Imports Module
2. Click the S3 Bucket Browser button
3. Choose the SmokeTestData folder, and click OK
   1. 
4. Click the Import Selection button in the Imports Ribbon

Monitor Progress

1. To monitor the process, go into the Environments Module and click the Refresh button in the Environments Ribbon. When the job completes it will from In Progress to Success
   1. 
   2. 

Export Data

1. Go into the Export Module, and set the following Export Settings
   1. 

1. Set the following Review Options, and click Run Export
   1. 

Monitor Progress

1. To monitor the process, go into the Environments Module and click the Refresh button in the Environments Ribbon. When the job completes it will from In Progress to Success
   1. 
   2. 
2. After the upload completes go to Menu -> Jobs -> Index, select View All Jobs, and you will see the indexing process of the upload. Make sure the counts in your project match the counts in the screen shot below except for Total Errors. Please note that the Brainspace connector overlay is one of the last steps and will not show until everything is complete. 
   
   1. 
3. Run the term depart* to make sure 34 documents are returned.
   1. 
4. Make sure the data loaded properly into AI by going to Menu -> Jobs -> AI Document Sync. If this shows complete
   1. 
5. Everything will be complete when the Candy Bar displays counts on the Dashboard, and that the index Brainspace connector overlay completed as well. 
   1. 
   2. 

Rapid Pilot Creation

The Rapid Pilot project was created in the Review Manager during the Project Setup. We will import data into the project. This requires importing the DAT file into the system and creating indexes. To do this, follow the steps below. 

Import Data

We will import data into the project. This requires importing the DAT file into the system and creating indexes. To do this, follow the steps below. Please note the project in the screen shot is for illustration purposes only, and you should be choosing your project you created.

Import Mappings

A new field mapping will also need to be created to load the data.

1. Open Review Manager on the Load Machine, Expand Project Setup and Click Import Mappings

2. Browse to the following DAT file

   1. Z:\20240303_RapidPilot\20240303_RapidPilot_loadfile.dat

3. Click Match All Fields.  

4. Sort by the field Table Name, click in one of the fields that say -- Select -- and find/remap only the fields that show here as they did not map properly (there will not be that many). The fields that appear under the drop-down are the fields to find under table name. Remap each of these fields.  When this is complete, there will be no more fields remaining in the drop down. 

   1. APPTBEGDATE

   2. APPTENDDATE

   3. DATE_OTHER

   4. FILESIZE

   5. LAST_ACCESS_DATE

   6. MASTERDATE

   7. SENT_DATE

   8. TIME_OTHER

5. After mapping the unmapped fields, save this mapping as the Rapid Pilot Mapping

   1. Continue without mapping Conversation_ID if warning comes up. Please note that all fields will not map. You will only map the fields that show via step 6 above.

Documents Import

To import the DAT file, follow the steps below.

1. Open Review Manager on the Load Machine
2. Expand Import
3. Click Documents
4. Choose the Rapid Pilot project
5. Choose the Rapid Pilot Mapping
6. Import 1
   1. Import Data File: Z:\!Smoke Tests\_RapidPilot\PilotDataProcessingFolder\Exports\0001_EXPORT01\_textfiles.dat
   2. Click Import Data
   3. This will load 40,656 files.
      1. 
      2. 
      3. 
         1. You can ignore this error and click OK.
7. Import 2
   1. Repeat the same steps from Import 1
   2. Use Import Data File: Z:\!Smoke Tests\_RapidPilot\PilotDataProcessingFolder\Exports\0002_EXPORT02\EXPORT02_loadfile.dat
   3. This will load 86 files.

Documents Overlay

There are a few fields that were not properly in this data that are essential for Brainspace. To get these fields populated, we will need to do an overlay or Update Data for the project in Review Manager. To overlay these fields, follow the steps below.

1. Open Review Manager on the Load Machine
2. Expand Import
3. Click Documents
4. Choose the Rapid Pilot project
5. Choose Update Data
6. Choose CSV
7. Overlay
   1. Import Data File: Z:\!Smoke Tests\_RapidPilot\PilotDataProcessingFolder\Exports\0003_BRS_OVERLAY\BRS_OVERLAY.CSV
      1. Please note that this is a CSV file and not a DAT file.
   2. Click Update Data
   3. Click Match All
   4. We are only overlaying 3 fields. You will need to find the following two fields and deselect them from the overlay, as Match All will return 5 fields. .
      1. Find the field SENT_DATE and deselect it (remove the checkbox from Import for the row) as we should be overlaying the field SENT_DATETIME and not SENT_DATE
      2. Find the field SUBJECT and deselect it (remove the checkbox from Import for the row) as we should be overlaying the field SUBJECT_OTHER and not SUBJECT
   5. Click OK
   6. This will update all files (40,742)
      1. 

Create Indexes

After importing the data, you need to index the data. Please only do this after Store Pending = 0 as seen below. As part of this process, we grab the native and text files from the load file, and move them to S3 in AWS, or the “store”.

Please note the project in the screen shot is for illustration purposes only, and you should be choosing your project you created.

1. Open Review Manager on the Load Machine, Expand Create, Click Indexes

1. Choose the Rapid Pilot project

2. Select the index

3. Click Index/Re-Index

4. Click Native/Html, Extracted, OCR / Loaded, Document_Metadata, and click OK (Approximately ~1 hour for all indexes to complete)

1. 1. 

Create Document Folders

After kicking off indexing, run the following process in the Create section of Review Manager.

1. Document Folders
   1. Choose the Rapid Pilot project
   2. Select both data sets
   3. Change Document Folder Field to RELATIVEPATHPARENT
   4. Click Run
      1. 

Monitor Progress

1. You can monitor the indexing progress in the Review Manager, or you can go to Menu -> Jobs -> Index, select View All Jobs, and you will see the indexing process of the import. Make sure the counts in your project match the counts in the screen shot below except for Total Errors.
   
   1. 
2. Run the term depart* to make sure 5,260 documents are returned.
   1. 
3. Make sure the data loaded properly into AI by going to Menu -> Jobs -> AI Document Sync. If this shows complete
   1. 
4. Everything will be complete when the Candy Bar displays counts on the Dashboard, and that the index Brainspace connector overlay completed as well.  
   1. 
   2. 

Run Final Processes – Review Accelerators

There are 3 processes we must execute to complete the Review Accelerators (i.e., Image Label, Translation, and Transcription). Please note the project in the screen shots is for illustration purposes only, and you should be running these processes in the project you created. When the Label, Translation, and Transcription jobs complete, you will receive an email for each job.

Key Documents

For demo purposes, the following documents highlight key differentiators in Reveal. To get to these quickly, it is recommended to add these to a Work Folder.  

1. Login to your project via your browser in Review

Next to Work Folders on top left, Click the ellipsis

1. Click Add Folder -> Name Folder "Key Docs" -> Click to Grid View

2. Click into Search Toolbar at top right, Click the ellipsis

3. Click +Add -> Type Begin Number -> Click Begin Number metadata field

4. Copy and paste the following Begin Numbers into the pop out window: 

   1. RP-00003880
      RP-00007310
      RP-00007374
      RP-00007396
      RP-00007410
      RP-00007448

5. Click Add to Search -> Click Search -> Results should look like documents below:

6. Click Update -> Action to Take -> Check Folders -> Click dropdown to Work Folders -> Check off Key Docs -> Click Submit -> Confirm

The work folder and documents selected can be selected based on preference for demo purposes - just a suggested set of documents to highlight Review Enhancers within the Reveal Platform.

Label

Run Image Label on the following images for demo purposes.

1. Login to your project via your browser in Review
2. Select the Documents Folder Documents -> Dropbox -> Group Share -> Images, and this should return 49 files
3. Click the Label button
4. Click LABEL
5. You can monitor the progress of this job in the Jobs section (click Menu and choose Jobs). When the job is complete there will be a green check mark.
   1. 

Translate

There are two sets of documents for translation purposes of Japanese and Korean. Below illustrates how to translate the Japanese files. The process should be repeated for the Korean files as well.

1. Login to your project via your browser in Review.
2. Select the Documents Folder Documents -> Dropbox -> Group Share -> Foreign Languages -> Japanese, and this should return 30 files
3. Click the Translate button
4. Next to Destination Text Set click the + Create new button, enter the following items, and click Submit.
   1. 
5. Back on the Translate Documents settings, choose the following options.
   1. 
   2. If the Destination Text Set that was just created does not show up in the list of text sets to choose from, logout/login, and the text set will be available. 
6. Repeat this process for the Korean files (Documents Folder Documents -> Dropbox -> Group Share -> Foreign Languages -> Korean), but translate from Korean to English. Please add the Korean files to the same Text Set of Translation, and do not create a new Text Set.
7. You can monitor the progress of this job in the Jobs section (click Menu and choose Jobs). When the job is complete there will be a green check mark.

Transcribe

There is 1 deposition video to transcribe.

1. Login to your project via your browser in Review.
2. Select the Documents Folder Documents -> Dropbox -> Group Share -> Videos, and this should return 1 file
3. Click the Transcribe, and click TRANSCRIBE (leaving all default settings)
   1. 
4. You can monitor the progress of this job in the Jobs section (click Menu and choose Jobs). When the job is complete there will be a green check mark.

Show Transcription

After the deposition video completes, turn on the transcription to show it during a demo.

1. Login to your project via your browser in Review.
2. Select the Documents Folder Documents -> Dropbox -> Group Share -> Videos, and this should return 1 file
3. You can monitor the progress of this job in the Jobs section (click Menu and choose Jobs). When the job is complete there will be a green check mark.
4. Launch this file in Review by clicking on the row.
5. Click the CC Show Transcript button , and this will show the text next to the video when it is played. This setting will stick for all future demos of this file.

 

Enable AI - Add AI Model

Apply an AI Model from the Model Library for demo purposes. 

1. Login to your project via your browser in Review

2. Click into Project Admin -> Tags

3. Click Add Tags and Choices 

4. Enter and select the following information for the tag:

    

5. Return to your main Project screen -> Click Supervised Learning

6. Click the gear icon by the AI Tag created (Junk)

7. Scroll through the AI Library Models and add the "Out of Office" AI Model

8. Click Run Full Process -> Click Save (at bottom)

9. Click the Review Icon on left panel, return to dashboard. 

The project's documents will now be scored with this AI model as part of the current Classifier which will take some time to run the process before it displays on the dashboard.

You can replicate these steps to create another AI Model for demo purposes or even  combine two similar models from the library to "pack and stack" into one uber AI Model to further leverage the AI Model Library.

For more information on applying or leveraging AI Models, please see or help documentation or blog posts. 

 

Enable AI - AI Responsiveness Mutually Exclusive Tag

Update the existing Responsiveness tag to enable an AI model for the tag.

1. Login to your project via your browser in Review

2. Click into Project Admin -> Tags

3. Click edit (pencil icon) next to Responsiveness, and enable AI

4. Select "Edit Access" next to Prediction AI Access and select Original Administrators to have access to view AI Prediction Scores 

Enable AI - AI Issues Multi-Select Tag

Create a new multi-select tag named Issues, and enable an AI model for each choice within the tag.

1. Click Add Tags and Choices 

2. Label Tag Choice "Issues"

3. Chose Multi-Select Tag 

4. Add the following issues separately: Chewco; Jedi; Raptor

5. Select Prediction Enabled for each tag

6. Select "Edit Access" next to Prediction AI Access and select Original Administrators to have access to view AI Prediction Scores

Enable AI - Finalize Tag Profile

1. Move the issues over to the Standard First Level Review Tag Profile that contains solely those tags or other tags relevant to typical workflow 

2. Click the Settings button, and make sure the Original Administrators have access to the Field Profile.

Enable AI - Populate Scores for AI Tags 

To get scores generated in the AI Tags, conduct the searches below, and bulk tag the results.

1. Login to your project via your browser in Review

2. Click into Grid View

3. In the top search toolbar enter in search for keyword Chewco

4. Click Update from Mass Action Toolbar

5. Click Action to Take ->  Select "Include Tags" -> Select Responsive -> Select Chewco -> Click Submit -> Click Confirm in pop up window

6. The AI Tagging needs both positive and negative examples to populate AI Scores accurately. To tag the negative documents follow the steps below.

7. In the top search bar, search for the word Chewco -> Add families from the tree expander -> search for Chewco again -> Change the boolean operator from OR to AND -> change boolean operator IS to IS NOT -> Click Search

8. With the populated results, use the Mass Actions Toolbar again. 

9. Click Action to Take ->  Select "Include Tags" -> Select Non-Responsive -> Click Submit -> Click Confirm in pop up window

10. Repeat these same actions for the issues tags LJM, JEDI, and RAPTOR (e.g. search for LJM instead, mass tag all docs from search result with respective tag) 

If a window appears suggesting the action may take a while, monitor in Jobs; however bulk tagging will process fairly quickly. 

AI Scores from these mass tagging actions will update after several minutes after all Issues are mass tagged and synced with AI tagging engine. 

When this completes (takes roughly 5 - 15 minutes), 5 new models will populate on the Dashboard in the widget Documents by Predictive Scores with the results.

Field Profile

By default, field profiles are not assigned to roles out of the box. This makes the Default Field Profile inaccessible for all users. To fix this, follow the below steps, and you can use the Default field profile. 

1. Login to your project via your browser in Review

2. Select Admin 

3. Click Fields -> select Default -> click Edit

4. Select Original Administrators -> choose Fields -> click UPDATE