Pre-installation

You must complete the pre-installation process to ensure that your environment is configured with the software, user accounts, directories, and other prerequisites required for an initial installation of Relativity. In addition, the Relativity service bus requires that you install and configure Service Bus for Windows Server.

As you set up your environment, use the Installation accounts and directories listto record information about your environment configuration that the installation process requires.

For additional information, see System Requirements and Environment optimization guide. 

Note: If you use a firewall, refer to the Ports Diagram in the Relativity Community to ensure that you configure your firewall correctly with Relativity.

This page contains the following information:

Windows updates

Install the latest Microsoft Windows Server Service Pack on all Relativity servers.

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. Furthermore, install any smaller security patches, Windows updates, etc. at your own discretion. We only test major service packs, not every Microsoft update. Deploy any patches to your test instance of Relativity first. Ensure that a rollback plan is in place if you discover any issues during deployment.

Ensure you disable the option to Install updates automatically on all Relativity servers. Apply any required updates during a planned maintenance window.

After installing Windows updates, reboot your machines before attempting to install Relativity. Complete this step to ensure that all Relativity components are properly installed. Incomplete Windows updates lock system files, which may cause silent failures and prevent the proper installation of Relativity components.

Required certificates for Relativity

Relativity verifies that all HTTPS services running in your environment have a trusted certificate. The HTTPS services run on the following components of your Relativity installation, so they require that you install valid certificates:

  • Analytics server
  • Components that connect to the Services API
  • Components that use HTTPS to connect to the REST API
  • Service Host Manager on all web and agent servers for running application-based Kepler services
  • Viewer
  • Web servers

Note: For more information about required certificates and their corresponding Relativity servers, see All certificates used by Relativity servers on the Community site.

You need to add certificates to any server in your Relativity environment that is accessed by an HTTPS service. By adding these certificates, you won't see warning messages and insecure-connection icons displayed as you navigate to different components of your Relativity site. Use these guidelines for installing certificates in your Relativity environment:

  • If your Relativity site is exposed to the internet, install a certificate on any server that users can access with HTTPS services.
  • If Relativity users access your web server with different internal and external names, install a second certificate for the internal name.
  • If you use different internal and external URLs bound to the same IP address on your servers, install a second certificate on the server for the internal IP address. You may want to consider using Server Name Indication (SNI), which is an extension to the Transport Layer Security (TLS). For more information, see IIS 8.0 Server Name Indication (SNI): SSL Scalability on the Microsoft website.

    Note: If you don't want to use SNI in your environment, then configure separate IP addresses on your web servers for internal and external URLS. You might not be able to use SNI if your IIS or web browser versions don't support it.

For information about generating certificates for servers in your Windows domain, see Public Key Infrastructure Design Guidance on the Microsoft site. We recommend that you use the Standalone offline root CA referenced in this article.

For information on setting up HTTPS for the Service Host Manager on web and agent servers, see Service Host Manager.

For information on enabling HTTPS for Invariant Kepler Services, see Hosting Invariant Kepler services in HTTPS.

Creating a self-signed certificate in PowerShell

To create a self-signed certificate with PowerShell 4.0, perform the following steps:

  1. Open PowerShell.
  2. Ensure you’re running PowerShell in administrator mode (or else you’ll receive an error when attempting to create the certificate).
  3. Import the PKI module into PowerShell via the following command:
  4. Import-Module PKI
  1. Create the certificate through the following commands, where "FQDN" is the fully-qualified domain name.
  2. Note: If you're performing these steps as part of enabling HTTPS for Invariant Kepler Services, the fully-qualified domain name will be for the Queue Manager. For details, see Hosting Invariant Kepler services in HTTPS.

    Set-Location Cert:\LocalMachine
    New-SelfSignedCertificate -DnsName "FQDN" -CertStoreLocation Cert:\LocalMachine\My
  1. Confirm that you’ve created a certificate in the personal store. Your PowerShell display should resemble the following image:
  2. Create (or designate) a folder in your C drive to which you want to export the certificate, which you’ll do through the final “Export-Certificate” prompt included below. You’ll receive an error if that file path doesn’t exist.
  3. Export the certificate through the following commands:
  4. Set-Location Cert:\LocalMachine\My
    • Doing this sets your location to the folder you just created the certificate in.
    Get-ChildItem
    • This displays the thumbprint of all certificates in the folder you just created, including the one you just added. Make sure to copy the signature of the certificate you created and paste it into the following command.
    Export-Certificate -Cert (Get-ChildItem –Path Cert:\LocalMachine\My\CertificateSignature)  -FilePath C:\Temp\SelfSignedCert.cer -Type CERT
    • Make sure you pasted the certificate signature you copied after running the Get-ChildItem command into this command, specifically in place of "CertificateSignature" above.
  1. Confirm that you successfully exported the certificate you created. Your PowerShell display and corresponding folder should resemble the following image:

Certificate requirements for Service Bus for Windows Server

The Relativity service bus requires the installation of Service Bus for Windows Server as a prerequisite. To facilitate secure communication, Service Bus for Windows Server requires a certificate. You can use one of the following options for obtaining a trusted certificate:

  • Use an existing certificate - You may already have a certificate for externally facing web servers. If the domain name for the certificate matches the fully qualified domain name (FQDN) of the service bus server, you can use this same certificate for both the web server and the service bus.
  • Issue a certificate with an internal certificate authority - If you have access to an internal certificate authority (CA), issue a certificate with the internal FQDN of your service bus server. The certificate must include the following information:
    • For any certificate, either the Subject Name, Subject Alternative Name, or both must be valid for each host in the farm.
    • Private and public key
    • Valid start date, end date, and trust chain
    • AT_KeyExchange set
    • Corresponding CRL list for the signing authority
  • Auto-generate a certificate - You can use the Service Bus Configuration tool to auto-generate the required certificate when you configure a new farm. If you use an Auto-Generated certificate, each host must be on the same domain. For more information, see Configuring Service Bus for Windows Server.

User and group accounts

Configure the following user and group accounts in your environment.

Relativity service account

Make sure that the Relativity services account has local administrator privileges on each of the servers where you want to install Relativity, since you must log in under this account when installing this software. You can find additional requirements for this account under the sections describing how to configure specific servers. For additional information about this account, see Relativity service account information.

The Windows Service Component and the Relativity COM Plus Component run under the Relativity Service Account. Verify that this account is configured as follows:

  • Create account in Active Directory.
  • Add account to the Administrators group on all machines running Relativity components.
  • If using a workgroup, verify that the account has identical credentials on all Relativity servers. Contact the Client Services team for additional information about configuring workgroups.

Database server setup

Set up the database server by completing the steps in this section.

Required software

The following software must be installed on the database server:

  • Windows Server 2016 or Windows Server 2012 R2
  • SQL Server 2012, SQL Server 2014, or SQL Server 2016
  • .NET Version 4.7 or .NET Version 4.6.2
  • .NET Version 3.5

Fix for Microsoft KB3138319, KB 3151109 and KB3120595:

  • Cumulative Update 11 for SQL Server 2012 SP 2
  • Cumulative Update 5 for SQL Server 2014 SP1
  • Cumulative Update 13 for SQL Server 2014

Enable Microsoft DTC

Microsoft DTC must be enabled on the SQL Server along with the following configuration changes:

  1. Add the Application Server role and select Distributed Transactions. Select Incoming Remote Transactions and Outgoing Remote Transactions.
  2. Note: As of Windows Server 2016 the Application Server role has been deprecated. Use the Distributed Transaction Coordinator, if it is not present on your machine download the Microsoft Distributed Transaction Coordinator (MSDTC) 2016 Management Pack for Microsoft System Center located here, download.

  3. Type dcomcnfg on your Start menu and press Enter to open Component Services.
  4. Expand Component Services > Computers > My Computer > Distributed Transaction Coordinator.
  5. Right-click Local DTC and click Properties.
  6. Click the Security tab.
  7. Select the following check boxes:
    • Allow Remote Clients
    • Allow Inbound
    • Allow Outbound
  8. Click Apply.
  9. Click Yes to restart the MSDTC service.
  10. Click OK.

Assign admin permissions to the Relativity service account

You must configure permissions for the Relativity service account on the SQL Server as part of the database setup process. Make sure that the Relativity service account has local administrator and Sysadmin permissions on the SQL Server.

Create SQL Server login

The following login must be added to the SQL Server environment. Set this account to Never Expire and Not Enforce Password policy.

Note: The Relativity installer creates this SQL Server account if it doesn't already exist.

The EDDSDBO account is the login used by the owner of all objects in the EDDS system databases. Follow these guidelines for configuring this account:

  • Authenticate this user with SQL Server Authentication.
  • Give this account only the following server roles:
    • bulkadmin
    • dbcreator
    • public
  • If you have multiple SQL Servers, create this account on each server with the same name, permissions, and credentials.
  • Make sure that password for EDDSDBO account doesn't contain an equals sign (=), carats (< or >), parenthesis, or curly braces ( { or } ).

Set authentication mode

After creating a SQL Server login, you must set the Windows authentication mode property on the server.

Complete the following steps to set the authentication mode:

  1. Log in to Microsoft SQL Server Management Studio.
  2. Right-click on your server in the Object Explorer, and then click Properties in the menu.
  3. On the Server Properties dialog, click the Security page.

    (Click to expand)

    authentication setting for SQL server

  4. Under Server authentication, click SQL Server and Windows Authentication mode.
  5. Click OK.

Create BCP share

Create a directory on the SQL Server in a location where the Relativity Service Account can read and write. In addition, give SQL services permissions to read from this directory. For more information about transferring data with BCPPath, see RDC transfer modes. Follow these guidelines for setting up this directory:

  • Make sure that this directory is an actual folder, not merely a drive letter.
  • Confirm that the account running SQL has access to this directory. If it doesn't have access to this folder, it can't create new cases. This directory is used for temporary files during imports, exports, case creations, and dtSearch queries.
  • Place this share on the drive housing the Backup files for optimal performance. This share should be named BCPPath in every instance.
  • If you have multiple SQL Servers, create this share on each server and use the BCPPath as the share name on all servers.
  • Make sure the account running the SQL services has rights to the BCPPath. Bulk import fails when this account doesn't have these rights.

Note: Consider setting up an SQL Service Account (that is a domain account with local admin rights). You should review the security requirements of your organization before setting up this account. To create a SQL Server Service account available from Microsoft, see Configure Windows Service Accounts and Permissions.

Complete the following steps to share the folder:

  1. Right-click the folder and go to Properties.
  2. Open the Sharing tab and click Share.
  3. Enter the Relativity Service Account name (domain\account), and click Add.
  4. Select the service account on the share list and set the Permission Level to a minimum of Read/Write.
  5. Click Share.
  6. When the share completes, click Done.
  7. On the Document Properties dialog, select the Security tab.
  8. Verify that the Relativity Service Account has Full Control security permissions to the folder itself.

Update the permissions on the BCPPath file share

In the Failover Cluster Manager, you must update the permission settings for the BCPPath file share to 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. See the sample settings on the following screen shot:

(Click to expand)

BCPPath settings in the Failover Cluster Manager

Note: You must configure this setting only for SQL Server 2012, 2014 and 2016.

Optionally configure an authentication token-signing certificate

When you run the Relativity installer, it automatically adds an authentication token-signing certificate, named RelativityIdentityCertificate, to the certificate store on your primary database server. However, you also have the option to use your own certificate rather than the one created by the Relativity installer.

Note: You only need to install an authentication token-signing certificate if you don’t want to use the default certificate called provided by the Relativity installer.

Before you begin installing Relativity, you may want to configure the token-signing certificate in the store on your primary database server. The other servers in your Relativity installation automatically retrieve this certificate information from the EDDS database server, so you don’t need to configure their certificates individually.

Note: For a clustered environment, you need to export a copy of your RelativityIdentityCertificate from the primary database server, and install the certificate to each database server hosting the EDDS.

Pre-installation steps for a token-signing certificate

You may want to install your custom token-signing certificate on the database server before you install Relativity in your environment. However, you can also complete these steps after installation.

Use this procedure to configure your certificate:

  1. Obtain a signed certificate and install it on the certificate store on your primary database server.
  2. Copy the thumbprint of the certificate for later use. You need this value to update the instance setting after you install Relativity. See Post-installation steps for a token-signing certificate.
  3. Install Relativity on the database and other servers. For more information, see Relativity installation or Upgrading your SQL Server .

After you install Relativity complete the steps in Post-installation steps for a token-signing certificate.

Web server setup

This section describes how to prepare your web server for installing Relativity. Install the following software on the web server:

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

Setting IIS options

Make these updates on all web servers in your Relativity installation:

  1. Install the required versions of the .NET Framework Full Profile on all web servers.
  2. Configure the Legacy Unhandled Exception Policy on all web servers:
    1. Browse to the following directory on your web server: C:\Windows\Microsoft.NET\Framework64\v4.0.30319\
    2. Open the Aspnet.config file in a text editor.
    3. Locate the tag <legacyUnhandledExceptionPolicy>.
    4. Set the enabled attribute to true. This sample code illustrates the attribute that you need to update:
    5. <legacyUnhandledExceptionPolicy enabled="true" />

    6. Save the changes to the file.

IIS role service configuration

Relativity requires that you configure several role services in the IIS. You also have the option of using a full installation of the Web Server (IIS) role.

Enabling the WebSocket protocol

If you are using Windows Server 2012 R2, Relativity requires that you have the WebSocket protocol enabled on the IIS to support documentation conversion and imaging. Confirm that you have this protocol enabled on your web server. If you don't currently have it enabled on the IIS, see the WebSocket <webSocket> page on the Microsoft web site for instructions about setting it up.

Configuring log file options

If you enabled logging on the IIS, you can avoid performance and other issues by limiting the size of log files, as well as the number of trace files stored on the IIS. This section describes how to configure these features in your environment for optimum performance.

Log file options for Windows Server 2012 R2

Use the instructions in this section to configure logging settings for Windows Server 2012 R2.

Configuring SSL on a web server

Before installing Relativity, we recommend that you set up SSL on the IIS for your Relativity instance. This configuration provides added security for the communication between the web server and the browser on a client computer. Your browser uses this secure connection to verify that it is communicating with the Relativity server. It also provides additional protection against the theft of cookies used to maintain a session between the browser and the server.

Note: You aren't required to configure SSL on the web server hosting Relativity. If you decided not to use HTTPS in your environment, you must set the CookieSecure instance setting to False before logging in to Relativity, or you receive an error message. You can also complete this setup after installation but before logging in to Relativity. For more information, see Instance setting table.

The process for configuring SSL on your web server includes these steps:

Agent server setup

An agent server performs background processing. It requires the following software:

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

In most environments, the Relativity installer automatically enables Microsoft DTC and HTTP activation. You may require the following instructions if you need to troubleshoot your installation or if its configuration requires you manually complete these steps.

Service Bus for Windows Server

The Relativity service bus requires that you install and configure Service Bus for Windows Server before you install or upgrade Relativity. You can perform an online installation for Service Bus for Windows Server that requires an internet connection, or an offline installation that requires the internet only to download the installer. For additional information, see Relativity service bus.

Note: You can optionally install the Service Bus for Windows Server on multiple hosts.

The process for installing and configuring Service Bus for Windows Server includes these steps:

File (document) share or server

You can use a file share or server as a repository for documents stored in Relativity. You must create a directory that's used as the root of the directories and documents created through the Relativity system. This file share must be a folder rather than a drive letter. For example, C:\Fileshare instead of just the C drive.

In addition, confirm that the Full Text, LDF files, MDF files, and Backups are all specified to the folder level. Don't specify them to only a drive.

Note: For information about setting up processing servers, see Database server for processing or native imaging and Worker server for processing or native imaging.

Create share

The document root directory is exposed to the Relativity application through a shared drive. Use these steps to share the folder:

  1. Right-click the folder, and go to Properties.
  2. Open the Sharing tab, and click Share.
  3. Enter the Relativity Service Account name (domain\account), and then click Add.
  4. Select the service account on the share list, and then change Permission Level to Co-owner.
  5. Enter the Relativity Upload Users group, and then click Add.
  6. Select the group on the share list, and then set the Permission Level to Co-owner.

  1. Click Share.
  2. When the share completes, click Done.
  3. On the Document Properties dialog, select the Security tab.
  4. Verify that the users and groups you added to the share also have Full Control security permissions to the folder itself.

Cache location server

The cache location server requires the same permissions as the file share. For more information, see File (document) share or server.

Note: During installation or upgrade, Relativity automatically creates a cache location server based on the location of your file repository. You can also manually add cache location servers. For more information, see Cache location servers.

Analytics server setup

Before completing the steps for upgrading the Analytics server, make sure you've completed the steps contained in this section.

Required software

The following software must be installed on the analytics server:

  • Windows Server 2012 R2 or Windows Server 2016
  • .NET Version 4.6.2
  • .NET Version 3.5
  • Windows Server 2016, Windows Server 2012 R2, or Windows Server 2008 R2
  • .NET Version 4.6.2 (required in 9.5.196.102 and higher)
  • .NET Version 4.5.1 (for versions before 9.5.196.102)

Create installation index directory

  1. Create a folder called CAAT on the root of the C: drive.
  2. The Analytics index directory must also be created before installing Relativity Analytics. We recommend that you not keep the index directory on the C: drive due to the size requirements. We recommend you use locally-attached storage referenced by a drive letter, i.e. E:\AnalyticsData, rather than a UNC path. For more information, see Index directory requirements. Do not create a local drive map to a UNC. For example, do not open \\servername\CAAT1 and map it to drive Z:. This is because drive mappings are specific to each Windows user and may not be available to the Relativity Service Account.

Assign permissions to the analytics directories

You must configure permissions for the necessary directories on the analytics server. Follow these steps to assign the proper permissions:

  1. Add the Relativity Service Account user to both the Administrators and the Users group.
  2. Navigate to C:\CAAT\ and add Full Control permissions to both the Administrators and the Users group.
    • Right-click on C:\CAAT.
    • Navigate to the Security tab.
    • Edit the Users group permissions and add Full Control.
    • Edit the Administrators group permissions and add Full Control.
    • Click Apply.
  1. Navigate to the index directory and add Full Control permissions to both the Administrators and the Users group.
    • Right-click on the index directory folder.
    • Navigate to the Security tab.
    • Edit the Users group permissions and add Full Control.
    • Edit the Administrators group permissions and add Full Control.
    • Click Apply.
  1. Reboot the server after all user and/or permission changes.

Required setup

  1. The web server needs to be able to communicate with the analytics server via TCP ports 445, 8080, and 8443. For more information, see Infrastructure planning considerations..
  2. Windows Firewall needs to be disabled.
  3. Disable anti-virus programs. At minimum it needs to be set to ignore the C:\CAAT installation folder as well as the index directory.
  4. Disable UAC settings in your environment in order for the Analytics installer to complete successfully. This has to be set using the following steps on Windows 2012 server to fully disable UAC:
    • Open Regedit.
    • Browse to HKEY_LOCAL_MACHINE / SOFTWARE / Microsoft / Windows / CurrentVersion / policies / system.
    • Double click on EnableLUA.
    • Change the Value data to 0.
    • Click OK.
    • Reboot the server after this change.
  1. Ensure that proxy settings are disabled on the analytics server by performing the following steps:
    • Open Internet Explorer on the Analytics server.
    • Go to Tools, and then select Internet Options.
    • Click the Connections tab.
    • Select LAN Settings and ensure the Proxy server section is cleared:

  1. Click OK to save your changes.

Elasticsearch server setup

Required software

The following software must be installed on the Elasticsearch server:

  • Windows Server 2012 R2 or Windows Server 2008 R2
  • Java SDK

Index share - dtSearch repository

Create a root directory for the directories created by dtSearch index builds within the system.

Create share

The dtSearch index directory is exposed to the Relativity application through a shared drive. Use these steps to share the folder:

  1. Right-click on the folder, and then go to Properties.
  2. Open the Sharing tab, and then click Share.
  3. Enter the Relativity Service Account name (domain\account), and then click Add.
  4. Select the service account on the share list, and then set the Permission Level to Co-owner.

  1. Click Share.
  2. When the share completes, click Done.
  3. On the Document Properties dialog, select the Security tab.
  4. Verify that the Relativity Service Account also has Full Control security permissions to the folder itself.

SMTP server setup

Relativity requires access to an SMTP server to handle the delivery of error messages, job notifications, and billing statistics to both internal contacts and to us at Relativity. We provide an easy to use SMTP connectivity tool, which Client Services runs against your system to verify the servers can properly communicate with your specified SMTP server.

Note: Make sure that the newly created agent and web servers used in your Relativity environment are configured to permit the relay of messages to external recipients. If you don’t provide this permission, job notifications and other messages are blocked.

Environment modification for processing or native imaging

Before running the Invariant (worker manager server) 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.)

For more information, see Worker manager server installation.

Database server for processing or native imaging

The following sections provide basic information about setting up the database server for processing or native imaging. For more information, see Worker manager server installation.

Required software

Install the following software on the database server:

  • Windows Server 2016 or Windows Server 2012 R2
  • SQL Server 2012, SQL Server 2014, or SQL Server 2016
  • .NET Version 4.7 or .NET Version 4.6.2
  • .NET Version 3.5

Fix for Microsoft KB3138319, KB 3151109 and KB3120595:

  • Cumulative Update 11 for SQL Server 2012 SP 2
  • Cumulative Update 5 for SQL Server 2014 SP1
  • Cumulative Update 13 for SQL Server 2014

Relativity Service Account

The Relativity Service Account must be the owner of all objects in the processing databases and have permissions for logging in to the SQL Server environment. It must be set up as follows:

  • Configure the account with Windows Authentication.
  • Ensure that the account has local administrator rights to perform the installation of the native imaging database and queue manager.
  • Ensure that this account has SQL administrator rights.

Create Invariant worker network file path share

Create a directory on the SQL Server in a location where the Relativity Service Account can read and write. Make sure that SQL services can also read from this directory. This directory must be an actual folder, not a drive letter. It stores the installation files for worker servers.

Worker server for processing or native imaging

The following sections provide basic information about setting up the worker server for processing or native imaging. For more information, see Worker manager server installation.

Required software

Install the following software on the worker server:

Software Description Required for system installation?
Windows Server 2016 or Windows Server 2012 R2 Required server software. Yes
  • .NET Version 4.7 or .NET Version 4.6.2
  • .NET Version 3.5
  • Required server software. Yes
    Desktop Experience (Windows Server feature) Required server software. Yes

    Microsoft Office 2010 Professional SP2 (32-bit)

    or

    Microsoft Office 2013 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.
    • Outlook – used for 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: Courier New and Arial Unicode MS fonts must be installed on your machine. These fonts are installed by default when you install Microsoft Office, in which case you must ensure that you don't remove them.

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

    Yes

    Microsoft Works 6–9 File Converter

    If you install Microsoft Office 2013, then the Microsoft Works Converter is also required. There are two ways to get the Microsoft Works 6–9 File Converter:

    • Download it here.
    • Through the Microsoft Office 2013 installer

    Yes

    • This is only required if you're using Office 2013.

    Microsoft Visio 2010 Professional or Standard SP2 (32-bit) (recommended)

    or

    Microsoft Visio 2013 Professional or Standard SP1 (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 2010 Professional or Standard SP2 (32-bit) (recommended)

    or

    Microsoft Project 2013 Professional or Standard SP1 (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.

    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 8.5 or higher is required. 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.

    Yes

    Adobe Reader 4.0 or higher Used for processing and native imaging of PDF files. Yes

    SolidWorks eDrawings Viewer 2016 (64-bit)

    or

    Solidworks eDrawings Viewer 2017 (64-bit)

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

    • To download the viewer, go here and select either 2016 or 2017 from the Select Version drop-down.
    • Solidworks 2017 support began in Relativity 9.5.196.102.

    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).

    Yes

    Hancom Office Hanword 2014 Viewer Used for processing and imaging HWP files.

    No

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

    * 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.

    Required Microsoft Visual C++ redistributables

    The following table breaks down which versions of Microsoft Visual C++ are required for which versions of Relativity/Invariant. Note that you’re required to install each version of Microsoft Visual C++ only if you’re upgrading to the Relativity/Invariant version listed and not if you’re installing it for the first time.

      Required Microsoft Visual C++ version (Redistributable x86 and x64)
    Relativity/Invariant version 2010 2012 2013 2015
    9.3/4.3 (all monthly versions included)    
    9.4/4.4 (all monthly versions included)  
    9.5.41.87/4.5.32.2  
    9.5.69.85/4.5.60.2  
    9.5.133.118/4.5.126.16  
    9.5.162.111/4.5.132.8  
    9.5.196.102/4.5.188.20
    9.5.219.30/4.5.189.29
    9.5.253.62/4.5.245.54
    9.5.292.12
    9.5.309.48
    9.5.342.116
    9.5.370.136
    9.5.411.4
    9.6.50.31

    Relativity Service Account

    The Relativity Service Account must be given local administrator rights to each worker server. The installation process uses this account. It must remain logged in to each server to run local processes during native imaging.

    Obtaining applications for native imaging and processing

    On the Relativity Native Imaging/Processing worker, you must install additional software to support imaging/processing.

    For convenience, this section includes links to download pages for specific software, which may require licensing or may be downloaded for free:

    Default log file location

    The default file location for Relativity logs is set by the %RELATIVITY_LOGS% environment variable. Define the variable on all machines in you Relativity environment (web servers, agent servers) except SQL Servers. For more information, see Configure logging.

    Post-installation considerations

    After you install Relativity, review the post-installation considerations listed in this section.

    User group for uploading documents

    You can improve performance when documents are uploaded with the Win Relativity component by creating a group of users with Full Control permissions on the file share used as a document repository. This group can import and export documents in Direct mode, which is significantly faster than Web mode.

    Relativity service account information

    The Relativity installer automatically creates the Relativity service account. It assigns this account an email address, as the username, and a default password. We highly recommend that you change the default Forms password through the Relativity UI after the software is deployed. However, you shouldn’t disable this account or modify any other authentication information assigned to it.

    The Active Directory (AD) domain also includes a Relativity services account, which has the same username. The Relativity services account on this domain must log in to Relativity to perform various tasks, such as running agents and authenticating against the Relativity Services API. The audit history for Relativity often lists the Relativity services account as the user who performed a specific task. To avoid destabilizing your environment, we recommend that you don’t change the user settings in Relativity for this account or the AD domain for this account. Since Relativity uses AD authentication for the Relativity services account only for performing agent tasks, you can change the Forms authentication password through the Relativity UI without encountering any environment issues.

    As previously mentioned, the Relativity service account is sometimes used to identify the user who performed certain tasks in the software. For example, you might set up a dtSearch index job that includes a private search created by one of your users. The Relativity service account needs access to this private search in order to build the index automatically. It is the only account that can provide this functionality within Relativity.

    Post-installation steps for a token-signing certificate

    Note: To minimize any interruption to your Relativity workflows, we recommend that you complete the following process during off-hours.

    After installation, perform the following steps for a token-signing certificate:

    1. On the primary SQL server, navigate to the Relativity install directory and then navigate to the Procuro folder (typically C:\Program Files\kCura Corporation\Relativity\Procuro).
    2. Run the kCura.EDDS.Procuro.exe application as an administrator.
    3. On the EDDS Database Upgrade window, click Back.
    4. Select the certificate that you wish to use as the signing certificate. The certificate must already be in the Personal store on the machine for it to appear in the drop-down.

    5. Click Update Certificate.
    6. Restart all of the Relativity services in the environment and IIS.

    Logo customization

    Customize your Relativity web interface with your company’s logo. To accommodate variable space requirements, provide two logos with different sizes. The height may be 50 pixels and the width is discretionary. You can hide the logo using a setting in the Instance setting table. The name of the logo file is also set in the Instance setting table. Add the logos to the images folder at the root of the EDDS directory.

    Resource groups

    A workspace doesn't contain resource servers after you install Relativity. After the agents start up, the servers self-register, but they aren't automatically associated with a resource group. To associate these servers to a resource group, you must manually add them through the Resource Group tab available only from Home. For more information, see Servers.

    License keys

    After you install Relativity, you need to either activate new licenses or renew your current ones by requesting and applying activation keys for the applications you intend to use in your Relativity instance, including Processing. Relativity licensing includes flexible options that you can tailor to the size, type, and other requirements of your organization as part of your contractual agreement with us. For more information, see Licensing an application.

    Relativity instance name

    During a first-time installation, you must provide a name for your Relativity instance. This value is displayed on License details page available through the License tab. It is stored as the Instance setting in the Relativity.LicenseManager section of the Instance setting table on the EDDS database.

    Note: Modifying the instance name by updating this setting in the Instance setting table immediately invalidates your Relativity and Processing licenses.

    When you request a Relativity license, this instance name is included in the request key. Contact the Client Services team for additional information.

    In the RelativityResponse.txt file, the RELATIVITYINSTANCENAME value records the Relativity Instance Name option when you perform a first-time installation. For more information see, Relativity installation.