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.

This page contains the following information:

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.

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.

    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.

    Note: **Note the following details regarding our support of Office 2016:

    • You must install a version no earlier than 16.0.4783.1000 (the December 2018 update for Microsoft Office).
    • We recommend that you upgrade Invariant prior to upgrading Microsoft Office. If you upgrade Microsoft Office first, your workers will fail to validate, and Invariant won't run until you upgrade it.
    • We recommend that you uninstall Microsoft Office 2013 before installing Office 2016.
    • OneNote 2016 can't export files containing more than 300 pages to PDF. Processing extracted text will fail in this case, as well.
    • With the introduction of Office 2016 support, the font used to image text files is now Google's Noto Sans; previously, this was Microsoft's Arial Unicode.

    Note that the worker, database, and queue manager don’t 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 2019 or Windows Server 2016
    Queue manager
    • Windows Server 2019 or Windows Server 2016
    • .NET Version 4.7 or .NET Version 4.6.2

    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 aren't required to install the Invariant database and Queue Manager on the same server, but you have the option of doing so. The server(s) 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 Relativity 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 Relativity 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 Internet Explorer Enhanced Security Configuration.
    • Disable User Access Control (UAC) and the Windows Firewall.
    Queue Manager None
    Workers
    • Enable the Desktop Experience Windows Feature.
    • Disable Internet Explorer Enhanced Security Configuration for Administrators and Users.
    • 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 doesn't contain data that grows with use.

    Update the permissions on the BCPPath file share

    In the Failover Cluster Manager on the database server, you must update the permission settings for the BCPPath file share to that ensure the case creation occurs properly on the failover cluster. When you create the BCPPath on a clustered disk, verify that Enable continuous availability option isn't selected under Settings on the BCPPath Properties page. For more information, see Pre-installation.

    See the sample settings on the following screen shot:

    (Click to expand)

    BCPPath settings in the Failover Cluster Manager

    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 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.
    1. 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. Anonymous auth enabled for webapi

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

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

      2. 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 2016 Professional (32-bit), 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 2016 Professional (32-bit). On the Installation Options tab, point to Office Shared Features. Point to Converters and Filters, and select Run all from My Computer.