Reveal Help Center

2. Tenant Settings

Reveal AI uses multi-tenancy architecture. This provides broad administrative functions to distinct tenants sharing the same instance of Reveal AI. Configuration of groups, users, queues and server connections as well as use of the model library and tenant setup may all be accomplished at the tenant level by either tenant admins or system admins. 

System Administrators have an unrestricted view of Reveal AI information for all tenants. System admin view of the tenant settings includes a “tenant switcher” that appears in the upper righthand corner of all tenant settings pages.  

The Tenant Switcher:

6042337a1d46c.png

It is highlighted in the image under Dashboard below and includes a dropdown menu that gives the system admin the option to view information for all the tenants or work in the context of individual tenants. When a system admin is working in the context of an individual tenant, her experience is equivalent to that of a tenant admin.  

Tenant admins, on the other hand, are restricted to the contents of their tenancy. Their pages do not show the “tenant switcher”.  

See the following pages for details on each Tenant Administration item.

Managing and viewing Tenant operations and processes.

B.  Groups

Defining and managing security and access control groups for Tenant storybooks.

C.  Users

Defining and managing individual user access and assignment to groups.

D.  Queues

Monitoring service queues and status.

Defining and applying custom and library models.

Defining SQL, SMTP, Exchange/Office 365, Relativity and other connections for the Tenant's storybooks.

Configuring Tenant single sign-on (SSO) authentication.

===================================================================================================

A. Dashboard

The Tenant dashboard gives a snapshot of running, stopped, errored, and completed tasks and their details across all storybooks.

6042337be349d.png

Filter by type, status, and person initiating the task to find relevant information.

Types:

60638ca1e2e30.png

If you want to filter by a subset of types, choose them:

60638ca3b82bd.png

Similarly for Status, Created by... and Tenant Storybook...

Status:

60638ca58a12e.png

Created by…

60638ca74dd1e.png

Storybook...

60638ca937dab.png
B. Groups

Choose Groups under Tenant Settings to create, edit or delete groups.

6042338524661.png

In order to create a group, a System Administrator would first choose the tenant from the “tenant switcher” dropdown list; a Tenant Administrator skips on to the next step:

604233874bc3e.png

Then choose Create Group and…

604233896898f.png

…the Create Group window will appear:

10_1_Create_Group__blank_.png

The following information is required:

  • Tenant: This is automatically provided.

  • Name: 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”.

    60638caf9623c.png

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

6042338ee2c92.png

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

60423390ad630.png

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

60423392ace7c.png

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

6042339420461.png

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

60423395cc9cd.png

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

60423397ace80.png
6042339974e90.png
6042339b26f57.png

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

6042339ccbe57.png

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

6042339e6efc4.png

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

60638cbadf565.png

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

604233a1c5c22.png

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

604233a378e7f.png

Choose your storybook and it appears in the list:

604233a545907.png
C. Users

The Users page allows system and tenant admins to view, create, update and delete users. You may add users to a group. System Administrators can see what tenant the user belongs to and can use the “tenant switcher” to filter down to the specific tenant. 

Choose Users under TENANT in the directory on the left:

604233a7a3d86.png

System Administrators can verify they are looking at the correct tenant. The tenant switcher is sticky between one tenant settings section and another.

To create a new user choose Create user...

604233a9b4193.png

...and the Create User window appears:

604233ab87e60.png

Place the relevant information:

  • Tenant: The tenant to which the user belongs.

  • Email: Enter email address.

  • First Name: Enter user’s first name.

  • Last Name: Enter user’s last name.

  • New Password: The minimum requirements for password are:

    • One uppercase letter

    • One lowercase letter

    • One number

    • One symbol

    • Minimum of 8 characters.

  • Confirm Password: Re-enter the same password.

  • Locked: Check to temporarily disable user from being able to log into the system.

  • Enable Advanced Thread Navigation: If this option is unchecked, user will not be able to automatically save COSMIC tags in the thread viewer.

    604233ad3975c.png

Then choose Save to save the new user.

The new user appears on the list:

604233aed906a.png

To add the user to a group or groups, click on the user email.

604233b08d59a.png

The user-specific Group page appears that allows you to add the user to any number of groups. Choose Add group:

604233b26bad5.png

The Add groups to user page appears. Choose the target groups from the dropdown menu.

604233b43225d.png

The new group now appears on the user-specific Group list.

604233b5da3ea.png
D. Queues

Choose Queues under TENANT for queue information. View the order in which jobs are queued up and their status and other details. The highlighted dropdown allows you to choose reports for the following:

  • COSMIC,

  • Clustering,

  • Vector,

  • Model Publish,

  • Model,

  • Extraction and

  • Processing.

604233b7b9c19.png
E. Model library

The Model library is where a system admin or tenant admin can go to import and manage COSMIC models and Entity models. Once you have these models installed to your local server (see the Reveal AI Installation Guide) you may import them into your Reveal AI tenancy. They are then available for use in storybooks as directed.

COSMIC model library

Choose Model library under TENANT Settings and the COSMIC model library appears by default. Here in card catalogue format are all the COSMIC models that have been imported into your Reveal AI.

60638cc94bc3b.png

There are seven buttons and filters near the top:

60638ccae7e3f.png
  • Model Marketplace: Open the complete list of Reveal AI models, available for you to request.

  • Find: Enter search text which will query COSMIC model title.

  • Published by: Name of admin who published this model.

  • Order by: Either oldest to newest or newest to oldest.

  • COSMIC model/Entity model switch: Choose either COSMIC model library or Entity model library.

  • Import: Use this to bring new models available in your environment into your Reveal AI.

  • Reset Filters: Clear the filters and view the entire library catalogue.

The Model Marketplace

Choose Model Marketplace...

60638cccc19e3.png

...and the Model Marketplace appears:

604233bf56ced.png

If you want a certain model, choose its Request Model button, and the Model Request Form appears:

604233c14c4c2.png

Fill out the form and choose Submit. Our support staff will then respond and provide the requested models. Note that the models available in the Model Marketplace include both COSMIC and entity models.

Functionality of each model listing

The individual model listing has an ellipsis next to each model title. When you choose the ellipsis a dropdown list appears:

604233c3101a8.png

The dropdown list includes:

  • Configure: Choose Configure and the following pop-up appears:

    604233c4bf4cd.png

The Configure COSMIC model pop-up includes:

  • Title: You may edit title.

  • Description: Edit model description.

  • Tenants: You may use the dropdown to choose which tenants have access to this COSMIC model.

  • Export: Choose this to export model. See Notification center for status.

    604233c6b85b1.png

If the chosen model was packaged prior to SE 2.80, the above warning will appear. In order to take advantage of the most advanced security protection, you should go to the storybook from which the model was derived, verify that its environment is upgraded to 2.80 or later, and repackage the model. You may then use Export Mode to export the model.

  • Delete: Press to delete the model. A pop-up appears to confirm deletion.

    604233c8a7e5f.png

Import

To import a new COSMIC model, choose the Import button...

60638cd435c4e.png

and use the pop-up to find the file.

60638cd5a9655.png

The Select File button allows you to browse your environment for the model. The Tenants dropdown menu allows you to choose multiple tenants. Or you may choose “Select all tenants”.

Hit the Import button and the model will be sent to the library. See Notification center for status.

See User Guide Section 9 > E. COSMIC model library for more details on how to publish COSMIC reference models from existing storybooks and apply Reveal AI pre-trained starter COSMIC Models.

Entity model library

To toggle from the COSMIC model library to the Entity model library choose the dropdown arrow next to COSMIC model library and choose Entity model library. Here in card catalogue format are all the entity models which have been published.

60638cd78565b.png

There are seven buttons and filters near the top:

60638cd9a3724.png
  • Model Marketplace: Open the complete list of Reveal AI models, available for you to request.

  • Find: Enter search text which will query COSMIC model title.

  • Published by: Name of admin who published this model.

  • Order by: Either oldest to newest or newest to oldest.

  • COSMIC model/Entity model switch: Choose either COSMIC model library or Entity model library.

  • Import: Use this to bring new models available in your environment into your Reveal AI.

  • Reset Filters: Clear the filters and view the entire library catalogue.

Next to each model title is an ellipsis. When you choose the ellipsis a dropdown list appears:

604233d0c09da.png

The dropdown list includes:

  • Configure: Choose Configure and the following pop-up appears:

    604233d26fbf5.png

The Configure model pop-up includes:

  • Title: You may edit title.

  • Visible Entities: Check to make entities visible in any storybook to which the model is applied.

  • Processing: Check if you want to apply this model by default when processing data.

  • Description: Edit model description.

  • Export: Choose this to export model. See Notification center for status.

  • Delete: Press to delete the model. A pop-up appears to confirm deletion.

Import

To import a new entity model, choose the Import button...

60638cdcc5e01.png

...and use the pop-up to find the file.

60638cde252cf.png

Hit the Import button and the new model will be sent to the library. See Notification center for status.

F. Server connections

View all server connections. Add, modify or delete server connections. This page is organized by server connection type:

Choose from the dropdown list to access the list of connections belonging to a particular type. 

System Administrators should use the Tenant switcher located in the upper righthand corner to verify you are working on the proper tenant.

604233d794a5a.png
1. Add SQL server connection

Choose the SQL server icon.

604233d9d26bd.png

The Add SQL Server Connection page appears:

604233db979bc.png

Enter the following:

  • Display Name (required): An alias for the server.

  • Server Name/IP (required): Insert server name or IP address.

  • Port Number: Enter port number.

  • Authentication (required): If you choose Username and Password they appear as prompts immediately below.

    604233dd8514a.png
  • Username (required): Automatically populated with your Reveal AI username.

  • New Password (required): Automatically populated with your Reveal AI password.

  • Confirm Password (required): (Passwords can be managed in Google account).

  • Folder path for bulk insert (conditionally required): Folder path for bulk insert is only required for destination server, see Reveal AI Installation Guide for more details on how to set up bulk insert folder.

  • Default server: To indicate that this server is a default server, select Source (Reveal AI will read from this server) and/or Destination (Reveal AI will write to this server).

    604233df425c4.png

Choose Test Connection and assuming confirmation choose Save

The connection is established:

(Failure to connect will result in “Unable to connect to SQL SERVER”.)

604233e0eb041.png
  • Save: Choose Save and the new SQL connection appears in the SQL Server list.

2. Add Relativity server connection

Note

For complete description of adding a Relativity server connection please see Section 4. Integration with 3rd Parties, A. Relativity, Add Relativity Server Connection.

3. Add SMTP server connection

SMTP server connections are used to allow email notifications. To set up an SMTP server connection choose the SMTP icon:

604233e2b449e.png

The Add SMTP Server Connection page appears:

604233e4a9a00.png

The following information is requested:

  • Tenant: This automatically populates according to the System Administrator's choice with the “Tenant Switcher”.

  • Name* (required): The name of the server connection.

  • SMTP server URL*: (required): The URL of the SMTP server.

  • Username* (required): Automatically populated with your Reveal AI username.

  • Password* (required): Automatically populated with your Reveal AI password.

  • SMTP Port* (required): Use arrows to choose port number.

  • Use SSL: Check if yes.

  • Test configuration by sending test e-mail: Check if yes. If checked, the Test e-mail recipient prompt displays.

  • Test e-mail recipient*: (required when presented)

  • Test Connection: A failure to connect will result in “Connection is incorrect: [Details].”

    604233e651fe9.png

Successful connection will result in “Server connection saved.”

  • Save: Choose Save and the new SMTP Server Connection will appear on the SMTP list.

604233e7e6917.png
4. Add Exchange/Office 365 server connection

To add a connection to either an Exchange server or an Office 365 server, choose the Exchange/Office365 server connection icon:

604233e97af0b.png

The Add Exchange/Office 365 Server Connection page appears:

604233eb512a3.png

The following information is requested:

  • Name* (required): An appropriate name for the server connection.

  • EWS host server URL* (required): The URL of the relevant Exchange server, or in the case of Office 365, the universal Office 365 URL, which is:

  • ClientID* (required): Publicly-available client identifier for Exchange/Office 365 site, usually contained in the site URL.

  • Exchange TenantID* (required): Globally unique identifier (GUID) for an Office 365 client site.

  • Client Secrets* (required): A secret key stored securely on the server side and known to the client only.

  • Username* (required): Automatically populated with your Reveal AI username.

  • Test connection:

    604233ed117aa.png

Once you confirm that “connection is correct” choose Save. The new saved connection appears in the list under “Exchange/Office 365 server“.

604233ee8b53d.png
G. Tenant setup

The Tenant setup page allows configuration of SMTP server and SSO service.

Choose Tenant setup:

60638cec85082.png

Note

Any SAML 2.0 compliant single sign-on service may be used; Okta is shown below as an example.

To setup either or both optional configurations, System Administrators first select the tenant through the “tenant switcher” dropdown:

60638cee8323d.png

The following displays:

60638cf08c454.png

To choose the SMTP server to be used for insights notification, choose the dropdown.

60638cf26d702.png

And then choose the particular server and then Save. Alternately, you may choose Add new SMTP server.

For SSO server configuration, choose Enable Single Sign On and the following indicated fields appear:

60638cf4338b1.png

Now use your Okta account to copy and paste:

  1. Identity Provider Single Sign On URL

    and

  2. Identity Provider Issuer

    604233f9ab8bc.png

Then download the Okta Certificate (the third item in the figure above) into your environment and …

60638cf6cff67.png

Choose “Choose file” from your environment to find and enter the downloaded certificate file.

The Identity Provider configuration info is automatically populated:

604233fce1cc0.png

Each of the indicated items should be copied and pasted into the appropriate Okta locations. SSO is now established. Once you use Okta to enter your environment you will no longer require a separate sign-in to Reveal AI. Equivalent workflows are available with other SSO platforms.

A Keycloak service is available as an option. Checking Keycloak access enabed under Keycloak service configuration opens fields required to configure this service.

60638cf9671ad.png