Worker Manager Server Installation Guide

Worker Manager Server Installation Guide January 21, 2017 - Version 9.2 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -...
Author: Gwenda Pierce
0 downloads 2 Views 1MB Size
Worker Manager Server Installation Guide January 21, 2017 - Version 9.2

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

For the most recent version of this document, visit our documentation website.

Table of Contents 1 Worker manager server installation

3

2 Worker manager server pre-installation steps

3

2.1 Install Relativity

3

2.2 Required software on the worker

3

2.3 Required permissions

4

2.3.1 Database

5

2.3.2 Queue Manager

5

2.3.3 Workers

5

2.4 Environment configuration steps

6

2.5 Database file and network folders setup

6

2.6 Update the permissions on the BCPPath file share

7

2.7 Enable Windows authentication

8

2.8 Installation setting for Microsoft Office Professional 3 Running the worker manager server installer

12 12

3.1 Installing the Invariant database and Queue Manager

13

3.2 Installing the worker

17

3.2.1 Configuring the worker manager server in your environment

18

3.2.2 Priority considerations

21

3.3 Installing the NIST database

21

3.4 Modifying, repairing, or uninstalling the worker manager server

22

4 Upgrading a worker manager server installation

23

4.1 Upgrade exceptions

24

4.2 Upgrading the Invariant database and Queue Manager

24

4.3 Automatically upgrading the worker

25

5 Troubleshooting a worker manager server installation

Relativity | Worker Manager Server Installation Guide - 2

25

6 Creating an installation input file

28

1 Worker manager server installation The Relativity worker manager server provides flexible options for processing electronically stored information (ESI). Use this content to perform an Invariant installation in your environment. The installation wizard simplifies the process of installing the following components: n n

n

Invariant Database - this database is a queue used to track jobs submitted to Invariant. Queue Manager - the Queue Manager is responsible for adding jobs to the Invariant Database as well as removing them. It also assigns jobs to the Invariant workers. Workers - the workers execute specific subtasks or jobs assigned to them by the worker manager server.

Note: The terms "worker manager server" and "Invariant" are used interchangeably throughout the content on this site. Note: Even though Invariant is required for Relativity 9+, you aren't required to purchase a Processing license unless you are using Processing.

2 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. For more information about software and hardware requirements, see the System Requirements Guide.

2.1 Install Relativity Before you install the worker manager server, make sure that you install Relativity. For more information, see the Relativity 9.2 Documentation site.

2.2 Required software on the worker The following software is required on the worker server for processing or native imaging: n n n n

Windows Server 2012, Windows Server 2012 R2, or Windows Server 2008 R2 .NET Version 3.5 .NET Version 4.5.1 (starting in Relativity 9.2.271.9) Desktop Experience (Windows Server feature)

Relativity | Worker Manager Server Installation Guide - 3

n

Microsoft Office 2010 Professional SP2 (32-bit) Microsoft 2010 includes OneNote and Publisher, which are also required applications. The Courier New and Arial Unicode MS fonts must be installed on your machine. These fonts are installed by default when you install Microsoft Office 2010, in which case you must ensure that you don't remove them. o If you upgrade to a version of Microsoft Office higher than 2010, you won't be able to use processing in your environment. Microsoft Visio 2010 Professional or Standard SP2 (32-bit) Microsoft Project 2010 Professional or Standard SP2 (32-bit) Lotus Notes v8.5.2 with Fix Pack 4 or Lotus Notes v8.5.3 with Fix Pack 6 o o

n n n

Beginning in Relativity 9.2.271.9, Lotus Notes 9.0X is supported but not required. It's recommended that you install Lotus Notes 9 or higher on your workers, as Lotus Notes version 8.5.x can’t read certain Lotus 9 databases. Note that some Lotus 9 databases can't be opened in 8.5.x and will generate an error during processing. Adobe Reader 4.0 or higher SolidWorks eDrawings Viewer 2015 (64-bit) with the option to view 3D XML and PRO/E files. o

n n

o

n

Beginning in Relativity Version, the Solidworks eDrawings Viewer 2015 is no longer a pre-requisite for processing. Solidworks is only required for performing native imaging and text extraction on any supported CAD files in your data sources Thus, 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.0 or higher

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 Worker Database Queue manager

Software component See Required software on the worker on the previous page. Windows Server 2012, Windows Server 2012 R2, or Windows Server 2008 R2 n

n

Windows Server 2012, Windows Server 2012 R2, or Windows Server 2008 R2 .NET Version 3.5 or .NET Version 4.5.1 (starting in Relativity 9.2.271.9)

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

Relativity | Worker Manager Server Installation Guide - 4

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.

2.3.1 Database The following permissions are required to install the Invariant Database: n

n

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

n

2.3.2 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: n

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

n

2.3.3 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: n

n

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:

Relativity | Worker Manager Server Installation Guide - 5

o

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.

o

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.

2.4 Environment configuration steps Before running the Invariant installer, you must perform the following steps to modify your environment. Component Environment Configuration Settings Database

n n

Disable Internet Explorer Enhanced Security Configuration. Disable User Access Control (UAC) and the Windows Firewall.

Queue Man- None ager Workers n Enable the Desktop Experience Windows Feature. n Disable Internet Explorer Enhanced Security Configuration for Administrators and Users. n 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. n 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.)

2.5 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. n

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.

Relativity | Worker Manager Server Installation Guide - 6

n

n

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.

2.6 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 the PreInstallation Guide. See the sample settings on the following screen shot:

Relativity | Worker Manager Server Installation Guide - 7

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

2.7 Enable Windows authentication You must enable Windows authentication for certain Relativity features such as the worker manager server, which requires this authentication type for processing. If you aren’t currently using this authentication type for your Relativity installation, you can set up an application that uses Active Directory (AD) for Windows authentication. For more information about authentication methods supported by Relativity, see Authentication on the Relativity 9.2 Documentation site. Use these steps to set up an application with Windows authentication.

Relativity | Worker Manager Server Installation Guide - 8

Note: To identify the application set up for Windows authentication, the following steps use WindowsAuthWebAPI as the naming convention for the application, application pool, and folder created for this purpose. 1. On your web server, stop the IIS. 2. To create a folder for the application's physical path, complete the following steps: a. In the Windows Explorer, navigate to your Relativity installation folder. When you install Relativity, the default file path is C:\Program Files\kCura Corporation. b. Locate the RelativityWebAPI folder in the installation directory. c. Copy this folder and rename it to WindowsAuthWebAPI. 3. To add an application pool, complete the following steps: a. b. c. d. e.

Open the IIS Manager on your web server. Right-click on Application Pools and select Add Application Pool. In the Add Application Pool dialog, enter WindowsAuthWebAPI in the Name box. Select .NET Famework v 4.0 in the .NET Framework version drop-down box. Verify that the Manager pipeline mode is set to Integrated. Click OK.

f. Confirm that user running the application pool is the Relativity service account: i. ii. iii. iv.

Click on Application Pools to display a list of them. Locate your application pool in the list. Right-click on your application pool and click Advanced Settings. Confirm that the Identity field is set to the name of your Relativity service account. (Click to expand)

Relativity | Worker Manager Server Installation Guide - 9

v. Click OK. 4. To add an application, complete the following steps: a. In the Connections pane, right-click on the website hosting Relativity, and click Add Application b. On the Add Application dialog, enter WindowsAuthWebAPI in the Alias box. c. Click Select for the application pool to choose WindowsAuthWebAPI.

Relativity | Worker Manager Server Installation Guide - 10

d. In the Physical path box, click

to browse for the WindowsAuthWebAPI folder. Click OK.

5. To disable anonymous authentication, complete the following steps: a. b. c. d.

Click on the WindowsAuthWebAPI site. In the Features view, click Authentication. In the Authentication view, right-click on Anonymous Authentication and click Disable. Right-click on Windows Authentication and click Enable.

e. To update the web.config file, locate it in the following folder: C:\Program Files\kCura Corporation\Relativity\WindowsAuthWebAPI f. Open the file in an editor. Update the authentication mode and authorization sections as follows:

Relativity | Worker Manager Server Installation Guide - 11



6. Restart the IIS.

2.8 Installation setting for Microsoft Office Professional When you install Microsoft Office 2010 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 2010 Professional. On the Installation Options tab, point to Office Shared Features. Point to Converters and Filters, and select Run all from My Computer.

3 Running the worker manager server installer The worker manager server installer provides options for installing the Invariant database, Queue Manager, and Worker. The Invariant database and Queue Manager must be installed on the same server. For optimum stability and performance, the Worker component should be installed on a separate server. You can install multiple components at the same time by selecting them in the installation wizard. However, if you're using an alternative configuration for the worker manager server, you must install the Invariant database before installing the other components. You can optionally create an installation input file that the installer uses to pre-populate the fields displayed in the installation wizard. See Creating an installation input file on page 28 for details.

Relativity | Worker Manager Server Installation Guide - 12

Note: For detailed information on how to set up your environment for optimal processing use, see the Environment Optimization guide.

3.1 Installing the Invariant database and Queue Manager Use these instructions to install the Invariant database and Queue Manager on the same machine. When you select the Invariant Database and Queue Manager checkboxes in the installer, you install the Invariant database. You must be logged in as the Relativity Service Account to perform the installation. The installer adds MDF and LDF files for both databases to the folders that you specify. Note: Verify that Relativity is installed in your environment before you install the worker manager server. For more information, see Worker manager server pre-installation steps on page 3. 1. Create a network directory on the SQL Server before you begin the installation. This directory must have share permissions to the Relativity Service Account. See Worker manager server pre-installation steps on page 3 for more information. 2. Log in to the server with the Relativity Service Account where you want to install the Invariant Database and Queue Manager. 3. Click on the installer executable to launch the Invariant Setup Wizard. 4. Click Next to display the Feature Selection window. 5. Select both the Invariant Database and Queue Manager checkboxes. Note: You should install both the Invariant database and the Queue Manager on the same machine.

Relativity | Worker Manager Server Installation Guide - 13

6. Click Next to display the SQL Login window.

7. Enter the following configuration values on the SQL Login window: n

Enter the name of the SQL instance where you're installing the databases. The installer confirms that SQL Server 2012 is installed. It attempts to connect to the SQL instance with the authentication method that you select, which can be either Windows authentication or Server authentication as listed under the Connect using section. Note: Do not enter localhost as the SQL Instance name.

EDDSDBO Password - enter and confirm the password for the EDDSDBO login. This field doesn't appear if you're only installing the Invariant Worker.For more information about this account, see the Pre-Installation page on the Relativity 9.2 Documentation site. n Select Windows or Server authentication. Make sure the account used for authentication has sysadmin permissions on the SQL server. If you selected Server authentication, enter your log in credentials for the SQL instance that you specified. 8. Click Next to bring up the Queue Manager Configuration window. This is only required if you're installing the queue manager. If you're not installing the queue manager, you'll go directly to the File Path Configuration window described in the next step. Enter the following values for the Queue Manager Configuration: n

Relativity | Worker Manager Server Installation Guide - 14

Windows Service Username - the username for the Windows Service that the queue manager will reference. The format of this value should be domain\username. n Windows Service Password - the password for the Windows Service account that the queue manager will reference. n If you need to install the queue manager to a different location than the one populated by default, click Browse... and select the appropriate location. Otherwise, leave the default location as is. 9. Click Next to display the File Path Configuration window. n

Relativity | Worker Manager Server Installation Guide - 15

10. Update the following paths on this window: n

n

n

n n

MDF File Path - Click Browse to display the Change Destination Folder window. Select a folder for the database data files and click OK. The installer adds Invariant and Relativity imaging database files to this folder. LDF File Path - Click Browse to display the Change Destination Folder window. Select a folder for the log files and click OK. The installer adds Invariant and Relativity imaging log files to this folder. Worker Network File Path - Enter the path to the share location on the SQL server, such as \\\Invariant. dtSearch Index Path - Enter the path to the share location where dtSearch indexes are stored. Default Destination Folder Path - the path to the shared location where you want to store the files that you import for processing so that those files aren’t written to random locations on each worker server when you use the Relativity Processing Console (RPC) to import data and dtSearch indexes. o

o

o

If you are using the RPC, don't enter a local path here. This must be a UNC path that is accessible by all components of Invariant, which includes the Queue Manager, Workers, and users running the RPC. It's recommended that you also have a separate file share not used by Relativity for this location. This setting is required even if you don't intend to use the RPC; however, in that case, there is no consequence to entering a random path that you have no intention of ever using, as it has no bearing on installation.

11. Click Next. 12. Enter a Window Service Username and Password. The Queue Manager Service runs under these credentials. If the server is a member of a Domain, the username and password must be credentials of a Domain user. If the server is a member of a Workgroup, they must be credentials of a local user. For a

Relativity | Worker Manager Server Installation Guide - 16

server in a Workgroup, format as machine\username. This user must also have local administrator rights on the server. 13. Click Browse to choose the path where the Queue Manager files will be installed. On the Change Destination Folder window, select a folder for the files, and click OK. The installer will add the Queue Manager files to this folder. Note: Don't select a location that's a sub directory of the Worker Network file path.

14. Click Next, then click Install to start the installation process. Note: If an error or interruption occurs, a message displays indicating that the installation can't be completed. (If you canceled the installation, click OK to confirm this action.) See Troubleshooting a worker manager server installation on page 25 for more information. 15. Click Finish to launch the Database Updater and exit the setup wizard. The Launch NIST installation utility checkbox is selected by default. You can clear this checkbox if you don't want to launch the utility after the installation is completed. See Installing the NIST database on page 21. 16. When the Command Prompt window appears, press any key to close this window and the installer. Note: Invariant displays an error message if it can't update a database. See Troubleshooting a worker manager server installation on page 25 for more information.

3.2 Installing the worker As recommended, you should install the Invariant Database and Queue Manager before installing the Worker component. You must be logged in as the Relativity Service Account to perform the installation. Note: Worker machines must be used only for running workers executing tasks for Invariant. You should not use these machines for running other applications or performing other tasks. Furthermore, the worker machine should never exist on the same server as the queue manager. In addition, the Relativity Service Account must remain logged in to the worker machines at all times. If the Relativity Service Account is not logged in to this machine, the Invariant Worker fails. 1. 2. 3. 4. 5. 6. 7.

Create a network directory on the SQL Server before you begin the installation. Log in with the Relativity Service Account to the server where you want to install Invariant Workers. Click on the installer executable to launch the Invariant Setup Wizard. Click Next to display the Feature Selection window. Select the Invariant Worker checkbox. Click Next to display the SQL Login window. Enter the name of the SQL instance where the Invariant database is installed. The installer confirms that SQL Server 2008 is installed and attempts to connect to the SQL instance using Windows Authentication. Note: Do not enter localhost as the SQL instance name.

Relativity | Worker Manager Server Installation Guide - 17

8. Click Next to display the Worker Configuration window.

9. Click Browse to choose the path where the Worker files will be installed. On the Change Destination Folder window, select a folder for the files, and click OK. The installer will add the Worker files to this folder. Note: Don't select a location that's a sub directory of the Worker Network file path.

10. Click Next, then click Install to start the installation process. Note: If an error or interruption occurs, a message displays indicating that the installation can't be completed. (If you canceled the installation, click OK to confirm this action.) See Troubleshooting a worker manager server installation on page 25 for more information. 11. Click Finish to exit the setup wizard.

3.2.1 Configuring the worker manager server in your environment Once you've installed the worker manager server, you can access and configure it in Relativity. Use the following steps to access the worker server manager settings: 1. Navigate to the Servers tab. 2. Click the name of the worker manager server in the list of servers. 3. If you want to edit the fields, click Edit, make the desired changes, and click Save.

The following fields are visible on a worker manager server:

Relativity | Worker Manager Server Installation Guide - 18

n n n

Name - this field allows you to give the worker manager server a name that appears on the Servers tab. Type - this is a read only field that displays the server's primary function. URL - this is a read only URL that defines the location of the Invariant API on the worker manager server. A worker manager server URL should be in the following format: net.tcp://NAME OF SERVER.DOMAIN NAME:6859/InvariantAPI/ or net.tcp://NAME OF SERVER:6859/InvariantAPI/. For

Relativity | Worker Manager Server Installation Guide - 19

n

example, net.tcp://pt-func-sql02.testing.corp:6859/InvariantAPI/ or net.tcp://172.17.28.216:6859/InvariantAPI/. Is Default - if checked, this worker manager server is the default worker manager server added to any resource pool upon creation and any resource pool that doesn't currently have a worker manager server. On upgrade, the default worker manager server automatically associates with all existing resource pools. If unchecked, you must manually add the worker manager server to each resource pool. Note: Every resource pool should have a worker manager server linked to it. If a resource pool doesn't have a worker manager server linked to it, any workspace linked to that resource pool is unable to perform document conversion, imaging, and processing.

n

n

n

Status - when a worker manager server is added to Relativity, the server manager agent attempts to make a connection and get information about workers. The Status field is automatically set to Active if a server is online. Relativity automatically updates this value to Inactive when the server manager agent exceeds the maximum connection attempts set by the ServerManagerRetries configuration table value. Temporary directory - a UNC share path used as a temporary location for storing files during Relativity processes. This field is available for all server types except Analytics servers. Use the format \\\ for the path, and ensure that the directory is accessible to the agent server running the export. Relativity validates the path you enter. If the path format is invalid, you receive an error message when trying to save. If a permission error occurs, Relativity writes a message to the Errors tab. Version - this read only field displays the version of Invariant installed on the worker manager server.

The Priorities section allows you to specify which jobs the worker manager server gives precedence to when managing jobs. The higher the number, the lower the priority. Note that the default value for each of the following options is configurable via a corresponding entry in the EDDS.Configuration database table. n n n n

n

n

n n n n

Inventory - holds the prioritization for inventory jobs. Discovery - holds the prioritization for discovery jobs. Publish - holds the prioritization for publish jobs. Conversion on-the-fly - holds the priority for all single conversion jobs performed in the workspace. A conversion-on-the-fly job occurs when a user clicks on a single document and opens it in the viewer. Pre-Convert - holds the priority for a pre-conversion job. Every time you open a document in the viewer, Relativity automatically converts the next X number of consecutive documents after the one you opened. Mass Conversion - holds the priority for a mass conversion job. This job occurs when you select a group of documents from the Documents tab and select the Conversion option from the mass operations drop-down. Imaging - holds the priority for imaging jobs (both native and basic). Image on the Fly - holds the priority for Image on the fly jobs. Save As PDF - holds the priority for Save as PDF jobs. Mass Imaging/Imaging Set - holds the priority for all imaging set or mass imaging jobs, specifically when you either start an imaging set from the Imaging tab or when you select a group of documents from the Documents and then select Image from the mass operations drop-down, respectively.

Relativity | Worker Manager Server Installation Guide - 20

n

n

Single Save As PDF - holds the priority for an individual Save as PDF job. This occurs when you save an individual record in the viewer as a PDF file. Mass Save As PDF - holds the prioroty for all Mass Save as PDF jobs. These occur when you select a group of documents from the Documents tab and then select the Save As PDF option from the mass operations drop-down.

3.2.2 Priority considerations Beginning in Relativity Version, the following functionality accompanies the enhancements made to priorities on the worker manager server: n

n

n

If conversion on the fly is a lower priority than any other functionality, upon saving the setting, on the view page, display a warning that reads "Conversion on-the-fly isn’t the highest priority in your listed jobs. Update the priorities, if necessary." If the Pre-Convert option has a higher value than Mass Conversion in the Priorities field of the worker manager server layout, you will receive a warning upon save that reads "The conversion of the next few documents has a lower priority than mass conversion. Update the document conversion priorities, if necessary". If you open a document that is part of a mass conversion job in the viewer before that document has been put into the cache, you actually change that document to a single conversion job and give it a new priority. For example, if you've just started a mass conversion job containing 1,000 documents and you open the 500th document from that job in the viewer before it has reached its turn in the mass conversion, that document becomes a conversion-on-the-fly job with a higher priority than the remaining documents in the mass conversion job.

3.3 Installing the NIST database If you are using the worker manager server to run native imaging only, or if you are running processing and don't want to de-NIST files, you can choose not to install the NIST database. Before you install the NIST database: n n

Your Invariant environment must be installed and operational. No processing jobs should be running or submitted while you install or update the NIST database.

Note: When you install the Invariant Database and Queue, the NIST installation utility is automatically launched when the Launch NIST installation utiltity checkbox is selected on the final window of the installation wizard. You do not need to complete step 1 if you selected this checkbox. 1. Contact support at [email protected] to get the latest NIST package. 2. Open the Invariant Network Share folder and launch the file NISTInstallUtility.exe. The utility displays information about the currently installed NIST package (when available) in the Invariant NIST section. This information includes the NIST release version, the release date, and the last date and time the NIST database was installed. 3. Click Browse and select the NIST package file downloaded in step 1. If the file is valid, the release version and release date display in the NIST Package section.

Relativity | Worker Manager Server Installation Guide - 21

4. Click Import Package. The two-step package import process begins. Note: If you already have a file of the same version or with a more recent release date, the Import Package button is disabled.

As the NIST package is decompressed, the decompressing progress displays in the progress bar below the NIST package section. After decompressing, he utility uploads the NIST data into the Invariant database and updates the version, date, and last updated date. Once the import process is complete, a confirmation message displays.

5. Click OK on the confirmation message. The Invariant NIST section is updated with the version, date, and last updated date information. The Import Package button is disabled since the Invariant NIST data and NIST package file have the same version and date.

If an error occurs during this procedure, a short error message appears, and the full error stack is written to the Windows Application Event Logs for both applications.

3.4 Modifying, repairing, or uninstalling the worker manager server You can use the installation wizard to modify a worker manager server installation by adding or removing specific components, as well as repairing or uninstalling all application components. You must be logged in as the Relativity Service Account to perform the modification, repair, or uninstall. Note: To perform Invariant maintenance, launch the installer executable. You can't maintain Invariant with change or repair functions available through the Windows Control Panel. 1. Log in to the server with the Relativity Service Account where Invariant or its components are installed. 2. Click on the installer executable to launch the Invariant Setup Wizard. 3. Click Next to display the Change, repair, or remove installation window. Click the appropriate button to

Relativity | Worker Manager Server Installation Guide - 22

modify your installation.

n

Add/Remove Features - click this button to install additional Invariant components, or to uninstall specific components from your environment. If you are installing components, see the installation instructions for the feature that you have selected. If you select a specific component to remove, the uninstall process is run only on that component. Click Change to add or remove features.

n

Repair - click this button to repair your Invariant installation. The installer adds a fresh copy of any deleted Invariant files, but it doesn't make any configuration changes or replace other files that already exist. On the Ready to Repair Invariant window, click Repair.

n

Remove - click this button to uninstall all Invariant components on this machine. On the Ready to remove Invariant window, click Remove.

4 Upgrading a worker manager server installation You can use these instructions for upgrading the Invariant Database, Queue Manager, and Worker. When you upgrade to a new version of Invariant, the installer removes any components from the previous version installed on the local machine before it replaces them with the upgraded version. You must be logged in as the Relativity Service Account to perform the upgrade. Specific versions of Invariant are exclusively compatible with specific versions of Relativity. For this reason, don't attempt to upgrade Invariant independent of Relativity, as doing so will result in significant issues. For example, don't upgrade from Invariant 3.3, which is supported by Relativity 8.2, to Invariant 4.0 without also upgrading to Relativity 9.0. The following table breaks down which versions of Invariant are supported by which versions of Relativity: Invariant version Relativity version Invariant 3.0 Relativity 7.5 Invariant 3.1 Relativity 8.0

Relativity | Worker Manager Server Installation Guide - 23

Invariant version Invariant 3.2 Invariant 3.3 Invariant 4.0 Invariant 4.2

Relativity version Relativity 8.1 Relativity 8.2 Relativity 9.0/9.1 Relativity 9.2

If you're performing separate upgrades for the Invariant components, you must upgrade the Invariant database first, and then the Queue Manager. Invariant workers automatically upgrade when the database is upgraded. If the Invariant Worker Network File Path you specified during installation is not stored on the same SQL server as the Invariant database, instead of upgrading, you should uninstall Invariant and perform a fresh installation of Invariant. When you install the new version, be sure to select a folder that's stored on the same SQL server as the Invariant database. If this folder is not stored on the same server, you could lose all your data and be unable to uninstall or upgrade. Note: When you apply a new processing license in your Relativity environment, all jobs in the processing queue must complete before Relativity identifies any additional worker manager servers that you may have purchased as licensed. In addition, prior to Relativity 9.2.237 (Invariant 4.2.272.7), you need to restart the Invariant Queue Manager after applying a new processing license.

4.1 Upgrade exceptions For upgrades from Relativity 8.0/Invariant 3.1 or lower, you must first manually install the required .NET 4.5 on all of your pre-existing Invariant Database, Queue Manager, and Worker machines before running the installer. Similarly, you must install the required Microsoft Visual C++ Redistributable on all of your pre-existing Worker machines before running the installer. The 3.2 and above installers only validate whether .NET 4.5.1 is installed; they don't install the software. For brand new Worker installations, the installer verifies that .NET 4.5.1 is installed. Installing a new Worker will automatically install MS Visual C++ 2012 for you. For upgrades from Relativity 7.3/Invariant 2.0, you must first upgrade to a later Invariant version (2.1, 3.0, 3.1, 3.2, or 3.3) before you upgrade to Invariant 4.0.

4.2 Upgrading the Invariant database and Queue Manager Use these instructions to upgrade the Invariant Database and Queue Manager. The installer upgrades both the Invariant and Relativity Imaging databases. During an upgrade, you can't modify the SQL Instance name, the Queue Manager Service Username, or the installation location of the Queue Manager. If you need to change the any of these settings, uninstall and reinstall the Invariant Database or Queue Manager. For information on first-time installation of the Invariant database and Queue Manager, see the Worker Manager Server installation guide.

Relativity | Worker Manager Server Installation Guide - 24

Note: If you have an alternative configuration where the Invariant Database and the Queue Manager are on separate servers, you must upgrade the database first. However, this type of configuration is not recommended. 1. Log in to the server with the Relativity Service Account where you want to upgrade the Invariant Database and Queue Manager Service. 2. Click on the installer executable to launch the Invariant Setup Wizard. 3. Click Next to display the read-only Feature Selection window. If the Invariant Database and Queue Manager are installed on the local machine, the checkbox for these components is automatically selected. 4. Click Next to display the SQL Login window. The name of your SQL Instance is pre-populated in the read-only textbox. 5. Click Next to display the Queue Manager Configuration window. The Windows Service username and installation location are pre-populated and read-only. 6. Enter the Password for the account that the Queue Manager Service runs under and click Next. 7. Click Install to start the upgrade process. Note: If an error or interruption occurs, a message displays indicating that the installation cannot be completed. (If you canceled the installation, click OK to confirm this action.)

4.3 Automatically upgrading the worker When you upgrade the Invariant Database, all Worker machines are also automatically upgraded. The Invariant Installer does not allow manual upgrades to a Worker machine. If you attempt a manual upgrade, an error messages displays.

Note: By default, when you install Relativity, each worker in your environment is designated to do all available work (conversion, processing, and imaging). It's recommended that you change this designation so that, for every one hundred simultaneous users in your environment, you have one worker dedicated to conversion only and another worker dedicated to processing and/or imaging (but not conversion).

5 Troubleshooting a worker manager server installation You can use the following information to identify installation errors, common causes for these errors, and ways to resolve them.

Relativity | Worker Manager Server Installation Guide - 25

n

Incorrect SQL Instance Name - If the installer cannot find the SQL Instance, the following message appears:

To resolve this error, verify that the SQL Instance name is entered correctly and that it is located on the current machine. n

SQL Server Windows Authentication Fails - if the user cannot log in to the server, the following message appears:

To resolve this error, confirm that the user running the installer has administrator rights on the specified SQL instance. n

Wrong Version of Windows Server Installed - if the Windows Server is not 2008 or higher, the following message appears:

To resolve this errors, upgrade your Windows Server to a supported version. n

Wrong Version of SQL Server Installed - if the SQL instance is not version SQL Server 2008, 2008 R2, or 2012, the following message appears:

Relativity | Worker Manager Server Installation Guide - 26

To resolve this error, upgrade your SQL Server to a supported version. n

Error Opening Installation Log File - this message displays when the user does not have permission to create a file on the root c:\ drive. It may also display when the file c:\InvariantInstall.log exists, but the user running the installation does not have write permission to the file.

To resolve this error, confirm that the server has User Access Control (UAC) disabled and that the user running the installation has local administrator rights. n

Manual attempt to upgrade a Worker machine - Invariant does not allow manual upgrades to Worker machines. The following message appears if this is attempted:

n

Wrong version for installation or upgrade - Invariant requires that you upgrade or install the Queue Manager and Workers using an installer with the same version as the installed Invariant Database. The following error message appears if you attempt to run an installer with the wrong version:

Relativity | Worker Manager Server Installation Guide - 27

To resolve this error, run a version of the installer that matches the Invariant Database version listed in the error message. n

Error occurs during a database update - Invariant displays error messages in the Command Prompt window when errors are encountered during installation:

After encountering an error, Invariant continues updating other databases. You can find more detailed information about the error in the Windows Event Viewer. To resolve this kind of error, contact kCura Client Services.

6 Creating an installation input file You can create an optional installation input file that the worker manager server (Invariant) installer references to pre-populate values displayed in the installation wizard. Use the following steps to create the file: 1. Open a text editor, and create a file called InvariantInstallationInput.txt. 2. Copy the following text into the file. Note: The headers and separators in the sample file are not required. Do not add any input values that include equal signs. The installer won't be able to use these entries. SQL LOGIN DIALOG ---------------DatabaseInstallingTo=server

Relativity | Worker Manager Server Installation Guide - 28

EDDSDBOPassword=password DATABASE CONFIGURATION ----------------------MDFFilePath=C:\MDF LDFFilePath=C:\LDF InvariantWorkerNetworkFilePath=\\server\workershare dtSearchPath=\\server\dtSearchIndexes DataFilesPath=\\server\fileshare QUEUE MANAGER CONFIGURATION --------------------------WindowsServiceUsername=domain\user WindowsServicePassword=password QueueManagerInstallPath=C:\Program Files\kCura Corporation\Invariant\QueueManager\ WORKER CONFIGURATION ----------------------WorkerInstallPath=C:\Program Files\kCura Corporation\Invariant\Worker\

3. Replace the following bolded entries with those specific for your environment. These entries include: n

n n

n

n

n n

n

n n

DatabaseInstallingTo - enter the name of the SQL Instance where you are installing the database. EDDSDBOPassword - enter the password for the EDDS database. MDFFilePath - enter the path to the folder where the installer adds Invariant and Relativity Imaging data files. LDFFilePath - enter the path to the folder where the installer adds Invariant and Relativity Imaging log files. InvariantWorkerNetworkFilePath - enter the path to a local network directory on the SQL Server. dtSearchPath - the path to the share location where dtSearch indexes are stored. DataFilesPath - the path for the network share where you want to store files imported for processing. WindowsServiceUsername and Password - enter the credentials that you want the Queue Manager Service to run under. If the server is a member of a Domain, the username and password must be credentials of a Domain user. If the server is a member of a Workgroup, they must be credentials of a local user. This user must also have local administrator rights on the server. QueueManagerInstallPath- enter the path to the folder where the Queue Manager is installed. WorkerInstallPath - enter the path to the folder where the Worker is installed. Note: For more information about the fields listed above, see Running the worker manager server installer on page 12.

4. Save the InvariantInstallationInput.txt file in the same directory as Invariant Installer executable.

Relativity | Worker Manager Server Installation Guide - 29

Proprietary Rights This documentation (“Documentation”) and the software to which it relates (“Software”) belongs to kCura LLC and/or kCura’s third party software vendors. kCura grants written license agreements which contain restrictions. All parties accessing the Documentation or Software must: respect proprietary rights of kCura and third parties; comply with your organization’s license agreement, including but not limited to license restrictions on use, copying, modifications, reverse engineering, and derivative products; and refrain from any misuse or misappropriation of this Documentation or Software in whole or in part. The Software and Documentation is protected by the Copyright Act of 1976, as amended, and the Software code is protected by the Illinois Trade Secrets Act. Violations can involve substantial civil liabilities, exemplary damages, and criminal penalties, including fines and possible imprisonment. ©2017. kCura LLC. All rights reserved. Relativity® and kCura® are registered trademarks of kCura LLC.

Relativity | Worker Manager Server Installation Guide - 30