Relativity Processing Server Installation Guide
Total Page:16
File Type:pdf, Size:1020Kb
VERSION Worker Manager Server Installation Guide March 5, 2018 - Version 9.6.50.31 ARCHIVED------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 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 4 2.2 Required software on the worker 4 2.3 Required permissions 7 2.3.1 Database 7 2.3.2 Queue Manager 8 2.3.3 Workers 8 2.4 Environment configuration steps 8 2.5 Database file and network folders setup 9 2.6 Update the permissions on the BCPPath file share 9 2.7 Enabling token authentication VERSION10 2.8 Installation setting for Microsoft Office Professional 12 3 Installing the worker manager server 13 3.1 Hosting Invariant Kepler services in HTTPS 13 3.2 Running the handlers installer 14 3.2.1 Installing the Invariant database to a non-default SQL Server port 14 3.3 Invariant installation files 15 3.4 Installing the Invariant queue manager 15 3.4.1 Starting the queue manager service 23 3.5 Installing the worker 23 3.6 Troubleshooting the worker manager server installation 25 ARCHIVED3.7 Invariant DBupdater considerations 26 3.8 Uninstalling or repairing the worker manager server 26 3.8.1 Configuring the worker manager server in your environment 27 Relativity | Worker Manager Server Installation Guide - 2 3.9 Entering the ProcessingWebAPIPath instance setting 30 3.10 Installing the NIST database 31 4 Upgrading a worker manager server installation 33 4.1 Upgrade exceptions 34 4.2 Installing Microsoft Visual C++ Redistributable Packages 34 4.3 Upgrading the Invariant Queue Manager 34 5 Using the handlers installer 35 5.1 Requirements for running the handlers installer 35 5.2 Compatibility matrix 35 5.3 Running the handlers installer 36 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. To install the Invariant database, queue manager, and workers,VERSION you'll use an installation input file to enter your preferences into a text file that the installer then uses to install the Invariant components. n Invariant Database -this databaseis a queueused to track jobs submitted to Invariant. n 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. n 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 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 requiredARCHIVED security and other configuration settings. For more information about software and hardware requirements, see the System Requirements Guide. Relativity | Worker Manager Server Installation Guide - 3 2.1 Install Relativity Before you install the worker manager server, make sure that you install Relativity. For more information, see the Relativity 9.6 Documentation site. 2.2 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, such as Lotus Notes and Adobe Reader, for example. Software Description Required for system installation? Windows Server 2016 or Windows Required server software. Yes Server 2012 R2 .NET Version 4.7 Required server software. Yes .NET Version 4.6.2 .NET Version 3.5 Desktop Experience (Windows Required server software. Yes Server feature) Microsoft Office 2010 Professional This includes: Yes SP2 (32-bit) n Excel – used for ProcessingVERSION or and Native Imaging ofmost Microsoft Office 2013 Professional spreadsheet based doc- (32-bit)* uments (xlsx, xlsm, xlsb, odc, ods, etc.). Note: *Some features found in files n Word – used for Processing created in different versions of and Native Imaging of Office may not be available or DOCX, DOCM, DOTX, render correctly when processed DOTM, DOC, etc. or imaged using a different version n Powerpoint – used for Pro- than the file was originally created cessing and Native imaging in. For more information about features differences between ofPPTX, PPTM, PPSM, Office versions, please consult the POTX, POTM, etc. appropriate Microsoft n Outlook –used for Pro- documentation. cessing and Native imaging ofPST, OST, etc. n OneNote–used for Pro- cessing and Native Imaging of ONE and TMP files, etc. n Publisher – used for Pro- ARCHIVEDcessing and Native Imaging of PUB files, etc. Relativity | Worker Manager Server Installation Guide - 4 Software Description Required for system installation? 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. Microsoft Works 6–9 File Con- If you install Microsoft Office 2013, Yes verter then the Microsoft Works n This is only required if you're Converter is also required. There are two ways to get the Microsoft using Office 2013. Works 6–9 File Converter: n Download it here. n Through the Microsoft Office 2013 installer Microsoft Visio 2010 Professional Used for processing and imaging No or Standard SP2 (32-bit) VSD, VDX, VSS, VSX, VST, VSW files n This is only required for pro- (recommended) VERSIONcessing and imaging VSD, or VDX, VSS, VSX, VST, VSW Microsoft Visio 2013 Professional files.. You can still install pro- or Standard SP1 (32-bit) cessing without this com- ponent, but you won't be able to process or image those files without it. Microsoft Project 2010 Used for processing and native ima- No Professional or Standard SP2 (32- ging of MPP files. n This is only required for pro- bit) (recommended) cessing and imaging MPP or files. You can still install pro- Microsoft Project 2013 cessing without this com- Professional or Standard SP1 (32- ponent, but you won't be bit) able to process or image MPP files without it. Lotus Notes v8.5and higher Lotus Notes 8.5or higher is Yes required. It is recommended that n Lotus Notes v8.5.3 with Fix you installLotus Notes 9or higher Pack 6 on your workers, because Lotus ARCHIVEDn Lotus Notes v8.5.2 with Fix Notes version 8.5.x cannot read Pack 4 certain Lotus 9 databases. Please n Lotus Notes v9.0 note that some Lotus 9databases Relativity | Worker Manager Server Installation Guide - 5 Software Description Required for system installation? n Lotus Notes v9.0.1 cannot be opened in 8.5.x and will generate an error during processing. Note: The trial license of Lotus Notes can be used (even after the trial expires, Relativity can still use its DLLs). Adobe Reader 4.0 or higher Used for processing and native ima- Yes ging of PDF files. SolidWorks eDrawings Viewer 2016 Used for processing (text No (64-bit) extraction) and imaging for CAD n The Solidworks eDrawings files. This is the only optional or component. Viewer is not a pre-requisite Solidworks eDrawings Viewer 2017 for general use of Relativity n To download the viewer, go (64-bit) Processing. Solidworks is here and select either 2016 only required for performing or 2017 from the Select Ver- native imaging and text sion drop-down. extraction on any supported n Solidworks 2017 support CAD files in your data began in Relativity sources. You should install it 9.5.196.102. only on theworker des- VERSIONignated to perform these types ofjobs. Ifyou 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 Solid- works viewer, you can retry that error and proceed with your processing job. JungUm Global Viewer v9.0 or This is required for processing and Yes higher imaging GUL files (for Korean doc- uments). Hancom Office Hanword 2014 Used for processing and imaging No Viewer HWP files. n This is only required for pro- cessing and imaging HWP files. You can still install pro- ARCHIVED cessing without this com- ponent, but you won't be able to process or image Relativity | Worker Manager Server Installation Guide - 6 Software Description Required for system installation? 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. 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 com- Software component ponent Worker See Required permissions below. Database Windows Server 2012, Windows Server 2012 R2, or Windows Server 2008 R2 Queue manager n Windows Server 2012, Windows Server 2012 R2, or Windows Server 2008 R2 n .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. VERSION You aren't required to install the Invariant database and Queue Manager on the same server, but you have the option of doing so.