Relativity is a complex application with many screens and functions. This section describes the main core reviewer interface you use to review documents as well as some of the standard procedures you'll need to perform as you use the product.
This page contains the following sections:
- Logging in
- Tab navigation
- User options
- My settings
- UI framework
- Core reviewer interface
- Resetting your password
- Quick nav
Relativity offers several ways to log in and it's possible to have two or more methods available to you. Your system admin will provide you with all the information you need to log on. Contact your system admin if you have additional questions.
For procedures to log in, see Logging in to Relativity
When you log in to Relativity, you see a tab strip at the top of the page. This tab strip displays the currently available tabs whether you are in Home or Workspaces mode. The active tab is indicated by a bright blue background, while inactive tabs have a navy background.
Tabs appear from left to right in the order identified by the Order setting for each tab.
Parent and child tab display
Parent tabs are indicated by a drop-down arrow to the right of the tab name.
Click the drop-down arrow to display a vertical list of the child tabs owned by that parent tab.
When you select a child tab (for example, Markup Sets) from the list, you're taken to that page, and all child tabs appear horizontally under the active parent tab.
Instead of clicking the drop-down arrow, you can also click the parent tab itself. Clicking the parent tab takes you to the default child tab, which is identified by the Order setting for each child tab.
Overflow tab menu
The number of tabs that appear in the tab strip depends on the size of the browser window. If the window is wide enough, the full set of tabs appears. As you reduce the size of the window, or if you have a large number of tabs in your workspace, an overflow drop-down icon appears at the right edge of the tab strip to house the remaining tabs.
Click this overflow icon to display a drop-down list of the remaining tabs. If the number of tabs exceeds the height of the drop-down list, a vertical scroll bar appears, allowing you to view the full set of tabs.
Parent tabs in the overflow menu are indicated by a drop-down arrow to the right of the tab name. Click the drop-down arrow to display the child tabs for that parent.
You can select a child tab to navigate directly to that tab, or you can select the parent tab name to navigate to the default child tab. The default child tab is identified by the tab order setting on each tab.
While working with the overflow tabs menu, a set of double vertical lines appears on the left edge of the right-most tab. This indicates that you selected the tab from the overflow menu. If you select a different tab from the overflow menu, the tab you select replaces the previous tab.
When you click the icon to display the overflow tab menu, the icon changes to an X. Click this icon to collapse the overflow tab menu.
When you first log in to Relativity, you see the default Home tab. Relativity displays the Workspaces tab as your default Home tab when you navigate to Home, but you can change the default Home tab to be any tab you want. See Navigation for more information.
The Relativity Instances section includes federated instances you have access to. Federated instances links allow reviewers to easily switch to other Relativity environments.
The user drop-down menu options are:
- Home - navigates to the default Home tab. If you set up a federated instance, Home is replaced by the local instance name.
- Reset Password - opens a pop-up where users can change their passwords.
- My Settings - opens a pop-up where users can change their personal settings. See My settings for more information.
- Logout - logs users out of Relativity.
Under the Home section are three additional links:
- Help - launches the Relativity Documentation website, which provides all Relativity user, system admin, and systems documentation in a navigable format.
- Support - opens a new window containing the Technical Support page of the Relativity website where you can open a support ticket.
- About - opens a webpage dialog displaying the Relativity version number, your instance details, and licensing agreement information. The Credits link appears below this information, and it opens a window listing credits for the icons used in the application, as well as the URL for more information about these icons. Depending on your permissions, you may have the option to edit your settings or reset your password. If you don't see admin tabs, your system admin can change your permission settings.
Changing the default Home tab
Relativity displays the Workspaces tab as your default Home tab when you navigate to Home, but you can change the default Home tab to be any tab that is available for default and that is not a specific tab within a workspace.
Perform the following steps to change the default Home tab:
- From Home, click the Admin Workspace Configuration tab.
- Click the Tabs tab.
- Click the tab you want to set as the default Home tab.
- Click Edit.
- Select Yes in the Is Default drop-down menu.
- Click Save.
Note: If a user is not a member of a group with permission to view the tab set as the default Home tab, Relativity redirects to the lowest ordered tab the user's permissions allow.
Clicking My Settings from within the user drop-down menu opens a settings mode pop-up, which displays your user information. Click Edit to change your settings.
- First name - your first name.
- Last name - your last name.
Note: Your first and last name appear as your username throughout Relativity.
- Email address - your email address and login.
- Skip Default Preference - When reviewing documents, skip prevents a reviewer seeing documents that are already coded (depending on the selected view). See
Document skip. Choose one of the following options:
- Normal - this setting disables the skip feature.
- Skip - this setting turns on the skip feature.
- Default Filter Visibility - determines whether or not the filters for columns in views display by default.
- Hidden - hides filters by default.
- Visible - displays filters by default.
- Item list page length - a numeric field indicating the default list length for all lists in Relativity. It can be set from 1 to 200.
- Default Selected File Type - the default viewer mode (Viewer, Native, Image, Long Text, or Production) used when first loading the Viewer. If the mode selected is not available, the Viewer will instead use the first available option. See Viewer mode for details.
- Default Saved Search Owner - determines whether saved searches are public or private by default. If set to Public, the search is public and all users with rights to it can see it. If set to Logged in User, the search is private and only the logged in user is able to see it.
- Native Viewer Cache Ahead - if checked, this field pre-loads the next native document in your review queue when the active document is loaded.
- User-Group Email Notifications - user's preference for email notifications when adding or deleting Users or Groups.
- All Emails - receive all email notifications.
- No Emails - receive no email notifications.
- Only Failed Operations - receive email notifications on failed operations only.
Note: Depending on your permissions, you may not have rights to edit the Default Saved Search Owner field.
Note: Depending on your permissions, you may not have rights to edit the User-Group Email Notifications field.
After changing your settings as needed, click Save.
In the UI framework, you can access dashboards and the search panel.
When you've created a page configuration you'd like to preserve, you can create a customized dashboard. You can save multiple dashboards to quickly change the page configuration. The item list and any widgets on the dashboard will update automatically in response to filtering or searching. Dashboards only report on data within the workspace you are in.
(Click to expand.)
The page initially appears with the folder browser on the top left, the search panel on the bottom left and the item list to the right. Within this new framework, you have multiple options for customizing your display.
You can resize, move, or collapse any panel on the page, including any widgets you create.
- To resize any panel, hover over the line separating the item list from the panel until you see the mouse pointer change to horizontal arrows, then click and drag.
- To move, hover over the top of the panel until you see the icon. Then, click and drag the panel to the new location.
- To collapse the search panel or browser pane, click the icon. Once collapsed, click the icon to restore the browser pane or the icon to restore the search panel.
Additionally, you can drag and drop panels to rearrange on the page. Click any panel and drag it to a new location. The other panels will automatically move to accommodate the panel you're dropping.
Dashboards and widgets can be copied over to newly created workspaces if they are part of a template. Dashboards only report on data within the workspace you are in if data is loaded in the workspace.
Note: You must have the correct workspace permissions to add, edit, or save a dashboard and to save pivot widgets to your dashboard.
You can also export individual Pivot widgets to Excel or to PNG format from each widget's context menu. See
Note: To enable the Add Widgets button and Pivot functionality for an Relativity Dynamic Object (RDO), you must select Enabled for the Pivot property in the Object Type Information section for the object.
To create a dashboard:
- Click the Dashboards drop-down menu in the top right corner of the screen.
Note: You can only access the drop-down if Pivot is Enabled for the given object type.
- Click New Dashboard to save the current page configuration as a new dashboard.
- Enter a name and an order number for the dashboard.
Note: The dashboard with the lowest order number will appear by default when you log in to Relativity.
You can add the following widgets to customize your dashboard:
- Pivot charts and tables - You can use Pivot to summarize data in tables or charts to visually analyze trends in your data.
See Running Pivot reports for details on creating Pivot widgets.
- Cluster visualizations - On the Documents tab, you can use Relativity Cluster Visualization to render your cluster data as an interactive visual map by adding a Cluster Visualization widget. This offers you a quick overview of your document cluster sets and quickly drill into each cluster set to view subclusters and conceptually-related clusters of documents.
See Visualizing a cluster.for details on using cluster visualization.Please note that there may be only one cluster visualization widget per dashboard.
- Communication Analysis - After running the name normalization operation within structured analytics, you can use this widget to visualize communication frequencies, patterns, and networks between the entities linked to the documents in the view.
See Communication Analysis for details on using Communication Analysis.
Note: When you reach the maximum number of widgets allowed on a dashboard, the Add Widget button will be grayed out and a tooltip displays when you hover over it that lets you know the reason you cannot add any additional widgets to your dashboard. This is controlled by the MaxNumberDashboardWidgets instance setting.
You can also make changes on the fly and save a dashboard with the changes. If a dashboard has not been saved, an orange notification displays in the Dashboard drop-down menu until it is saved.
- Click the Dashboards drop-down menu in the top right corner of the screen to display the list of dashboards available on the current tab.
- Click Save to save the changes to the existing dashboard. Click Save As to save the page configuration as a new dashboard, and then enter a Name and Order number.
Note: If a dashboard is part of a locked application, the option to save the dashboard is unavailable.
To delete a dashboard from the current tab you are in, click the icon to the right of the dashboard you want to delete in the Dashboards drop-down menu.
Click Delete in the Delete Dashboard Confirmation popup to delete the dashboard.
Note: If a dashboard is part of a locked application, the option to delete the dashboard is unavailable.
To rename a dashboard:
- Click on the icon next to the name of the dashboard in the Dashboard drop-down menu.
- Enter a Name and an Order number for the dashboard. The order number controls the order in which the dashboard displays in the list.
- Click Save to save your changes.
Note: If a dashboard is part of a locked application, the option to edit the dashboard is unavailable.
If a dashboard is part of a locked application, a icon appears to the right of the dashboard.
Click the icon to view a list of locked applications the dashboard is associated with.
Using the search panel
While working in the Document list in the new UI framework, you can use the search panel to filter your data.
To open a document in the core reviewer interface, click on a document name or identifier on the Documents tab.
Note: See the Core reviewer interface quick reference guide for more information.
The core reviewer interface screen consists of the following areas:
- Document view selector
- Navigation bar
- Related Items pane
- Persistent Highlight Sets
(Click to expand)
You can toggle between several viewing options by using the icons in the upper-right corner of the window.
- Keyboard shortcuts legend - displays the keyboard shortcuts legend for the workspace.
- Enable/disable keyboard shortcuts - enables and disables keyboard shortcuts for the workspace.
- Show/hide document list - show or hide the document list from the Core Reviewer Interface.
- Dock/undock document viewer - docks or undocks the viewer from the Core Reviewer Interface.
- Swap panes - flips the Viewer from the left side of the window to the right or vice-versa.
- Launch standalone document viewer - pops out a static standalone version of the Viewer.
- Show/hide tab strip - shows or hides the tab strip.
You can move through a set of documents by using the navigation menu located in the upper-right corner of the core reviewer interface.
You can type a number into the textbox and hit Enter to move to that document. You can also use the navigation arrows:
|Top of first page||Previous page||Next page||Last page|
You can't browse past the last document in your returned set. For example, in the above screen shot, you can't use the navigation arrows to get to document 1,001.
There are two ways you can reset your password if your system admin has given you the appropriate permissions. You can use the Reset Password option inside Relativity or the Forgot your password? link on the Relativity login screen.
Note: If your password has expired, the Reset Password dialog appears automatically when you log in to Relativity. Your system admin determines when your password expires and the number of previous passwords that you can't reuse.
Resetting your password inside Relativity
If you're already logged in to Relativity, you can reset your password by clicking Reset Password in the Home drop-down menu. This directs you to a Reset Password pop-up.
Enter your old password, then enter and retype your new password. Click Save.
You can use your new password next time you log in to Relativity.
Resetting your password outside Relativity
If you can't log in to Relativity because you've forgotten your password, perform the following steps to reset your password.
- Click Forgot your password? on the login screen.
- Enter your email address in the pop-up.
Relativity sends an email to the address you provide. You should receive this message within a few minutes. If you don't receive an email, check your spam or junk mail folder.
- Click the link in the email to reset your password. This link will be active for 15 minutes and expires after that time. If the link has expired, or if you click the link more than once, you'll have to generate a new password reset request.
- The link directs you to a page where you can create a new password.
- Enter a new password and retype it, then click Submit. After your password successfully resets, you'll get a message prompting you to log in with your new password. An email will be sent to the address you entered, notifying you that your password reset was successful.
The Favorites menu contains all your bookmarks (Favorites) and the last 10 pages in your browsing history (Recents). The Favorites menu appears at the top of the application window next to your username.
Use Favorites to quickly navigate the Relativity application. If you visit a particular page on a regular basis, minimize the number of clicks it takes to get there by adding the page as a favorite.
To mark a page a favorite, click the gray star next to Favorites, or click the gray star next to a page name in the Recents section. The star turns yellow and Relativity adds the page to the Favorites section. Relativity doesn't limit the number of pages you can mark as a favorite.
Relativity records pages in the Recents section on each page load. That means that pop-up windows aren't recorded as Recents.
Imagine you're a system admin whose duties include resetting passwords for an average of 20 to 30 users per day. You could navigate to the Administration tab, then click the Users tab each time a password reset request comes through the queue, but instead you create a favorites bookmark to easily jump you the Users tab from any tab in Relativity you might be working on.
You create favorites bookmarks for all of the tabs that you most frequently visit optimizing your productivity.
Note: If you're a system admin, you can turn off this feature by editing the RecentHistoryEnabled and FavoritesEnabled instance setting values. You can also change the number of Recents the Favorites menu displays by editing the RecentHistoryNumberOfItemsDisplays instance setting value.
Quick nav can be used to quickly search for and navigate to any workspace or tab in Relativity. To access quick nav, click in the upper right corner of Relativity, or use the keyboard shortcut Ctrl+/.
Note: Verify that the quick nav Ctrl+/ keyboard shortcut works on custom pages. Contact Client Services with any problems.
Open quick nav, and type the name of any tab or workspace.
Any tab or workspace that contains the character string within the name appears in the list of results. Results appear after you type more than one character, and they refine with each character you type. The results link you directly to the tab or workspace in Relativity.
Note: In Relativity terms, the search works the same as a leading and trailing wildcard search.
You can click on any result or use the up and down arrow keys to move through the results. Press Enter to navigate to the selected item.
Your search remains until the page is refreshed or you navigate to a new tab. The Esc key also clears your search from quick nav. If no text is entered in the quick nav search field, Esc closes quick nav. You can also click anywhere outside the quick nav window to close it.
Quick nav displays three types of results in the following order:
- Workspace tabs - lists all workspace tabs that fit the search criteria and are available with your permission settings.
Note: This item only appears when you are in a workspace.
- Admin Tabs - lists all admin tabs that fit the search criteria and are available with your permission settings.
- Workspaces - lists all workspaces that fit the search criteria and are available with your permission settings. Click the workspace to go to the default tab for that workspace.
Quick nav results only reflect items available with your permission settings.
Using quick nav
Imagine you're a system admin in a workspace within Relativity, and a user emails you with a password reset request. You press Ctrl+/ and type the letters “use”. The results filter to only contain Admin and Workspace tab names with the letters u-s-e.
The results display a Users tab in the Admin tabs section. You click the Users tab and find the user who needs a password reset in the list. Once their password is reset, you use quick nav to get back to the workspace you were previously working in.
The following list highlights more features of quick nav functionality.
- Type the word "home" in quick nav to navigate to your default Home tab.
- Quick nav is enabled or disabled with the
- Quick nav is available to look up workspaces and admin tabs from Home for groups assigned the Use Quick Nav admin permission, and it is available to look up tabs in a workspace for groups assigned the Use Quick Nav workspace permission.
See Instance security and Workspace security.
- The maximum number of returned quick nav search results is limited to any number between 2 and 50, but the default is 20.
Use the QuickNavMaxResults instance setting to adjust the maximum number of results.
- The maximum number of searchable characters is 50.