RelativityOne technical overview

Welcome to RelativityOne. Before you can set up your Relativity instance for case workflow, you will want to configure your organization's infrastructure and network access, and implement necessary security, in addition to reviewing the following system-level tools RelativityOne provides .

If you're an IT or network admin that is charged with preparing your organization for RelativityOne, review the following system-level technical overview.

RelativityOne government (FedRAMP)

The following functionality is not currently available for FedRAMP customers / government entities:

  • Utility server
  • Customer-managed keys (CMK)
  • Sandbox environments
  • Preview environment
  • S2S VPN requests - Global Protect VPN client is the only supported VPN connectivity for FedRAMP customers / government entities

As a security measure, Relativity blocks all outbound connections to the internet for FedRAMP government entities by default. This may prevent the loading of linked images or interfere with the functionality of custom applications that require internet access. FedRAMP customers can request that these outbound internet connections be allowed by reaching out to Relativity Support.

RelativityOne workstation configuration

Across your organization you should assess workstations to ensure that they meet Relativity minimum system requirements and have all required software installed.

  • Check your browser compatibility.
  • Perform workstation configuration.

RelativityOne network access

The following diagram depicts user and admin access to the RelativityOne network in a RelativityOne instance.

Note: Only RelativityOne government (FedRAMP) data centers use the Aspera access depicted in the following diagram. RelativityOne commercial data centers do not.

Refer to the following sections for further description of the considerations for network access:

Port considerations

Ensure your port settings are configured correctly for the following:

Firewall privacy considerations

You will need to allow the following:

Accessing the RelativityOne backend (custom reporting, application dev, data manipulation)

To access RelativityOne backend resources, you must first connect to your VPN, and then connect to your desired resource (e.g., Utility Server or Direct SQL).

Step 1 – Connecting to your VPN network

The first step in accessing the RelativityOne data directly is connecting to RelativityOne via your GlobalProtect VPN connection. Your GlobalProtect VPN is used to access backend components of your RelativityOne environment.

Your VPN enables a secure connection between your computer and resources on your Relativity instance's network. The following resources are available when you connect to the GlobalProtect VPN client:

For Sandbox environments, you can access the following back end resources via the VPN:

For more information on how to connect to your VPN client, see GlobalProtect VPN client.

Once you are connected to the VPN, you can connect to the RelativityOne technical overview or Step 2a - Connecting to Utility Server.

Step 2a - Connecting to Utility Server

Note: This functionality is not currently available for FedRAMP customers / government entities.

The Utility Server is a virtual machine that can optionally be connected to your RelativityOne instance. It contains additional support tools to help you work with data in your RelativityOne staging area before editing and loading it into your RelativityOne instance. You access your Utility server through a remote desktop connection, using an issued set of credentials and a custom IP address.

Once you are connected to your Utility Server, you can perform the following actions:

  • Access a mapped drive for the file share (TenantUser accounts) - access your uploaded files to edit in the staging area before you add them to your RelativityOne workspaces or save them to a RelativityOne file storage location. You can also access and verify any production sets before you download them locally.
  • Install applications - if you have TenantAdmin access you can install applications
  • Manage user administration - if you have TenantAdmin access and have Terminal Services licensed on the computer you can manage user administration yourself.

Note: It's not recommended to store files on your Utility Server. If your Utility Server becomes inaccessible, you will lose the files you stored.

Note: Direct SQL Access on the Utility Server is not supported.

See Utility Server for more information.

Step 2b – Connecting to Direct SQL

Note: Direct SQL access is not included automatically with your RelativityOne subscription, and must be requested by contacting your customer success manager or implementation specialist.

In addition to querying and manipulating data through Relativity's suite of API's, administrators and developers can extend the power of the Platform even further by directly querying the SQL database. This is an important aspect of the Platform that you may be accustomed to using in your Relativity Server deployment, and something you can also take advantage of in RelativityOne. You can run Relativity Scripts in your RelativityOne instance, and you can also run SQL scripts in SQL Server Management Studio (SSMS) directly against your Relativity databases. Direct SQL can be used for situations that require running custom reports, Relativity scripts, or running commands directly in SQL Server Management Studio against your RelativityOne database.

You will be provided with one TenantAdmin account that you can use to create additional accounts with the limited permissions that you specify.

Note: You do not receive access to the physical server, you are only able to access SQL via the SQL Management Studio. No additional infrastructure components (certificates, etc.) are required for the access - only the VPN connection and SQL Server Management Studio.

See Direct SQL access.

RelativityOne system downtime windows

The advantage to RelativityOne is that we maintain and upgrade your software to ensure that your business operations in RelativityOne run smoothly and that you always have access to the latest features and defect fixes. We require regular downtime windows to do this, typically during non-business hours.

Please refer to RelativityOne maintenance downtime windows for more information on this schedule.

RelativityOne resource scaling

Scaling in terms of software products refers to increasing server infrastructure resources or re-prioritizing system processes to increase a system's workload capacity on demand. Increasing a system's workload capacity either entails finishing one unit of work in a smaller amount of time (i.e., speed) or finishing more units of work in the same time interval (i.e., concurrency). Scaling is typically used for large batch operations or when there is a large volume of jobs that may take a long time.

The advantage to RelativityOne is that we maintain and upgrade your software to ensure that your business operations in RelativityOne run smoothly and that you always have access to the latest features and defect fixes.

However, we want customers to notify the RelativityOne team proactively when they know they will be bringing a large matter into the instance so that RelativityOne can be at it's most powerful when handling large amounts of information ingestion and processing such as with Imaging, OCR, Branding, and Productions.

Automated RelativityOne resource scaling

RelativityOne monitors system activity and automatically makes decisions about the following:

  • System resource scaling—increasing workers and server resources
  • Resource prioritization—which processes should receive resources given jobs that are competing for the same resources

System resource scaling

Automatic scaling in RelativityOne detects large jobs and automatically increases system resources to a higher performance capacity. Currently, RelativityOne automatically scales resources in the following product areas:

  • Processing. For example ingestion and imaging)
  • Mass PDF
  • OCR
  • Branding
  • Productions
  • Indexing. For example. analytics.

Informing support of a large incoming RelativityOne project

When you have a large or complex incoming RelativityOne project, it's recommended that you inform Relativity's teams so that we have enough detail to provide the guidance and resources to ensure your success. To do this, use the Incoming Project Details: RelativityOne Community form to let us know.

  1. Log in to the Community and click Open a Support Ticket.
  2. Click Submit or resume a RelativityOne request.
  3. Select Incoming Project Details: RelativityOne as the request type.

To complete the request, you'll be asked to provide the following information:

  • RelativityOne instance or web name
  • Description of the project
  • The number of documents you expect to be in the workspace
  • Workspace artifact ID or name
  • Functionality in which you expect increased usage/volume (Analytics, Imaging, Processing, etc.)
  • Start and end dates of project

Security

At Relativity, no topic is more important than security. With preventative defense, automated processes, and transparent operations, we keep our customers’ most sensitive data protected.

Security white paper

RelativityOne runs on Microsoft Azure and is built on Microsoft’s foundational investment in security technology, operational processes, and expertise. Relativity Security utilizes logs, telemetry, and configuration data generated from the Relativity Application, underlying infrastructure, and Azure to monitor and secure the environment. No customer data or any Personal Identification Information (PII) leave the environment for this purpose.

Refer to the Security white paper for comprehensive information regarding the security built into RelativityOne.

RelativityOne Security Center

As organizations workforces are increasingly dispersed, you want to be sure you’re keeping your data secure. Security Center provides a single-threaded view into the most pressing areas of concern for securing your data. 

These areas include:

  • User 2-factor Authentication - 2-factor authentication (2FA) provides an additional layer of protection in the event that passwords are compromised. In Security Center, admins have the ability to track two-factor authentication usage and send users notifications to enable 2FA to make sure user endpoints are secure.
  • Login Map - the Login Map provides you with insight into where your users are accessing data from. You will be able to see logins across geographies and identify calls to action, such as logins that do not currently have 2-factor authentication set up.
  • User Activity—Security Center provides insight into the status of active and inactive users and allows you to disable or delete them to ensure your data is secure.
  • Lockbox access - transparency and trust are two core tenants of the security program at Relativity. Lockbox in RelativityOne ensures that Relativity support staff only have access to your workspaces when you give it to them. In Security Center, you can do real-time access audits of Lockbox/Relativity support and revoke access if needed.
  • Relativity employee workspace access - this report provides transparency and real time insight into Relativity Support activity in your Relativity instance to help you work with our Support teams. It offers a list of easy-to-read audits of Relativity staff activity that can be exported to CSV format for external review.
  • Threat Intel - the Threat Landscape Update (TLU) report is a review of the threat actors, malware, techniques, campaigns, and other threat information currently active that has an impact on the legal services industry. This report is published weekly.

Note: Only RelativityOne System Administrators have access to the Security Center dashboard.

See RelativityOne Security Center.

Hash value instance settings for billing metrics

The following instance settings determine whether the billing telemetry data we collect from your RelativityOne instance is anonymized or not.

Examples of billing telemetry data would be Workspace sizes, client and matter values, or usernames. We collect this data to accurately report your RelativityOne billing metrics. Configure these instance settings according to your organizations' security standards to choose whether we collect them in an anonymized way.

Modifying these settings will have a downstream impact on your Billing API. For more information see, Billing APIs.

These settings will affect what data is displayed on your Cost Explorer.

Instance Setting Section Description
ReplaceCaseNameWithHashValue kCura.Billing Controls whether the Case Name in the billing metrics is replaced with the Case ArtifactID. If set to True, the Case Name in the billing metrics is replaced with the Application ArtifactID. By default, the value is set to False, and the Case Name is displayed.
ReplaceClientNameWithHashValue kCura.Billing Controls whether the Client Name in the billing metrics is replaced with a unique hash value. If set to True, the Client Name in the billing metrics is replaced with a unique hash value. By default, the value is set to False, and the Client Name is displayed.
ReplaceClientNumberWithHashValue kCura.Billing Controls whether the Client Number in the billing metrics is replaced with a unique hash value. If set to True, the Client Number in the billing metrics is replaced with a unique hash value. By default, the value is set to False, and the Client Number is displayed.
ReplaceMatterNameWithHashValue kCura.Billing Controls whether the Matter Name in the billing metrics is replaced with a unique hash value. If set to True, the Matter Name in the billing metrics is replaced with a unique hash value. By default, the value is set to False, and the Matter Name is displayed.
ReplaceMatterNumberWithHashValue kCura.Billing Controls whether the Matter Number in the billing report is replaced with a unique hash value. If set to True, the Matter Number in the billing metrics is replaced with a unique hash value. By default, the value is set to False, and the Matter Number is displayed.
ReplaceUserNameWithHashValue kCura.Billing Controls whether Relativity replaces the username portions of user email addresses with hash values in billing information sent manually or sent automatically through the SMTP server. If set to True, Relativity replaces all text preceding the @ symbol in each user email address with a unique hash value. Domains remain unencrypted. If set to False, the entire user email address appears.

Client domains

The client domains feature enables Relativity to deliver more powerful managed service offerings for enterprise customers in a single RelativityOne instance by providing an easier way to securely isolate users, workspaces, groups, and matters by client.

Using client domains, system admins can empower a user group that is not part of the System Administrator group (client domain admins) to perform common administrative tasks within their own client domain while limiting their visibility into the Relativity environment as a whole. The client domain admins can customize the permission settings to various objects according to their preferences within their own domain, but cannot access any permissions outside of that. This resource isolation functionality grants your enterprise clients more administrative control over their own portions of the environment while preventing back-end visibility and unauthorized changes to your RelativityOne instance as a whole.

Note: Client Domains are targeted for the above use case only and it is important to consider all the limitations outlined in Client domain limitations and considerations.

Implementing client domains requires an additional license from Relativity ODA LLC. Each client domain license is unique, and client domains can have different terms encoded on their license keys. The license for a client domain is unrelated to any other license for Relativity (e.g., number of seats). Client domain licenses are not transferable from one client to another. To request a new client domain, you must submit a RelativityOne request via the Community site as detailed in the following knowledge article.

See Client domains.

Customer lockbox

RelativityOne’s Lockbox feature provides you with greater control over your workspace data and access. It helps protect sensitive information from unauthorized access by Relativity System Admins, while still allowing authorized users to access data for legitimate purposes. Lockbox is designed to protect your workspace data by preventing access by Relativity support and operations teams, even if they have administrative privileges. By default, this feature is enabled, which means that any system administrator, including those on the Relativity team, cannot see your workspace data without explicit permission.

Consider the following:

  • RelativityOne Lockbox has granular control that is managed through separate EnableRelativityLockbox and EnableCustomerLockbox instance settings. This allows for a precise configuration based on your specific needs.

Instance setting name

Description

Value Impact

EnableRelativityLockbox

Controls access to workspaces for all Relativity employees, except those explicitly granted access by the customer.

True

Prevents all Relativity employees from accessing workspaces unless they are added to workspace groups. This requires manual intervention by the customer to grant access to Relativity employees.
EnableCustomerLockbox

Controls access to workspaces for Client System Administrators.

True

Prevents Client System Administrators from accessing workspaces unless they are added to workspace groups. This requires Client System Administrators to disable Lockbox to access workspaces, which triggers alerts to be generated.
  • You can view and manage security permissions for Relativity Support team users on the security permissions page unless you choose to lock them out entirely.
  • If you want to monitor workspace actions taken by Relativity employees, you can use the Security Center's Relativity employee workspace access feature. Additionally, you can use the Lockbox access feature of the Security Center to remove Relativity employee access from your workspaces if desired.
  • When the EnableCustomerLockbox instance setting is enabled or disabled, a Security Alert is automatically generated. This helps you keep track of any changes to your workspace's security settings.

______________________________________________________________________________________________________

  • To enable Lockbox for Relativity employees and prevent them from adding themselves to workspace groups, set the EnableRelativityLockbox instance setting to "True".

  • To allow your System Administrator to access workspaces, set the EnableCustomerLockbox instance setting to "False".

  • To grant Relativity support temporary access to a workspace, you can either add Relativity support to a group that belongs to the workspace, or set the EnableRelativityLockbox instance setting to "False".

See Customer lockbox.

Customer-managed keys (CMK)

Note: This functionality is not currently available for FedRAMP customers / government entities.

Note: CMK is not currently offered as part of the Relativity PayGo model.

Customer Managed Keys (CMK) give you control over the keys that encrypt data at rest in RelativityOne by enabling you to own and control your own keys through third-party key management solutions for persistent data in RelativityOne.

The scope of the feature covers RelativityOne services that retain persistent data, which includes:

  • File
  • SQL
  • Audit
  • Analytics
  • Secret Store

Note: If you have any issues, please contact Relativity Support with “R1 – CMK – ” in the subject.

See Customer-managed keys (CMK) for more details.

User authentication

RelativityOne uses several industry-standard technologies, enabling versatile authentication options. It supports local (such as password related) or external (such as external identification providers) authentication methods. You can add and enable each type individually, as well as assigning at least one, and in some instances multiple methods, for each user.

See Authentication.

RelativityOne system access privileges

Relativity initially issues the credentials for the items below. However, after credentials are sent, you will directly manage the following access credentials:

  • VPN - password is active for 90 days. When it expires and you must reset it as the customer; you will need your original password in order to complete the password reset (or you will need to contact Support for a new temporary password).
  • Direct SQL - does not expire
  • Utility Server - does not expire

Note: When someone leaves your organization who has been issued one of these access credentials, you should open a Support ticket to have that person's user access removed. We recommend that you track who in your organization has access to these credentials, and make submitting a Support ticket part of the employee exit process.

Setting up a hybrid environment (Relativity Server and RelativityOne)

With the introduction of RelativityOne, hybrid environments (combining cloud and on-premises instances) are becoming a common deployment scenario. The Relativity hybrid model provides a compelling alternative to on-premises hosting of cases.

Hybrid environment business scenarios:

  • Your organization decided to start migrating older cases to RelativityOne
  • Your firm’s IT department then no longer has to provision more hardware for new cases
  • Simply migrate old cases to RelativityOne to free up infrastructure in your local data center

Relativity hybrid model allows you to start new cases in the RelativityOne instance with benefits such as:

  • Avoiding the hassle of provisioning hardware to support those cases
  • Viewing/accessing cases in a different instance
  • Single sign on across instances (when using OpenID Connect protocol)

Despite the benefits of this hybrid model, RelativityOne is a separate instance with a separate user store and separate credentials. You must manage user credentials across two different systems - a task that can be time consuming and prone to errors.

Refer to the following topics for more information:

Personalization

Consider the following regarding personalization in RelativityOne:

  • Custom logo - Customers can request a custom logo that will display on the login screen and optionally in the upper right corner of the instance next to the "Hi, User!" drop down from their Relativity implementation specialist or customer success manager. The logo submitted should be a maximum height of 50 pixels; width may vary dependent on the style of the logo
  • Custom URL - Relativity does not provide unique URLs for customers. Your RelativityOne URL will always be formatted as: https://<organization name>.relativity.one.

If you have questions on personalization, contact Support.

Regional date settings

Relativity now supports the modification of the default regional date format setting for customer Relativity instances (e.g., setting the regional date format to DD/MM/YYYY for an instance in Australia vs. the current default US date format MM/DD/YYYY). When completing your RelativityOne onboarding questionnaire, discuss considerations for changing regional date setting in your instance with your Relativity Implementation Specialist. If you are already a customer and want to make this change, please contact your CSM.

Once this change is made by Relativity for your instance, the following will be true:

  • Email regional date considerations:
    • Emails processed prior to a regional date format change will have a different date format in the header text than those processed after the change. For email chains with different date formats in the email (e.g., emails sent from other regions) the extracted text does not change and it’s retained simply as extracted text.
    • Email threading dates will still be impacted if the Use Email header fields setting is set to No.
  • Imaging / Save as PDF regional date considerations:
    • Images created before a regional date format change will have a different date format than images after the change.
    • DATE fields used for branding images (with designations) will always be in US date format.
    • When imaging a document, if you select “replace field codes” (which replaces auto-filled dates), and you choose a DATE field in Relativity, it will always replace the date in US format.
    • When branding during a Save As PDF action, if you select a DATE field, it will always be in US date format.

Note: Consideration should be given when importing workspaces from instances with different regional date setting as there may be inconsistent date formats with Processing or when using Save as PDF / Imaging features. Additionally, pre-Foxglove RelativityOne release, deduplication output will be inconsistent if different regional date formats were used. The hashing algorithm changed in the Foxglove RelativityOne release to ensure deduplication is not impacted when a workspace with non-US date format is restored, however manual corrective steps (including executing a script) will be required before additional data can be processed into the workspace. Please reach out to Support for information on these manual steps.

Custom application development in RelativityOne

RelativityOne platform API

The RelativityOne platform provides a rich set of APIs that enable you to enhance the functionality of the Relativity system by creating customized applications that meet the specific e-discovery needs of your business.

Refer to RelativityOne developer considerations Early Access developer considerations on the RelativityOne Platform site for more information.

Early access test environments

Sandbox

RelativityOne Sandbox refers to reusable RelativityOne environments that allow you to test SQL scripts, event handlers, API based applications, custom pages, and custom agents for both the current and Early Access (EA) release of Relativity.

Note: Sandbox is a service that you must subscribe to. Please contact your Account Manager for more details. (Sandboxes are free with 10TB and up subscriptions. Subscriptions less than 10 TB can opt to purchase Sandboxes.)

See Sandbox.

Preview

Note: As of July 2022, the Preview environment is no longer available for new RelativityOne instances. This content is intended for customers who had procured Preview before July 2022.

Preview refers to a free RelativityOne instance that gives you early access one month ahead of your RelativityOne upgrade. This enables you to identify feature changes that impact your workflows and adjust accordingly. The Relativity Preview feature, lets you try out the new version of Relativity prior to release in an environment that has the same Security and feature functionality of a RelativityOne instance.

Relativity Preview offers you the the following benefits:

  • The ability to preview workflow changes in the UI prior to a production release.
  • Seamless integration with RelativityOne production instance via User Sync and Federated Instances.
  • Preview is pre-loaded with dummy data that effectively demonstrates new Relativity features.

Note: This functionality is not currently available for FedRAMP customers / government entities.

See Preview.

System logging in RelativityOne

RelativityOne does not provide external access to logs except in Sandbox test environments; if a log is needed, we encourage you to contact Support in order to troubleshoot these sorts of issues.

RelativityOne SMTP services (e-mail)

Customers have access to an SMTP server that will send password reset / invitation emails, and other system notifications such as job notifications. These settings are not configurable in RelativityOne and the email will come from a generic relativity.one address.