

Before you begin installing the worker manager server, you must update your environment with the required security and other configuration settings.
Before you install the worker manager server, make sure that you install Relativity.
The following software is required on the worker server for processing or native imaging. While you may not being processing files corresponding to some of the required software listed below, note that some of those components are still required for system use.
Software | Description |
Required for system installation? |
Required for Native Imaging/Processing |
---|---|---|---|
Windows Server 2022, Windows Server 2019, Windows Server 2016 |
Required server software. The Windows Print Spooler service must also be enabled on all Worker Server machines in the environment. Windows Server Core is not supported. |
Yes | |
.NET 4.7.2, 4.8, or 4.8.1 .NET 3.5 |
Required server software. | Yes | |
Microsoft Office 2016 Professional (32-bit), Microsoft Office 2016 Professional Plus (32-bit) Note the following:
|
This includes:
Relativity does not support add-ins for Microsoft Office. |
No |
Yes You are able to install the worker manager server without first installing Office. 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.
|
Microsoft Works 6–9 File Converter | The Microsoft Works Converter is also required. You can download it from the Relativity Community here. | No | Yes |
Microsoft Visio 2016 Professional or Standard SP2 (32-bit) | Used for processing and imaging .vsd, .vdx, .vss, .vsx, .vst, .vsw files. |
No |
No Only required for processing and imaging .vsd, .vdx, .vss, .vsx, .vst, .vsw files. You can still install processing without this component, but you will not 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 |
No Only required for processing and imaging .mpp files. You can still install processing without this component, but you will not be able to process or image .mpp files without it. |
(Optional) Lotus Notes v8.5 and higher
|
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 |
No When you install Lotus Notes, you need to restart the worker machine. There is no need to restart the queue manager service. |
|
Used for processing, text extraction, and imaging for CAD files.
|
No
|
No 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 |
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 |
Note that the worker, database, and queue manager do not all require the same number of software components. The following table breaks down which part of the processing infrastructure requires which software component.
Processing infrastructure component | Software component |
---|---|
Worker | See Required permissions. |
Database |
|
Queue manager |
|
You must set the security permissions required for installing Invariant components. The Relativity Service account must have these permissions, as the Queue Manager and workers are required to run under this account.
You are not required to install the Invariant database and Queue Manager on the same server, but you have the option of doing so. The servers that you install to must have the permissions listed under the Database and Queue Manager sections, respectively.
The following permissions are required to install the Invariant Database:
The Queue Manager is required to run under the Relativity Service account. This account must have the following permissions on the machine where the Queue Manager is installed:
Workers are required to run under the Relativity Service account. This account must have the following permissions on the machine where a worker is installed:
Local Administration Rights—the Relativity Service account must also have local administration rights on the server. It can also be in the Domain administrator group with local administrator rights on the server.
Note: The Relativity Service account must have rights to the network directory created for the database installation, as well as to other network locations used to store files, which the workers need to access.
A local user account may also be configured on each worker machine to allow secure file conversion operations for Processing. Note the following details:
Before running the Invariant installer, you must perform the following steps to modify your environment.
Component | Environment Configuration Settings |
---|---|
Database |
Disable User Access Control (UAC) and the Windows Firewall. |
Queue Manager | None |
Workers |
|
During the installation of the Invariant Database and Queue Manager, you need to provide the file paths to the folders used for database and worker files. Create the following folders before you begin the installation.
Note: The Invariant worker share should be around 10 GB, since it does not contain data that grows with use.
You must enable token authentication on your web server for certain Relativity features, such as the worker manager server, which requires this authentication type for processing.
You must also edit the ProcessingWebAPIPath Instance Setting. This setting identifies the URL that directs to the Relativity token-authenticated endpoints that Invariant uses to process and image files. Invariant requires this URL and a Relativity admin must enter it.
To do this, perform the following steps to comply with this change:
Depending on what Relativity version you're installing or upgrading, you may need to enable the RelativityWebAPI setting in IIS for Anonymous authentication in order to publish documents to a workspace.
To do this, perform the following steps:
C:\Program Files\Relativity Corporation\Relativity\WebAPI
<system.web> <authentication mode="None" /> <authorization><allow users="*" /> </authorization> </system.web>
When you install Microsoft Office, you must use the following setting to ensure that Invariant can extract text and create TIFFs form WordPerfect documents.
Run the installer for Microsoft Office. On the Installation Options tab, point to Office Shared Features. Point to Converters and Filters, and select Run all from My Computer.
The following table breaks down which versions of Microsoft Visual C++ are required for which versions of Relativity/Invariant. Note that you are required to install each version of Microsoft Visual C++ only if you are upgrading to the Relativity/Invariant version listed and not if you are installing it for the first time.
Required Microsoft Visual C++ version (Redistributable x86 and x64) | ||||
---|---|---|---|---|
Relativity/Invariant version | 2010 | 2012 | 2013 | 2015 |
Server 2022/7.1.431.1 | √ | √ | √ | √ |
Server 2023/7.3.841.24 | √ | √ | √ | √ |
Server 2024/ | √ | √ | √ | √ |
On this page
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!