System requirements

These system requirements contain detailed information about the software and hardware you use to host Relativity in your environment and in the cloud. These requirements also provide various recommendations for configuring a new deployment of Relativity, as well as scaling your environment as the number of users and the amount of data continue to grow.

This page contains the following sections:

See these related pages:

Infrastructure overview

Relativity is designed with a scalable infrastructure that you can tailor to the requirements of your environment. It is developed on the .NET framework with a Microsoft SQL Server back-end. As illustrated in the following diagram, all areas of the platform are scalable providing support for any hardware vendor, hypervisor, and storage protocol.

Web server

The Web Server is the gateway for all users to access Relativity. It authenticates the user with the system, contains APIs for searching and third-party applications, transfers documents to the end user in the Relativity Viewer, and is responsible for communications during imports and exports in workspaces. There are different mechanisms for authentication into the system including forms, active directory, two-factor, SAML 2.0, and OpenID Connect.. User sessions can be load balanced with the included Relativity User Load Balancer or via available hardware load balancing solutions.

Agent server (core)

Agents in Relativity are responsible for running all background processing tasks. When a user submits a job, such as a Production or OCR job, the associated agent(s) will pick up the job and complete the work. The agents run under a Windows Service and often require various levels of CPU, RAM and I/O, depending on the job type. The agents can be scaled vertically and horizontally to accommodate organizational needs.

Agent server (conversion)

In Relativity 9.6 and above, viewer conversion jobs are handled by the Conversion agents. Any Relativity agent server designated as a conversion agent server should only have one conversion agent deployed. Conversion jobs are multi-threaded and one conversion agent may utilize all available processor cores on a server.

For more information, see Required configurations for new deployments.

Agent server (dtSearch)

dtSearch queries are multi-threaded and spawn as many threads as there are sub-indexes or cores — whichever number is lowest will be the constraint. One dtSearch search agent may be able to utilize all available processor cores on a server. Therefore, each Relativity agent server that is designated to be a dtSearch search agent server should only have one dtSearch search agent and nothing else.

Agent server (PDF)

PDF worker agents are multi-threaded. The number of threads are determined by the number of processors on the VM divided by 2 (e.g. an 8 core VM results in a PDF worker with 4 threads).

For optimal performance Relativity recommends that dedicated agent VMs are created with a maximum of 2 PDF worker agents per machine. This will allow the worker agents to maximize resource usage without performance degradation. If PDF worker agents are added to a shared agent server, only one should be added to limit the impact to other agents on the server.

SQL Server (workspaces)

This SQL Server is where the structured text and metadata resides for the documents. Each Relativity workspace is represented by its own SQL Server database. Environments may have one or more SQL Servers. In addition to workspace databases there are Relativity system databases present on each server that contain tables for system configurations, agent job queues, users/groups, etc.

SQL Server (Invariant/Worker Manager server)

Relativity processing has individual store databases that correspond to each Relativity workspace database with processing enabled. Total memory and processor requirements for this role are not as demanding as the SQL Servers that house workspace databases. This server is also used for native imaging and save as PDF request management.

Worker

The ‘Worker’ role is responsible for handling enhanced native imaging and processing jobs. Relativity has placed a hard cap on the amount of threads that each Worker server is allowed to spawn, the hard cap is 16 threads. Each processor core and 2GB RAM will create two threads. Therefore, it is suggested that 8 logical cores and 16GB RAM be allocated to each worker server to get the most throughput.

Note: Refer to the Processing page for a breakdown of performance metrics.

Secret Store

The Secret Store is a required component that provides secure, auditable storage for Relativity secrets. A secret could be user credentials, a database connect string, an instance setting that contains confidential information such as your SMTP credentials, or a TLS certificate. All confidential information is stored securely in the Secret Store database that can be accessed only from authenticated servers.

For more information, see Relativity Secret Store.

Message broker

Relativity utilizes RabbitMQ as a message delivery service that communicates information about agent jobs to different application components. This infrastructure feature supports this communication by routing messages between application components. For example, Relativity uses RabbitMQ for submitting conversion jobs to agents and returning converted documents.

For more information, see Relativity Service Bus documentation.

Analytics

The analytics server is responsible for building and storing the conceptual indexes in the environment. Once an index is built, the server is also used to run the conceptual features such as categorization and clustering. In addition to conceptual indexing, structured analytics sets are run on this server for textual analysis features such as email threading or language identification. The indexes and structured analytics sets are stored on disk in a configurable location.

File server

This server may not be required depending on the available storage. Relativity doesn't install any software on a file server for Relativity. Relativity just needs to know where the files (Natives/Images) live and the web servers need to be able to access those locations. The same applies to dtSearch, Analytics index, and viewer cache location(s).

Data Grid master node

This is the server within a cluster that manages changes across the entire cluster.

Data Grid client node

This is the server that serves as the gateway through which data enters a cluster. When there is more than one in an environment, these can be thought of as load balancers which service requests for data.

Data Grid data node

This is the server that stores data within a cluster.

Scalability

Required configurations for new deployments

Infrastructure configuration

Relativity supports the following technologies as part of its infrastructure configuration:

  • Virtualization

    All Aspects of Relativity can be virtualized. Some roles are more RAM and CPU intensive as others. You have to make sure when virtualizing Relativity that you do not overcomitt the RAM and CPU on a virtual machine to host ratio.

  • High Availability (HA)
    Relativity supports SQL Server Failover and File Server Clustering along with available hypervisor solutions.
  • Disaster Recovery (DR)
    Relativity supports Microsoft SQL Server mirroring, log shipping, and SAN replication technologies. These approaches typically require manual failover and increased downtime.
  • Web Server Load Balancing
    Relativity supports only single affinity in Windows Network Load Balancing (NLB). The Relativity User Load Balancer (RULB) provides the ability to distribute the user load evenly.
  • Perimeter Networking (DMZ)
    Relativity requires certain ports to remain open for proper server communication. For more details, download the Relativity Infrastructure Ports Diagram from the Relativity Community. Note that you must have a valid username and password to download this content.

Guides for infrastructure management

Review the following guides to become familiar with best practices for managing the Relativity infrastructure:

Software requirements

Relativity has specific software requirements for servers or virtual machines, user workstations, and the Relativity Desktop Client. The requirements for servers differ by the role assigned to them in your system configuration.

Note: Make sure that you install the latest service packs and updates for your Windows Operating system and the latest service packs and cumulative updates for your SQL Server. However, compatibility for higher .NET versions is not guaranteed and we do not recommend installing higher .NET versions than what is listed as required by your Relativity version.

System (servers or virtual machines)

Note: Relativity is compatible with local settings Only for webservice servers.

The general software requirements for servers and virtual machines include Microsoft Windows Server and .NET technologies. Microsoft Office and other applications are required for worker servers.

The following table provides software requirements by server role.

Server Role

Software Requirements

Web
  • Windows Server 2019, Windows Server 2016, or Windows Server 2012 R2
  • .NET Version 4.7 or .NET Version 4.6.2
  • .NET Version 3.5
Agent
  • Windows Server 2019, Windows Server 2016, or Windows Server 2012 R2
  • .NET Version 4.7 or .NET Version 4.6.2
  • .NET Version 3.5
Analytics
  • Windows Server 2019, Windows Server 2016, or Windows Server 2012 R2
  • .NET Version 4.7 or .NET Version 4.6.2

  • .NET Version 3.5
  • Java
Secret Store
  • Windows Server 2019, Windows Server 2016, or Windows Server 2012 R2
  • .NET Version 4.7 or .NET Version 4.6.2

Message broker
  • Windows Server 2016, Windows Server 2019
  • .NET Version 4.7 (compatible with Relativity 9.5.259.2 and higher) or .NET Version 4.6.2 (required in 9.5.196.102 and higher)
  • RabbitMQ - For more information, see RabbitMQ.
SQL
  • Windows Server 2019, Windows Server 2016, or Windows Server 2012 R2
  • SQL Server 2017 or SQL Server 2019
    • SQL Server 2019 requires Windows Server 2016 or 2019. It is not compatible with Windows Server 2012.
    • Relativity only supports an in-place upgrade from SQL Server 2016 to SQL Server 2017. For any other SQL Server upgrade please follow the EDDS migration Guide.
  • .NET Version 4.7 or .NET Version 4.6.2
  • .NET Version 3.5
Worker
Software Description Required for system installation?
Windows Server 2019 or Windows Server 2016 Required server software. Yes
  • .NET Version 4.7 or .NET Version 4.6.2
  • Required server software. Yes
    Desktop Experience (Windows Server feature) Required server software. Yes

    Microsoft Office 2016 Professional (32-bit)

    Note: *Some features found in files created in different versions of Office may not be available or render correctly when processed or imaged using a different version than the file was originally created in. For more information about features differences between Office versions, please consult the appropriate Microsoft documentation.

    This includes:

    • Excel – used for Processing and Native Imaging of most spreadsheet based documents (xlsx, xlsm, xlsb, odc, ods, etc.).
    • Word – used for Processing and Native Imaging of DOCX, DOCM, DOTX, DOTM, DOC, etc.
    • Powerpoint – used for Processing and Native imaging of PPTX, PPTM, PPSM, POTX, POTM, etc.
    • Processing and native imaging of PST, OST, etc.
    • OneNote – used for Processing and Native Imaging of ONE and TMP files, etc.
    • Publisher – used for Processing and Native Imaging of PUB files, etc.

    Note: The Courier New font must be installed on your machine. This font is installed by default when you install Microsoft Office, in which case you must ensure that you don't remove it.

    Note: Relativity doesn't support add-ins for Microsoft Office.

    Yes

    Microsoft Works 6–9 File Converter

    The Microsoft Works Converter is also required. You can download it from the Relativity Community here.

    Yes

     

    Microsoft Visio 2016 Professional or Standard SP2 (32-bit)

    Used for processing and imaging VSD, VDX, VSS, VSX, VST, VSW files.

    No

    • This is only required for processing and imaging VSD, VDX, VSS, VSX, VST, VSW files.. You can still install processing without this component, but you won't be able to process or image those files without it.
    Microsoft Project Professional 2016 (32-bit) Used for processing and native imaging of MPP files.

    No

    • This is only required for processing and imaging MPP files. You can still install processing without this component, but you won't be able to process or image MPP files without it.

    (optional) Lotus Notes v8.5 and higher

    • Lotus Notes v8.5.3 with Fix Pack 6
    • Lotus Notes v8.5.2 with Fix Pack 4
    • Lotus Notes v9.0
    • Lotus Notes v9.0.1
    • Lotus Notes v10.0.1

    It is recommended that you install Lotus Notes 9 or higher on your workers, because Lotus Notes version 8.5.x cannot read certain Lotus 9 databases. Please note that some Lotus 9 databases cannot be opened in 8.5.x and will generate an error during processing.

    No

    • Beginning in Relativity 10.1.290.1, Lotus Notes is no longer required and is now an optional installation.
    • After you install Lotus Notes on the worker, you should restart the worker machine, but there is no need to restart the queue manager service.

    Solidworks eDrawings Viewer 2017 (64-bit) version only with SP5 or above.

    Solidworks eDrawings Viewer 2018 (64-bit)

    Solidworks eDrawings Viewer 2019

    Solidworks eDrawings Viewer 2020

    Used for processing (text extraction) and imaging for CAD files. This is the only optional component.

    • To download the viewer, go here.
    • Solidworks eDrawings Viewer 2017 SP5 and above is supported.

    No

    • The Solidworks eDrawings Viewer is not a pre-requisite for general use of Relativity Processing. Solidworks is only required for performing native imaging and text extraction on any supported CAD files in your data sources. You should install it only on the worker designated to perform these types of jobs. If you attempt to process a CAD file without the Solidworks viewer installed, you receive a simple document-level error prompting you to install it. Once you install the Solidworks viewer, you can retry that error and proceed with your processing job.

    JungUm Global Viewer v9.1 or higher

    This is required for processing and imaging GUL files (for Korean documents).

    No

    • After you install the JungUm Global Viewer on the worker, you should restart the worker machine, but there is no need to restart the queue manager service.

    * Microsoft Project and Visio are not required to install and use Relativity Processing. These components are only required if you intend to process Project and Visio files, specifically.

    Workstations (end-user PCs)

    In Relativity, end users perform their reviews on workstations. Each workstation should be configured with a browser in which to use the Relativity web application, an operating system on which to run the Relativity Desktop Client, and the currently supported version of .NET.

    Supported browsers for Relativity Web application

    Supported operating systems - Relativity Desktop Client

    Supported operating systems - servers and Relativity Desktop Client

    Supported .NET version

    • Microsoft Internet Explorer 11.x*
    • Note: As of August 31, 2017, we no longer support Internet Explore (IE) 10. Please upgrade to a compatible version of IE 11.

    • Google Chrome latest version (on both PC and Mac)
    • Apple Safari v11+ (Mac OS X 10.9)
    • Apple Safari v11+ (Mac OS X 10.10)
    • Firefox latest version (on both PC and Mac)*
    • Windows Server 2012 R2 (64-bit)

    • Windows 10

    • Windows 8.1

    • Windows 8 Desktop Mode (PC)

    • Windows 7

    • Windows Server 2019
    • Windows Server 2016
    • Windows Server 2012 R2
    • .NET Version 4.7 or .NET Version 4.6.2

     

    Note: SQL Server 2019 requires Windows Server 2016 or 2019. It is not compatible with Windows Server 2012.

    Supported .NET version

  • .NET Version 4.7 or .NET Version 4.6.2
  • Relativity Desktop Client

    The Relativity Desktop Client (RDC) is a utility used for importing and exporting documents, images, natives, and productions. This utility requires the following software:

    The Relativity Desktop Client requires Microsoft .NET 4.6.2 or above and Visual C++ 2015 Redistributable Update 3 RC.

    Your operating system determines whether you need to download the 64-bit or 32-bit version of these applications:

    • If you're running a 32-bit machine, you must install the RDC 32-bit and the Visual C++ 2015 Redistributable Update 3 RC. For more information, see Microsoft Visual C++ 2015 Redistributable Update 3 RC.
    • If you're running a 64-bit machine, you want to install the RDC 64-bit and the Visual C++ 2015 Redistributable Update 3 RC You may notice a significant improvement in the speed of the RDC with the 64-bit version. However, a 64-bit machine can have both the x86 and x64 redistributables installed at the same time, and it can run the 32-bit or 64-bit version of the RDC.

    Licensing Microsoft products

    Relativity requires Microsoft Windows and Microsoft SQL Server, both of which you need to license through Microsoft or one of their resellers. If using Relativity Processing or Native Imaging, you also need to license Microsoft Office, Visio, and Project through Microsoft or one of their resellers.

    If Relativity is hosted for external customers, you may need to license Microsoft products through Microsoft’s SPLA (Service Provider License Agreement). You can find more information about Microsoft’s SPLA program on Microsoft’s Hosting site.

    Note: We recommend contacting Microsoft, or one of their resellers, for guidance on the licensing options available.