Worker manager server pre-installation steps

Before you begin installing the worker manager server, you must update your environment with the required security and other configuration settings. See System requirements.

Install Relativity

Before you install the worker manager server, make sure that you install Relativity. For more information, see Relativity installation.

Required software on the worker

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.

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	Windows Server 2016, 2019, 2022
Queue manager	Windows Server 2016, 2019, 2022 .NET Version 4.7.2, 4.8, or 4.8.1

Required permissions

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.

Database

The following permissions are required to install the Invariant Database:

• Domain Rights—the account used for installing the database must have read and write permissions to the path entered in the Invariant Worker Network File Path share in the installation wizard.
• Server Administrator Rights—the account used for installing the database must have the following server administration rights:
  • Domain or Workgroup Member—if the server is a member of a Domain, this account must also be a Domain user. If the server is a member of a Workgroup, this account must be a local user.
  • Local Administration Rights—the account used for installation must have local administration rights on the server. It can also be in the Domain administrator group with local administrator rights on the server.
• SQL Administrator Rights—the installer can use Windows or SQL authentication to log in to the SQL Server. This account must have sysadmin permissions on the SQL Server.

Queue Manager

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:

• Server Administrator Rights—the Relativity Service account must have the following server administration rights:
  • Domain or Workgroup Member—if the server is a member of a Domain, the Relativity Service account must also be a Domain user. If the server is a member of a Workgroup, the Relativity Service account must be a local user.
  • 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.
• SQL Administrator Rights—the Queue Manager Service account runs as the Relativity Service account, and uses the EDDSDBO account to log in to the SQL Server. Neither account requires administrator rights to the SQL Server.

Workers

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:

• Domain Rights—the Relativity Service account must have read and write permissions to the path entered in the Invariant Worker Network File Path share during installation.
• Server Administrator Rights—the Relativity Service account must have the following server administration rights:
  • Domain or Workgroup Member—if the server is a member of a Domain, the Relativity Service account must also be a Domain user. If the server is a member of a Workgroup, the Relativity Service account must be a local user.

  • 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:

• The user account must be able to read and write local temporary files.
• The user account is not required to have permissions to access a file share or network.
• A single account name and password will be used for all workers in use by Invariant.
• The user account name and password must be stored in the Relativity Secret Store for Processing access. For more information on storing this information, see Installing the worker manager serverInstalling the worker manager server.

Environment configuration steps

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	Disable User Access Control (UAC) and the Windows Firewall. Disabling UAC on the worker server suppress pop-ups from the application in which the processing engine opens files. Set Windows Updates to download, but allow you to choose whether to install. You can set this option through the Control Panel under System and Security.

Database file and network folders setup

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.

• MDF File Folder—create this folder as a local directory on the SQL Server. It is used for Invariant and Relativity Imaging database files. You can add this folder to a different drive than Invariant database, but it must be local to the machine.
• LDF File Folder—create this folder as a local directory on the SQL Server. It is used for Invariant and Relativity Imaging log files. You can add this folder to a different drive than Invariant database, but it must be local to the machine.
• Network Directory—create a local network directory on the SQL Server. The Relativity Service account must have read and write permissions to this network share. The installer adds files required by the Invariant Workers to this folder. You will enter the path to this directory in the Invariant Worker Network File Path box during installation.

Note: The Invariant worker share should be around 10 GB, since it does not contain data that grows with use.

Enabling token authentication

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:

1. While in Home mode, navigate to the Instance Settings sub-tab.
2. In the default All Instance Settings view, enable filters and enter ProcessingWebAPIPath in the Name field.
3. Click the ProcessingWebAPIPath name and click Edit in the instance setting layout.
4. In the Value field change the existing ProcessingWebAPI URL to the RelativityWebAPI URL.
   

5. Click Save.

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:

1. Open IIS.
2.  To enable anonymous authentication, complete the following steps:
   1. Click on the RelativityWebAPI site.
   2. In the Features view, click Authentication.
   3. In the Authentication view, right-click on Anonymous Authentication and click Enable.

   
   

   4. To update the web.config file, locate it in the following folder:

      C:\Program Files\Relativity Corporation\Relativity\WebAPI

   5. Open the file in an editor. Update the authentication mode and authorization sections as follows:

      <system.web>
           <authentication mode="None" />
           <authorization><allow users="*" />
      </authorization>
      </system.web>

3. Restart IIS.

Installation setting for Microsoft Office Professional

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.

Installing Microsoft Visual C++ Redistributable Packages

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/	√	√	√	√