Reveal Help Center

3. System Settings

System Settings are core setup and administration tasks and functions for the entire Reveal AI instance. See the following pages for details on each Storybook Administration item.

Updated service worker status and configuration information, broken out to Service Worker Status ListStorybook Service Worker Status and Restricted Worker.

The Environment setup page allows you to accomplish any of these optional tasks:

  1. Third Party System Administrator Access (for entering Reveal AI from Relativity as an admin).

  2. NexBERT Setup - Configure your Reveal AI environment for the use of NexBERT models.

  3. Set up a Cache Password.

  4. Trusted URLs (for your Relativity site).

  5. Keycloak Access Setup.

To access environment statistics and generate reports for your team or for Reveal Support.

D.  Tenants

A system admin can create new tenants from this page.

View system errors and associated details.


A. Service workers

Under the admin mode, there are three tabs under the SERVICE WORKERS tab: Service Worker Status List, Storybook Service Worker Status and Restricted Worker. 

The statuses mean the following:

  • RUNNING: Displays when worker is running.

  • CHECK_IN_WARNING: Displays if worker misses 3 check-ins. Check-ins occur every 30 seconds, to see if service is writing to the database.

  • CHECK_IN_ERROR: Displays if worker misses 10 check-ins.

  • STOPPED: Displays when worker has been stopped by the user.

1. Service Worker Status List

This tab will display information about your AI service from a service perspective. It will show the IP address or server name of where that service is located along with how many storybooks have access to that service. A status will also be displayed on the right-hand column letting you know if the service is currently running. 

If you have multiple versions of the NexLP AI Service on your machine and would like to clean up the list, you can click the Delete Stopped button to remove the stopped services from the list. Please note that clicking the delete button will not change any configuration to the actual AI Service. 

Keep in mind that only one job using a given service type can run per storybook at a time. Note that for processing service, there are three distinct jobs that utilize the same service type: 1.) Entity search and extract, 2.) NER only, and 3.) Processing. Therefore, you can only run one of these processing jobs at a given time on a given storybook.

2. Storybook Service Worker Status

This tab provides visibility into the status of the AI Service at the storybook level. You will be able to track individually which AI Service is being used on each storybook.

3. Restricted Workers

This tab will display the name of which storybook has been restricted to which part of the AI service.


Admin can now assign one or multiple Story Books to a single AI service. This is especially useful when you have large cases that co-exist with many small cases and want to set up a dedicated AI service for the large case(s). 

For example, if you have a large case (Storybook a) that co-exists with other small cases, the admin user can designate AI server A to Storybook a and have AI server B handle the rest of the storybooks.


To configure AI service designation, follow the steps below:

  1. Log on to your Reveal AI server.

  2. In 04.Service folder

    • Navigate to the ServiceLocal folder and

    • Edit the configService.xml Example Filepath: C:\NexLP\\04.Service\service\ServiceLocal\NexlpServiceAi_2.00.00.22

  3. In the XML file notice towards the end of each process there is a <restrictedStorybookIds> tag. For each process you would like to have restricted to a storybook, enter the id of the storybook between the tags.

    • Example: <storybookId>123456789</storybookId>



      If you are trying to restrict multiple storybooks you will need multiple storybookId tags within the <restrictedStorybookIds> tags. For example,

    • <storybookId>123456789</storybookId>

    • <storybookId>987654321</storybookId>


      If you leave the <restrictedStorybookIds> empty, the service is then not restricted and can work with any storybooks, except the one(s) that have designated AI services.

  4. For this to take effect you will need to Stop and Start the AI service.

After making the changes on the XML and restarting the service, in the front-end the Service Worker Status List tab will now be updated to reflect the current restricted storybook(s). For example, the AI service would not be allowed to access 23 of the 24 storybooks since we restricted the service to just the one storybook above.

B. Environment setup

The Environment setup page allows you to accomplish any of these optional tasks:

  1. Third Party System Administrator Access (for entering Reveal AI from Relativity as an admin).

  2. NexBERT Setup - Configure your Reveal AI environment for the use of NexBERT models.

  3. Set up a Cache Password.

  4. Trusted URLs (for your Relativity site).

  5. Keycloak Access Setup.

1. Third Party System Administrator Access

You may use this section to allow users in the provided Relativity group to sign into Reveal AI from Relativity with a System Administrator account. To set up Third Party System Administrator Access perform the following:

  1. Enter Reveal AI as an admin directly (not by way of Relativity).

  2. Go to SYSTEM > Environment setup > Third Party System Administrator Access:

  3. Check the checkbox for Relativity access enabled.

  4. Designate a Relativity Group Name that indicates System Admin status such as Reveal AI Sys admin.

  5. Hit Save.

  6. Enter Relativity.

  7. Create the identical Relativity Group Name in Relativity.

  8. Add those Relativity users whom you want to enjoy admin status in Reveal AI (including yourself) to this group.

  9. Sign into a storybook from Relativity.

  10. Your Reveal AI system admin status verifies success.

2. NexBERT setup

NexBERT setup is only required if you are to use NexBERT models. Click on the pen icon next to the title of this Environment Setup section to edit. Depending on environment location, choose either Azure or On premise.

  • Configuring for Azure

If you choose Azure the fields below require population:


You must enter your Azure environment to acquire this information. This involves a series of steps.

First, enter your Azure environment. Go to Azure Active directory:


Choose App registrations and the following page appears:


Choose + New registration and the following page appears:


Enter the name of the new application (in this case: “demo-bert”) and hit Register. This will provide you the Client ID (Application {client} ID in Azure) and the Tenant ID (Directory {tenant} ID in Azure) for the Reveal AI NexBERT setup form.


Now choose Certificates and secrets...


...and choose +New client secret. Fill out the “Description” and choose Add

You now see the new value for the Client secret.


Copy this value and paste into the NexBERT setup form NOW because you lose access to the client secret value when you leave this page.


To create a workspace go to AI + Machine Learning and then choose Machine Learning.


And you go to the Machine Learning page:


...where you provide:

  • Workspace Name: Create a “Workspace name” and enter it as Workspace in the Reveal AI NexBERT setup form.

  • Resource Group: Choose the “Resource group” from the dropdown or create a new one and enter it as Resource group in the Reveal AI NexBERT setup form.

  • Location: Your workspace should be in the same location as your data storage. Choose the “Location” from the dropdown and enter it as Region in the Reveal AI NexBERT setup form.

And then choose Review and Create

The Machine Learning form appears for your review:


The “Subscription Id” is presented and should be entered as Subscription ID in the Reveal AI NexBERT setup form. 

Choose Create. Creation will take a few minutes. You will see this when your workspace is created:


Now to give the application access to the workspace you return to the Azure Home page and choose Azure Access Directory.


Go to All resources in the left panel of Azure services.



  1. choose the workspace,

  2. choose “Access control (IAM)”,

  3. add “Role assignments”,

  4. choose “Contributor” as the “Role”, then

  5. choose the app we just created “demo-bert”, and then

  6. choose Save.

Next go to the Machine Learning Studio:


Choose Compute.


First choose Compute Cluster then + New.  The New compute cluster window appears.


The following items are needed:

  • Computer name: This must always be “default-cluster”.

  • Virtual machine type: Switch this to “GPU (Graphics Processing Unit)”.

  • Virtual Machine Size: Enter from dropdown Standard_NC6.

  • Minimum number of nodes: This must be 0 (that is zero).

  • Maximum number of nodes: This must be 6 (that is six).

  • Idle seconds before scale down: Populated automatically.

The resulting page may look like this:


Next, go to your workspace:


And choose Launch now to go to the Machine Learning studio.


Choose Datastores and the Datastores page appears.


Choose + New datastores and the New datastore form appears:


Choose Storage account and Blob container names from drop-down lists.

Now return to the All resources page:


And choose the workspace you have created.


Then choose Access keys under “Settings”; copy the “Key” under “key1”

Now return to the Datastore page and paste the key copy into the Account key box:


You now have the following input to copy from Azure and paste into the NexBERT setup form:

From Azure

Into the NexBERT setup form

“Datastore name”

“Datastore name”

“Storage account”

“Storage account name”

“Blob container”

“Container name”

“Account key”

“Storage account key”

The final item for the NexBERT setup form is the “Experiment name”. This requires command level input.

First go to the Azure services page and choose the cloud shell.


As shown above, login to azure shell and then switch to bash  

az login

Paste the code in the url that shows  

az extension add -n azure-cli-ml

Now you can run command to create a new experiment:  


Return to the Azure Machine Learning studio:


Choose Experiments.

The Experiments page will appear with the name of the newly created experiment.


The name of the experiment is copied and pasted into the “Experiment name” box of the NexBERT setup form. This concludes the process of filling out the NexBERT setup form.

To summarize:

From Azure

Into the NexBERT setup form

Application (client) ID

Client ID

Client secrets Value

Client secret



Subscription Id

Subscription ID

Directory (tenant) ID

Tenant ID

Workspace Name


Resource Group

Resource group


Experiment name

Datastore name

Datastore name

Storage account

Storage account name

Account key

Storage account key

Blob container

Container name

The NexBERT setup section of your Environment setup page now looks something like this:

  • Configuring for “On premise”

If your NexBERT setup will be in your own environment, you choose On premise and the fields below require population:


And enter the following required information:

  • Remote machine name*: Name the designated hardware.

  • Username*: Enter your username required to access the environment.

  • Password*: Enter the required password.

  • VM processing unit*: Choose either CPU or GPU.

  • Storage Path*: Provide the storage path for the environment.

Then choose Save.

For further information see Reveal AI Installation Guide.

3. Cache password

On the Environment setup page underneath NexBERT setup is the Cache Password setup section.

Enter the new password twice and choose Save. When the password is accepted, the page now shows The cache is ok. Password is set.


For more information, please refer to the Reveal AI Installation Guide, Section 13. Enhanced Caching Server Service Security.

4. Trusted URLs

You may use this section to provide an additional layer of security for your Relativity connection by adding your Relativity URLs.

Use the Actions tools to edit or remove.

5. Keycloak Access Setup

Keycloak supports fine-grained authorization policies and is able to combine different access control mechanisms such as OAuth. Keycloak can be configured and tested in the Keycloak access setup section of Environment setup.

C. Environment statistics

To access environment statistics for your team or for Reveal Support, go to Systems Settings and choose Environment Statistics:


To create a report use the calendars to designate beginning and end date then choose the download icon 60423449d91d5.png to generate a .json file.

D. Tenants

A system admin can create new tenants from this page. On the System administration page, choose Tenants under SYSTEM:


To create a new tenant chose Create tenant and the following window appears:


You will enter the name and domain. This information will have to have been pre-configured in this domain for these entries to work.


Choose Save.


Once the tenant is thus created, this will now allow the tenant to log in:


The system admin can now start to configure the tenancy of the new tenant by actions in the TENANT section of the directory on the left.


You may begin by choosing Server connections

Now use the dropdown from the tenant switcher located in the upper righthand corner to find and then choose the newly created tenant.


The page now shows information for the new tenant. You choose the appropriate connection icon such as SQL server.


And the Add SQL Server Connection page appears:


Enter the appropriate information:


Choose Test Connection and assuming confirmation choose Save

The connection is established:


For further details on setting up this and other Server connections, see Section 2F - Server connections

Having set up the tenant connection you may now want to set up a storybook. Choose All storybooks and then Add storybook:


And the Add storybook page appears...


...which requires the following:

  • Storybook name: Choose a name for the storybook.

  • Storybook database name: This name is autopopulated according to the chosen storybook name.: This name is autopopulated according to the chosen storybook name.

  • Tenant: Select the new tenant from the dropdown list.


    Once a tenant is chosen for this storybook, it can never be changed. This is a component of the security architecture that protects tenants’ data.

  • Storybook database server: Select from the the dropdown list of servers connected to the tenant.

  • Insights: Indicate whether Insights is enabled.


Then choose Save.


You may now want to create a user for this tenant. Continuing in the context of your new tenant (in this case Reveal Docs) you now choose Users and then Create User.


And the Create User window appears:


Place the relevant information:


And the new user appears on the list:


You may now add the user to a group. Choose Groups then Create group.


The Create Group window will appear:


The following information is required:

  • Tenant: This is automatically provided.

  • Name: You choose a group name.

  • Role: Choose either Tenant or Storybook administration. If you choose Tenant administration you inherit all Storybook administration rights.

  • Permissions: Choose any of these permissions. If you have chosen Tenant administration you will inherit “Allow Configuration of Insights Notifications”.


Then choose Save and the following addition to the list appears:


To add a user to the group, choose the group name from the list.


And the group-specific window appears (in this example Groups >> Alpha Tenant Admin):


Choose the Add user button and the Add Users to Group window appears. Only the existing storybook users appear in the dropdown.


Make your choice and the user appears in the group-specific list:


The group-specific list scrolls through three sections - UsersCOSMIC modelsStorybooks:


In the COSMIC models section of the group-specific list, choose Add model.


The Add models to group window will appear. Select models from the dropdown list.


Chosen model names will stack and can be individually or collectively removed.


The models now appear in the COSMIC models list:


See Section 2B - Tenant Settings > Groups for further details.

In the Storybooks section of the group-specific list...


Choose Add storybook. Only the storybooks connected to the designated tenant will appear in the dropdown list.


Choose your storybook and it appears in the list:

E. System errors

View system errors and associated details as shown below:


Further details on each Error are available by clicking the more link at the end of each entry in the Error column.