Users

Users are individuals who have access to the Relativity environment. You create users and add them to groups, which are then associated with workspaces. Users are also directly associated to clients. This diagram illustrates how clients, groups, and workspaces relate to users.

Clients, user, group, and workspaces diagram

This page contains the following sections:

Using users

Imagine you're a system admin, and a new employee, John, needs access to Relativity so he can join a review team and begin reviewing documents.

You create a new user account named John for him and add it to the appropriate reviewers group.

User status

You can view information about users currently logged in to Relativity from the User Status tab, which is available from within any workspace or from Home. Whether or not you're in a workspace determines the functionality and information available on the User Status tab as follows:

  • Home - the tab lists users currently logged in to Relativity. You can send web page messages and email messages to users listed on the tab. You can also force the log out of these users from the system.
  • Within a workspace - the tab lists the subset of users accessing the current workspace. You can send web page messages and email messages to users listed on the tab.

Creating and editing a user

To create a new user, follow this procedure:

  1. Navigate to the Users tab.
  2. Click the New User button in the upper-left. To edit an existing user, click the icon next to their name.
  3. Complete the fields on the form. See Fields.
  4. Click Save.
  5. Add a login method or methods. See Adding a user login type.

Note: Once you've created users in Relativity, you have the option to add them to groups. In Relativity 9.6.50.31 and above, adding or removing users from a group triggers a job. If your Relativity environment is set up with an SMTP server, you'll receive an email notification once the job is completed. If there's an error, the email will include a link that allows you to retry the job. However, you must be logged into Relativity in order to use the retry link. Alternatively, you can find the retry link under the Errors tab.

User and group operations are typically disabled by default. If you'd like to enable these features in your Relativity environment, please contact Customer Support. For further details on adding users to groups and dealing with errors, please see .Adding users to groups and Errors.

Watch the following Creating Users and Groups video for more information.


Note: You can preview the security settings of any workspace available for a user by clicking Preview Security. For more information on previewing user security see Preview security.

Adding a user login type

Relativity supports several authentication and login methods. You must assign the user at least one of these types in order for them to login.

See the following pages:

Fields

The User Information section fields are:

  • First Name - the user’s first name. This field must be between 1 and 50 characters.
  • Last Name - the user’s last name. This field must be between 1 and 50 characters. The system displays a user as <last name>, <first name>.
  • Email - the user’s email address. While the system won't validate this information, you must enter it in the following format: name@domain.extension.

    • Note: Relativity users can have the same first and last name, but the email address must be unique.

  • Type - the user type. The default values are internal or external, but you can add any type value. Type is for reference purposes only and has no impact on access or billing.
  • Client - the client associated with the user. Click Select to choose from available clients.

    Note: Items on the selected client list are set by a system view. It's possible you'll see only a sub-set of items. For more information on editing system views, see User options.

The Other User Details section fields are:

  • Keywords - an optional field where extra user information may be recorded.
  • Notes - an optional field where extra user information may be recorded.

The Access section fields are:

  • Relativity Access - a toggle where you can control the user’s access to Relativity.
    • Enabled - the default value. Enabled users can log in to Relativity and are considered for billing under your Relativity license.
    • Disabled - users cannot access Relativity and won't be counted or billed as named users on your Relativity license.
      When Relativity is first deployed, the system sets the Relativity Access field for existing users using the following criteria. A system admin can change a user's access at any time.
      • If a user is in a group with rights to a workspace, their Relativity Access is set to Enabled.
      • If a user is not in a group with rights to a workspace, their Relativity Access is set to Disabled.
  • Disable on Date (UTC) - the date when the user's Relativity access is disabled. Use the field to auto-disable users on a specific date in the future, for example, when managing contact reviewers. When you specify the date, it can't be in the past. For more information, see Auto-disable users

    • Note: The Disable on Date value is in UTC and does not represent local time.

  • Trusted IPs - specifies a list of trusted IP addresses for a user. Authentication fails if a user attempts to log in to Relativity from an unauthorized IP address. For detailed setup instructions, see Authentication.

    Note: Relativity only supports the IPV4 format for Trusted IP addresses. It doesn't support the IPV6 format.

The Permissions sections fields are:

  • Change Settings - users without admin rights can change their settings depending on whether the toggle is enabled or disabled.
    • First name
    • Last name
    • Email address
    • Item list page length
    • Default selected file type
    • Advanced search default
    • Enable or disable Native Viewer Cache Ahead

    • Note: While "My Settings" appears grayed out in the user preview, users will still be able to access and change their own settings based on their assigned permissions.

  • Change Document Viewer - users can change document viewer modes depending on whether the toggle is enabled or disabled. For more information, see Reverting viewer per user.
    • Enabled - users can select which viewer they want to use. You can still set a default viewer in the Document Viewer field, but users can switch between viewers.
    • Disabled - users can't select which viewer they want to use. Whatever viewer appears in the Document Viewer field in User Settings is the only viewer the user has access to.
  • Document Skip - controls whether or not the user has the ability to skip documents during review that no longer meet the original conditions of a view due to propagation. This option only affects documents when the Document Viewer field is set to HTML. The available options are:
    • Enabled - enables the Skip function.
    • Disabled - disables the Skip function.
    • Force Enabled - always enables the Skip function so that the user can't turn it off. This option is only available for system admins.
  • Keyboard Shortcuts - Choose a default setting for the keyboard shortcuts icon in the Review Interface. This property is set to Enabled by default.

The Defaults section fields are:

  • Item List Page Length - a numeric field indicating the default list length for all views in Relativity except for views that are embedded into layouts as an Associative Object List. You can set it from 1 to 200.

    Note: Associative object lists in a layout do not inherit this value (the default number of items per page for these lists is 10 and cannot be customized).

  • Document Viewer - determines which viewer the user can access when reviewing documents.
    • Default - uses the new Aero viewer to review documents.
    • Review - uses the new Aero viewer to review documents.
    • HTML - uses the HTML viewer to review documents.
  • Document Viewer Preference - the default viewer mode:
    • Viewer
    • Image
    • Long Text
    • Production
  • Skip Default Preference
    • Skip - advances a user to the next document in the queue that matches the defined view conditions when the user clicks Save and Next.
    • Normal - document review operates normally, displaying all documents in the queue.

  • Show Filters - determines whether or not filters on all columns are visible by default for that user.

    For Relativity 9.6.50.31 and above, the out of the box setting for this field is Visible, but you can modify it as necessary. Upgrading to this version sets the Default Filter Visibility field to Visible for existing users whose filters are hidden.

    • Enabled - shows filters by default.
    • Disabled - hides filters by default.

    Note: If a user is currently logged in to Relativity when a system admin modifies a setting, the user must log out and log back in for the changes to take effect. This also applies to the system admin if they are altering the setting on their own account.

  • Saved Search Owner - determines whether saved searches are public or private by default. If Public is selected, the search is public and all users with rights to it can see it. If User is selected, the search is private and only the logged in user is able to see it. The property’s default value is configurable on a system level. See the Instance setting table overview for details.
  • User-Group Email Notifications (if applicable) - controls the type of email notifications Relativity will send to an admin that is adding or removing users from groups. The available options are:
    • Receive All- receive all email notifications regarding the addition or removal of a user or group.
    • Receive Errors Only - receive email notifications on failed operations only regarding the addition or removal of a user or group.
    • Do Not Receive - receive no email notifications regarding the addition or removal of a user or group.

    Note: The following additional configuration is necessary to get SMTP notification working for User-Group Email Notifications:
    Change the following Instance Setting to True:
    • Name: EnableUserGroupOptimization
    • Section: Relativity.Core
    Add the Group Membership Manager and Group Membership Worker agents to the Instance.

Viewing user audit records

Use the View Audit function to view a user's audited actions. To access the audit records, select the Users tab and click the name of a user. Then click View Audit.

Note: Audit records are not modified when a user is deleted or disabled. You will still be able to search for a user's audits based on their user name.

(Click to expand)

The user's history displays in a new window.

History of User window

The following columns display:

  • User Name - The name of the Relativity user who performed the action.
  • Action - The action that was performed.
  • Timestamp - The date and time that the action was performed.

Sending messages to users

From Home or within a workspace, you can send web page messages to one or more users with the mass send message feature. Use the following steps to send a message:

  1. Open the User Status tab in from within a workspace or from Home.
  2. Select the checkbox next to the names of the users you want to send a message to.
  3. Select Send Message from the drop-down menu at the bottom of the page.
  4. Click Go.

    5. The Webpage Dialog appears.

  1. Enter your message in the Message field, and then click Send Messsage. The selected users receive a web page message immediately.

To send an email message to an individual recipient, you can click on their email address link. This will launch your native email application, allowing you to compose the message. Your login information will identify you as the sender of the email message.

Forcing users to log out

From Home, you can force users to log out of Relativity from the User Status tab.

Note: When you use the Force Log Out option to terminate a user's session, any changes the user made and did not save will be lost.

Use the following steps to log users out:

  1. Click your name in the upper right corner of Relativity, and click Home.
  2. Open the User Status tab.
  3. Select the checkbox next to the names of users you want to log out.
  4. Select Force Log Out from the drop-down menu at the bottom of the page, and then click Go.
  5. Click OK on the confirmation message. Relativity immediately logs out the users you selected.

Adding or removing users from a client domain

You can add or remove objects from client domains if you have the client domains feature activated. See Client domains for more information.

Use the following steps to add a user to a client domain:

  1. Navigate to the Users tab.
  2. Click the icon to edit the user.
  3. Click Select next to the Client field in User Information section of the Users tab.
  4. Select the client with client domains enabled from the list.
  5. Click Save.

Use the following steps to remove a user from a client domain:

  1. Navigate to the Users tab.
  2. Click the icon to edit the user.
  3. Click Select next to the Client field in User Information section.
  4. Select a client not associated with a client domain from the list.
  5. Click Save.

Auto-disable users

You can auto-disable users on a specific date in the future. You can set the Disable On Date (UTC) field when creating or editing an individual user:

You can also use a mass-operation to set the Disable On Date (UTC) field for multiple users:

  1. Navigate to the Users tab.
  2. Select the checkbox next to the names of users.
  3. Select Enable from the mass operations drop-down menu at the bottom of the page. The Enable Users dialog opens.

    Enable Users window

  4. Select the checkbox next to the Disable On Date (UTC) field.
  5. Enter or select the value for the Disable On Date (UTC) field. The date-time value must be in the future.

    Note: If you select the checkbox and leave the date value blank, will clear the Disable On Date (UTC) for the users.

  6. Click Ok. The Disable On Date (UTC) field is set for the selected users, and they will be automatically logged out on the specified date and time.