relativity upgrade guide - 8...relativity|upgradeguide-4 6.6rarupgradenotes 41 6.7upgradetheviewer...

Upgrade GuideVersion 8.2 | May 2, 2014

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

http://help.kcura.com/8.2/

Relativity | Upgrade Guide - 2

Table of Contents

1 Relativity upgrade overview 5

2 Required upgrade steps for all Relativity versions 5

2.1 Review system and other requirements 5

2.2 Back up your Relativity environment 5

2.3 Obtain credentials for service and database accounts 5

2.4 Reboot machines with Windows updates 6

2.5 Download the Relativity installer 6

2.6 Complete procedures for your upgrade path 6

3 Notes about Relativity features when you upgrade 7

3.1 Optionally set the RelativityInstanceURL configuration value 7

3.2 Addressing custom solutions pre-upgrade 7

3.3 Licenses for processing servers 7

4 Running the installer for an upgrade 7

4.1 Recommended upgrade workflow 8

4.1.1 Additional upgrade information 8

4.1.2 Steps for the upgrade workflow 8

4.2 Primary SQL server upgrade 9

4.3 Upgrading with Procuro 12

4.3.1 Best practices for running Procuro 12

4.3.2 Running Procuro 13

4.3.3 Troubleshooting distributed server upgrades 18

4.4 Distributed SQL server upgrade 18

4.5 Upgrade for passive SQL cluster nodes 20

4.6 Agent server upgrade 20

4.7 Web server upgrade 23


4.7.1 Upgrading a web server for Active Directory Authentication (mixed mode authen-tication) 27

4.7.2 Manually modify web.config file 29

4.7.3 Upgrading mixed-mode authentication web servers 30

4.7.4 Verifying application pool modes 31

4.8 Analytics server upgrade 32

4.9 Upgrade troubleshooting 33

4.9.1 Script failures 35

5 Upgrading from Relativity 6.x to 8.2 36

5.1 dtSearch index considerations 36

5.2 License Relativity 36

5.3 Pre-installation steps for web servers 36

5.3.1 Setting IIS options 36

5.3.2 Setting role services on web server 37

5.4 Upgrade the viewer 37

5.5 Upgrade agents and other components 37

5.6 Upgrading/installing Relativity Analytics 8.2 38

5.7 Document Table Trigger Removal Considerations 38

6 Upgrading from Relativity 7.x to 8.2 38

6.1 dtSearch index considerations 38

6.1.1 Adding dtSearches as choices to resource pools 38

6.2 Analytics upgrade notes 39


6.4 License Relativity and Processing 40

6.4.1 Relativity installations only 40

6.4.2 Relativity installations with Processing 40

6.5 Processing upgrade notes 40


6.6 RAR upgrade notes 41

6.7 Upgrade the viewer 41

6.7.1 Configure the viewer drawing delay 41

6.8 Upgrade custom applications or code 42

7 Upgrading from Relativity 8 to 8.2 42

7.1 Content Analyst upgrade and installation 42

7.2 Performance metrics and recommendations 43

7.3 Structured Analytics field updates 43


7.5 Document Table Trigger Removal Considerations 44

8 Upgrading from Relativity 8.1 to 8.2 44


8.2 Production sets 44


8.4 Structured analytics field change 45

9 Upgrading or installing Relativity Analytics 8.2 45

9.1 Pre-installation requirements 45

9.2 Running the installer 46

9.2.1 Changing the REST password 53

9.2.2 Addressing "Could not configure security" installer warning 53

9.3 Installing Analytics server when SQL Server uses SSL encryption 53

9.3.1 Install a SQL Server certificate in the Analytics server KeyStore 54

9.3.2 Use the CN property of a SQL Server certificate in Relativity 54

9.4 Uninstalling the Relativity Analytics server 55


1 Relativity upgrade overviewUse the following steps to upgrade your current Relativity installation to a new version. The upgradeprocess includes confirming that you have the prerequisites and system credentials, performingtasks specific to your upgrade path, and running the installer. As a best practice, kCura recommendscompleting the post-installation verification tests to confirm that your environment has beenupgraded properly.

As a best practice, kCura recommends preparing for your upgrade process by using the Pre-UpgradeChecklist. You can use this document to discuss an upgrade strategy for your current installation ofRelativity with the Client Services team ([email protected]) . For information about specificupgrade paths, see Complete procedures for your upgrade path on the next page.

If you are installing Relativity for the first time, contact the Client Services team([email protected]) for additional information. You may also want to review the information onthe Relativity installation page on the Relativity 8.2 Documentation site.

2 Required upgrade steps for all Relativity versionsYou should complete the following steps for all upgrades of Relativity. Depending on your upgradepath, you may have additional configuration or other tasks to perform specific to the version ofRelativity that you want to install.

2.1 Review system and other requirementsConfirm that your environment is configured with the prerequisites before you begin upgradingRelativity. See the following documents for more information:

n Relativity System Requirements - Includes software and hardware requirements for servers, databases,and other components of a Relativity installation.

n Relativity Workstation Configuration guide - Includes information about setting up workstations forusers and viewer installation instructions.

n Relativity Environment optimization guide - Includes best practices for maintaining and optimizing aRelativity environment.

n Upgrade path instructions - Contain detailed information about requirements for your specific upgradepath. See Complete procedures for your upgrade path on the next page.

2.2 Back up your Relativity environmentBack up your SQL databases and your Relativity IIS websites before you begin the upgrade process.

2.3 Obtain credentials for service and database accountsTo upgrade Relativity, you need credentials for the following accounts:


n Relativity Service account (Windows Workgroup/Domain account) - Run the Relativity upgrade loggedin as the Relativity Service account. This account must have local Administrator permissions on the tar-get server, and SQL sysadmin role privileges on the SQL server.

n EDDSDBO account (SQL account)

Note: Do not begin the upgrade process until you obtain the credentials for these accounts. They arerequired when you run the installer.

2.4 Reboot machines with Windows updatesAfter installing Windows updates, reboot your machines before attempting to install Relativity.Complete this step to ensure that all Relativity components are properly installed. IncompleteWindows updates lock system files, which may cause silent failures and prevent the properinstallation of Relativity components.

2.5 Download the Relativity installerUse these instructions to download the Relativity installation package from the Relativity CustomerPortal:

1. Log in to the Customer Portal with your account credentials.2. Browse to the Content section of the portal.3. Select the Relativity Installation Packages checkbox under Filter Your Results to filter the list.4. Click the link for installation package.5. Click Download to save a copy of the installation package to root of the C:\ drive. Save this package on

all required servers, such as Agent, SQL, and Web.

2.6 Complete procedures for your upgrade pathEach upgrade path has specific instructions that you must complete to ensure that Relativity isproperly installed and configured in your environment. Use the instructions required for yourupgrade path:

n Relativity 8.1 to 8.2 - See Upgrading from Relativity 8.1 to 8.2 on page 44.n Relativity 8 to 8.2 - See Upgrading from Relativity 8 to 8.2 on page 42.n Relativity 7.x to 8.2 - See Upgrading from Relativity 7.x to 8.2 on page 38.n Relativity 6.x to 8.2 - See Upgrading from Relativity 6.x to 8.2 on page 36.n Relativity 7.0 to 7.x - See Upgrade Guide (versions 7.0 to 7.x) on the Relativity 7.5 Documentation site.n Relativity 6.x to 7.x - See Upgrade Prerequisites for 6.x to 7.x.n Relativity 5.x to 7.x - If you are upgrading from Relativity version 5.x, you need to upgrade to Relativity

6.10 beforemoving to version 7.0. For additional information, see the Relativity Upgrade Guide v6.10on the Customer Portal and Upgrade Prerequisites for 6.x to 7.x.


3 Notes about Relativity features when you upgrade

3.1 Optionally set the RelativityInstanceURL configuration valueYou can optionally set the RelativityInstanceURL configuration value for your environment, whenyou upgrade Relativity. This configuration value can be can be referenced by applications designedto provide an external links to users. Developers creating applications that utilize the user-friendlyURL feature may also want to reference this configuration value when they create external links totheir applications. For more information, see Configuration table and Configuration table values onthe Relativity 8.2 Documentation site.

3.2 Addressing custom solutions pre-upgradeBefore upgrading, consider that your environment may contain custom components that are notcompatible with your new version of Relativity.

Custom components may include scripts, event handlers, agents, applications, or in-house developedcode that is not part of a standard Relativity deployment.

To help you address potential compatibility issues, you can run a script prior to upgrade thatidentifies the custom components developed by kCura Custom Development.

There are currently three versions of this script available on the Relativity Customer Portal:

n Relativity - KCD Solution Snapshot - 8.0 - 8.1n Relativity - KCD Solution Snapshot - 7.5n Relativity - KCD Solution Snapshot - 7.0-7.4

To access these scripts, log in to the Customer Portal and search for "KCD Solution Snapshot."

Make sure to run the script and send the results to [email protected] for analysis several weeksbefore your planned upgrade.

3.3 Licenses for processing serversWhen you apply a new processing license in your Relativity environment, all jobs in the processingqueue must complete before Relativity identifies any additional processing servers that you mayhave purchased as licensed. For more information, see Upgrading a processing server installation onthe Relativity 8.2 Documentation site.

4 Running the installer for an upgradeYou can run the Relativity installer to upgrade your application-dependent servers. Begin theupgrade during your scheduled downtime to ensure that you can complete the entire process.Interrupting the upgrade process results in a system failure.

mailto:[email protected]


4.1 Recommended upgrade workflowThe Relativity upgrade workflow involves running the installer on SQL server, and then runningProcuro to upgrade the schema for master (EDDS) database. Next, you need to the run the installeron the distributed database, agent, and web servers before you can upgrade the workspaces in yourRelativity installation. Since agents run the jobs for upgrading the scripts and applications inworkspaces, you must upgrade at least one Agent server before you can begin upgradingworkspaces in your environment.

Note: If you want to set up a single server installation of Relativity, check all applicable components on theFeature Selection dialog that appears when you run the installer. During a single server installation, theinstaller won't add any component that isn't checked for a new installation, and it removes any uncheckedcomponents during an upgrade.

4.1.1 Additional upgrade informationReview the following list of suggested or optional tasks before you begin your upgrade:

n Optionally upgrade servers simultaneously - You can upgrade the Agent server and Web server sim-ultaneously, or you can complete these task sequentially. See step 6 in Steps for the upgrade workflowbelow.

Note: Before upgrading these servers, make sure that you run Procuro to update the EDDS. Ensure that jobsaren't running on the Agent server, and that the agent services and IIS are stopped. See Steps for the upgradeworkflow below.

n Optionally configure upgrade agents via Procuro - You can optionally configure the upgrade agents lis-ted in step 6 through Procuro immediately after the EDDS upgrade runs. By using this option, youdon't have to log in to Relativity to configure agents through the UI. However, you must upgrade theAgent server before you can run these agents. See step 6 in Steps for the upgrade workflow below.

n Canceling upgrades for workspaces - The Procuro automatically sets the status on all workspaces toPending, which means they are added to the upgrade queue. The agents immediately begin upgradingworkspaces. If you don't want to upgrade a specific workspace, you can cancel the upgrade from theWorkspace Upgrade queue when this process starts.

4.1.2 Steps for the upgrade workflowUse the recommend workflow to ensure that upgrade process completes successfully:

1. Make sure that you have the appropriate System Admin permissions in Relativity before beginning theupgrade. For more information, seeManaging security on the Relativity 8.2 Documentation site.

2. Confirm that jobs aren't running in any of the queues. If the agents are running, they may attempt torun a job against database, which doesn't have an upgraded schema, and cause serious errors in yourRelativity environment.

3. Stop all agent services and the IIS. On the IIS, type iisreset /stop at the command prompt.4. Run the Relativity installer on your Primary SQL server, where your EDDS database resides. See Primary

SQL server upgrade on the next page.


5. Run the desktop version of Procuro, also called the Relativity Database Upgrader, on the Primary SQLserver to upgrade the EDDS database and install the required library applications. You can't access yourRelativity environment until you complete this step. See Upgrading with Procuro on page 12.

Note: After you run the installer on at least one agent server, the system begins upgrading individualworkspaces. You can now log in to Relativity to monitor workspace upgrades via the Workspace Upgradequeue. See step 9.

6. Run the Relativity installer on these servers in the following order or simultaneously:a. Agent server - see Agent server upgrade on page 20.b. Web server - seeWeb server upgrade on page 23.

7. Restart the IIS. At the command prompt, type iisreset /start.8. Log in to Relativity.9. (Optional) Click theWorkspace Upgrade queue. Set the priority or order on the workspaces as neces-

sary. For more information, see Upgrading workspaces on the on the Relativity 8.2 Documentation site.10. Add the following upgrade agents unless you have already configured them via Procuro. For more

information, see Agents on the on the Relativity 8.2 Documentation site.n Application Installation Managern Workspace UpgradeManagern Workspace UpgradeWorker

11. Monitor workspace upgrades in theWorkspace Upgrade queue. For more information, see Upgradingworkspaces on the on the Relativity 8.2 Documentation site.

4.2 Primary SQL server upgradeComplete the following steps to upgrade the primary SQL server:

1. Navigate to the location of the Relativity.exe file.2. Right-click the Relativity.exe file and select Run as Administrator.3. Execute the file to run the setup.4. Click Next on theWelcome dialog. The installer automatically selects the features of Relativity that

already exist on the server.


Note: The Automatically upgrade config files option provides functionality available only to Web servers.

5. Click Next to display the Primary Database Server Configuration dialog.

6. Enter the following information:

n Primary Database Server Instance - enter the name of the server instance. This entry is used toidentify the SQL server account. See the Database server setup on the Pre-installation page ofthe Relativity 8.2 Documentation site.

n EDDSDBO Password - enter and confirm the password for the EDDS database.


7. If you are upgrading from Relativity 8.1 or below, click Next to display the File Share Configuration dia-log. Otherwise, continue with step 9.

8. From the EDDS File Repository Path drop-down menu, select the path for the file share used to storeshared Relativity components at the environment level.

9. Click Next to display the SQL Login dialog.

10. Click Browse to select the name of SQL instance where you are installing Relativity.


Note: Don't enter localhost. Instead, enter the name of the server\instance.

11. Select an authentication method:n Windows Authentication (recommended)n Server authentication

12. Click Next to display the Search Provider Configuration dialog.

13. Verify that the Search Provider file location is correct.14. Click Next to to display the Ready to Install Program dialog, and then click Install.15. Click Finish on the Relativity Installation Completed dialog. Procuro immediately appears so that you

can run upgrade scripts on your primary SQL database. See Upgrading with Procuro below.

Note: When you run Procuro, it sets the status on all workspaces to Pending, which means they are added toqueue so that agents can immediately begin upgrading them. If you don't want to upgrade a specificworkspace, you can cancel the upgrade from the Workspace Upgrade queue when this process starts.

4.3 Upgrading with ProcuroAfter you upgrade the SQL server, you need to run Procuro, which is a utility used to upgrade theschema for master (EDDS) database. Procuro installs custom SQL scripts on the Relativity ScriptLibrary tab and the required applications available on the Application Library tab.

4.3.1 Best practices for running ProcuroUse these best practices when running Procuoro:

n You must upgrade the EDDS database on the primary server before you can upgrade any other data-bases. Concurrent custom SQL updates aren't supported.


n Since Relativity limits the number of workspaces upgraded concurrently by theWorkspace UpgradeWorker and Application Installation Manager agents, you don’t need to createmany of them. Bydefault, Relativity limits the number ofWorkspace UpgradeWorkers so you can only upgrade two work-spaces on the same SQL Server at a time. You can configure this number in the GlobalWork-spaceUpgradeLimit config value.The Application Installation Managers can only upgrade a singleworkspace at a time. In addition, you can only run a singleWorkspace UpgradeManager per RelativityEnvironment.

n Use a version of Procuro that matches or exceeds your Relativity version. If you are running an out-dated version of Procuro, an error message is displayed when you upgrade. Resolve the error by updat-ing Procuro to match your Relativity version.

n Avoid canceling an upgrade. When you click Cancel, Procuro finishes the current operation and stops.Your EDDS doesn't include all the required updates for the new version of Relativity, so you must rerunProcuro.

n Request a new license when upgrading a Relativity installation that uses Processing. For more inform-ation, see Upgrading from Relativity 7.x to 8.0 or Upgrading from Relativity 6.x to 8.0.

n For Relativity 8.2 and above, you don't use Procuro, the Relativity Database Upgrader, to perform work-space upgrades. Instead, log in to Relativity and navigate to theWorkspace Upgrade queue to monitorthe status of workspace upgrades.

4.3.2 Running Procuro

In Procuro, the icon indicates that an upgrade task is running. The icon indicates that the taskis completed or that you don't need to complete the task at this time. You must have theappropriate Admin permissions to run Procuro. For more information, see Managing security on theRelativity 8.2 Documentation site.

Use this procedure to run the Procuro:

1. Complete the installation steps on your primary SQL server to display Procuro automatically. SeePrimary SQL server upgrade on page 9.


2. Click Upgrade to run the scripts for the EDDS upgrade. The icon for the SQL Prefix Updater appears assince running these scripts isn't required for an upgrade.

Note: If an error occurs during the EDDS upgrade, manually resolve the issues, and then click Update to retrythis process.


3. Click Nextwhen the icon for the EDDS Upgrade appears. The Required Upgrade Agents dialogappears.


4. Complete the following tasks to add upgrade agents to the Agent to configure box:n Select the Agent server where you want to run the agent.n Select the number of agents that you want to run.

Note: Since multiple connections are available for the Workspace Upgrade Worker and ApplicationInstallation Manager agents, you don't need to create many of them. The default value for these agentsis two. In addition, you can only run a single Workspace Upgrade Manager per Relativity environment.

n Click Add to display your selections in the Agent to configure box.5. (Optional) Click Remove if you don't want to configure an agent added to the Agent to configure box.6. Click Configure Agents to create the selected agents in Relativity.


7. Click Finish to display the Database Upgrade Complete dialog. If necessary, click Close on this dialog.

After Procuro creates the upgrade agents, you can view them on the Agents tab in the Relativity asshown in the following illustration:

You can also monitor the workspace upgrades from theWorkspace Upgrade queue available fromHome. After Procuro completes, it sets all the workspaces to a status of Pending, so the agentsimmediately start running upgrade jobs on them.


4.3.3 Troubleshooting distributed server upgradesComplete the following tasks to troubleshoot your environment when running Procuro on adistributed server:

n In the EDDS Master Database, confirm that the Resource Server table is set to the correct machinename instead of localhost.

n Confirm that@@SERVERNAME is set to the primary SQL Server instance name instead of localhost.n In the EDDS Master Database, on the Procuro Status table, clear the Status andMachine Name

columns and restart Procuro.n Confirm that the following paths in the database exist on the distributed server:

o BaseApplicationPath - Root path where Procuro looks for required Relativity Applicationso BaseRelativityScriptPath - Root path where Procuro looks for SQL scripts

4.4 Distributed SQL server upgradeIf your Relativity environment uses a distributed SQL server, then you need to run the installer onthis machine.

Use the following procedure for a distributed SQL server installation:

1. Right-click on the Relativity.exe and select Run as Administrator.2. Execute the file to run the setup.3. On theWelcome dialog, click Next. The installer automatically selects theDistributed Database Server

checkbox on the Feature Selection dialog.


Note: The Automatically upgrade config files option provides functionality available only to web servers.

4. Click Next to display the SQL Login dialog.

5. Click Browse to select the name of SQL instance where you are installing Relativity.

Note: Don't enter localhost. Instead, enter the name of the server\instance.


6. Select an authentication method:n Windows authentication (recommended)n Server authentication

7. Click Next to display the Search Provider Configuration dialog.

8. Verify the Search Provider file path is correct.9. Click Install to begin the upgrade installation process.10. Click Finishwhen the SQL Server upgrade is complete.

4.5 Upgrade for passive SQL cluster nodesWhen using an Active/Passive SQL environment, you need only run the Relativity installer on theActive node.

To upgrade the Passive node as well, copy the following directory to the Passive node:

n [Installed drive]:\Program Files\kCura Corporation\Relativity

If this path does not exist on the Passive node, create the necessary folder structure, as shownbelow:

n [Installed drive]:\Program Files\kCura Corporation\

This directory pathmust be identical across the Active and Passive nodes.

4.6 Agent server upgradeBefore upgrading the agent server, confirm that you upgrade the SQL server and start the SQLservice. For more information, see Recommended upgrade workflow on page 8.


1. Open folder where Relativity.exe is located.2. Right-click the Relativity.exe file and select Run as Administrator. Execute the file to run the setup.

3. Click Next to display the features of Relativity that already exist on the server.

Note: To ensure that Relativity functions properly, confirm that agents can connect to a valid Services APIendpoint. Configuring your Agent service to utilize the self-hosted Services API endpoint requires minimalconfiguration and results in better performance. For more information, see Testing the Services API on theRelativity 8.2 Developers site.For more information, see Testing the Services API on the Relativity 8.2Developers site.

https://platform.kcura.com/8.2#RSAPI/Configuration_overrides_and_troubleshooting/Testing_the_Services_API.htm


Note: The Automatically upgrade config files option provides functionality available only to web servers.

4. Click Next to display the Primary Database Server Configuration dialog.

5. Enter the following information:n Server\instance name of the Primary SQL Servern EDDSDBO account password and confirmation of the password

6. Click Next.


7. Enter the Relativity Service Account username and password. The format is Domain\username fordomains andMachinename\username for workgroups.

8. Click Next.9. Click Install to begin the upgrade installation process.10. Click Finishwhen the Agent Server upgrade is complete.11. Verify that your agents are started by looking in the Event Viewer.

Note: The Relativity Compare functionality runs through the WebAPI of one of your web servers. The webserver requires internet access for Relativity Compare to work properly in Relativity 5.09.587.1 as well asversions 7.0 and higher.

12. Upgrade theWeb server. SeeWeb server upgrade below or Recommended upgrade workflow onpage 8.

4.7 Web server upgradeComplete the following steps to upgrade the Web server.

Note: The Relativity Services Account is required for Web server upgrades. Enter credentials as necessaryduring the upgrade.

1. Stop IIS.2. Open the folder where Relativity.exe is located and move this file to the root of the C:\ drive.3. Right-click the Relativity.exe file and select Run as Administrator. Execute the file to run the setup.4. Click Next on theWelcome dialog. The installer displays the features of Relativity that already exist on

the server.


Note: Relativity requires that the Services API is installed and running on your web server. To ensure that yourRelativity instance functions properly, don't disable Relativity.Services on the IIS.

5. Verify the Automatically upgrade config files checkbox is selected. When this option is selected on theweb server, the installer creates backup copies of the configuration files. It adds them to the followinglocation on your server:<InstallationDirectory>\kcura corporation\Relativity

Each backup file name consists of its original folder name, appended with the configuration file name,and tick count indicating the creation time. The following examples illustrate how the files are named:

n relativityservices.Web.634381274220793739.configOLDn web.Web.634381274227299893.configOLDn webapi.Web.634381274226479297.configOLDn webdistributed.Web.634383046503301373.configOLD

If you do not select Automatically upgrade config files, you must modify the web.config file manually.SeeManually modify web.config file on page 29.

6. Click Next.7. Enter the following information:

n Server\instance name of the Primary SQL Servern EDDSDBO account password and confirmation of the password


8. Click Next to display the SQL Login window.9. Verify the database server and authentication method settings. Modify the SQL instance name and

authentication configuration if necessary. Click Next.

10. Verify the Search Provider files installation path. Click Browse to select the Search Provider files install-ation path if necessary. Click Next.


11. Enter the Relativity Service Account login credentials:n Relativity Service Account User Namen Relativity Service Account Password

12. Click Next.13. Click Install to start the upgrade.

Note: If the following error message is displayed, contact the Client Services team ([email protected]) toobtain detailed instructions for manually updating your config files.


14. Click Finishwhen theWeb Server upgrade is complete.15. Restart IIS. When you finish the upgrade, ensure that all users clear their browser cache. See this pro-

cedure on theMicrosoft web site: http://windows.microsoft.com/en-US/windows-vista/Delete-tem-porary-Internet-files.

16. Add the upgrade agents, if they currently don't exist. See Recommended upgrade workflow on page 8.

4.7.1 Upgrading a web server for Active Directory Authentication (mixed modeauthentication)Use the following steps to upgrade a web server with mixed mode authentication and an activedirectory site:

1. Migrate the existing contents of your Relativity AD folder to a backup folder in another location.2. Copy the contents of the Relativity Folder to your Relativity AD folder.


3. Update the web.config file in the following three locations:n EDDS foldern EDDS.Distributed foldern WebAPI folder

4. The updated web config files replace the asterisk (*) with a question mark (?) and allow the author-ization process to deny as shown below. The authentication mode value changes from "Forms" or"None" to "Windows".


5. Repeat the above steps on each webserver in the environment.

4.7.2 Manually modify web.config fileIf you do not select the Automatically upgrade config files check box, you must manually modifythe web.config file. Locate the following section in the web.config file and add the bolded entries.

<?xml version="1.0"?><configuration>

<system.webServer><modules>

<add type="DevExpress.Web.ASPxClasses.ASPxHttpHandlerModule,DevExpress.Web.v9.3, Version=9.3.2.0, Culture=neutral,PublicKeyToken=b88d1754d700e49a" name="ASPxHttpHandlerModule"/><remove name="AnonymousIdentification"/><add name="AnonymousIdentification"type="System.Web.Security.AnonymousIdentificationModule" preCondition=""/><remove name="FileAuthorization"/><add name="FileAuthorization" type="System.Web.Security.FileAuthorizationModule"preCondition=""/><remove name="FormsAuthentication"/><add name="FormsAuthentication"type="System.Web.Security.FormsAuthenticationModule" preCondition=""/><remove name="OutputCache"/><add name="OutputCache" type="System.Web.Caching.OutputCacheModule"preCondition=""/><remove name="Profile"/>


<add name="Profile" type="System.Web.Profile.ProfileModule" preCondition=""/><remove name="RoleManager"/><add name="RoleManager" type="System.Web.Security.RoleManagerModule"preCondition=""/><remove name="Session"/><add name="Session" type="System.Web.SessionState.SessionStateModule"preCondition=""/><remove name="UrlAuthorization"/><add name="UrlAuthorization" type="System.Web.Security.UrlAuthorizationModule"preCondition=""/><remove name="WindowsAuthentication"/><add name="WindowsAuthentication"type="System.Web.Security.WindowsAuthenticationModule" preCondition=""/><remove name="UrlRoutingModule-4.0"/><add name="UrlRoutingModule-4.0" type="System.Web.Routing.UrlRoutingModule"preCondition=""/>

</modules></system.webServer>

</configuration>

4.7.3 Upgrading mixed-mode authentication web serversRelativity supports both forms and Active Directory authentication in a single instance. This is doneby creating an additional website that enforces Windows AD authentication. External users areauthenticated via a username and password over SSL while internal users do not need to login (usingAD authentication).

If your Relativity instance has been configured for Mixed-Mode Authentication, you need tocomplete the additional steps to update the AD authenticated website manually. Before starting theupdate, disable IIS and copy the entire kCura directory on the Web Server as a backup copy.

1. Copy the following content, including each web.config file, from the original install (Forms Authentic-ation) location into the Active Directory folder to overwrite the current files:

n [Installed drive]:\Program Files (x86)\kCura Corporation\Relativity\EDDS - Copy contents andreplace the Active Directory files, i.e., [Installed drive]:\Program Files (x86)\kCura Cor-poration\RelativityAD\EDDS

n [Installed drive]:\Program Files (x86)\kCura Corporation\Relativity\EDDS.Distributed - Copycontents and replace the Active Directory files, i.e., [Installed drive]:\Program Files (x86)\kCuraCorporation\RelativityAD\EDDS.Distributed

n [Installed drive]:\Program Files (x86)\kCura Corporation\Relativity\Relativity.Services - Copycontents and replace the Active Directory files, i.e., [Installed drive]:\Program Files (x86)\kCuraCorporation\RelativityAD\Relativity.Services

n [Installed drive]:\Program Files (x86)\kCura Corporation\Relativity\HTML Area - Copycontents and replace the Active Directory files i.e., Installed drive]:\Program Files (x86)\kCuraCorporation\RelativityAD\HTMLArea (there is no web.config for this virtual directory)

Note: Don't save your old web config files. The new files contain references to .NET 4 framework thatdon't exist in the Relativity 6.x web.configs.


n [Installed drive]:\Program Files\kCura Corporation\Relativity\WebAPI - Copy contents andreplace the Active Directory files, i.e., [Installed drive]:\Program Files\kCuraCorporation\RelativityAD\WebAPI

n [Installed drive]:\Program Files\kCura Corporation\Relativity\Relativity.REST - Copy contentsand replace the Active Directory files, i.e., [Installed drive]:\Program Files\kCura Cor-poration\RelativityAD\Relativity.REST

2. Update the authentication and authorization sections in all web.config files except Relativity.Services tomatch the following format:

n <authentication mode="Windows">n <authorization><deny users="?" /></authorization>

The following folders contain a web.config file:

n C:\Program Files\kCura Corporation\RelativityAD\EDDSn C:\Program Files\kCura Corporation\RelativityAD\EDDS.Distributedn C:\Program Files\kCura Corporation\RelativityAD\WebAPI

Note: The web.config file in the Relativity.Services folder only needs to be updated for 7.4 or lower.

Contact the Client Services team with any questions about themixed authentication upgrade.

4.7.4 Verifying application pool modesFor an upgrade from Relativity 6.x to versions 7.x or 8, you need to verify that all application poolswith an identity of (local machine)\RelativityServiceAccount are set to Integrated mode. (If you areupgrading from Relativity 7.x, your application pools are already set to Integrated mode.)


Use the following steps to verify or update this setting for your application pools:

1. Open the IIS Manager.2. Expand the website where Relativity is installed, and click on the Application Pools directory.

Note: Don't complete the following steps if the Managed Pipeline Mode is set to Integrated Mode for yourapplication pools.

3. Right-click on your application pool node. (For example, you may see a node called Relativity.)4. Select Advanced Settings.5. Select Integrated Mode for Managed PipelineMode.6. Repeat this process for each of the following application pools:

n Default AppPooln Relativityn Relativity.Distributedn Relativity.Servicesn RelativityWebAPIn Relativity.REST

4.8 Analytics server upgradeWhen upgrading to Relativity 8.2, you need to upgrade your Analytics server as well.


4.9 Upgrade troubleshootingThe Relativity installer includes a utility to execute custom SQL scripts on EDDS and workspacedatabases. In most cases, you run custom SQL scripts to apply updates across multiple databases.For example, you might need to run a script that adds an additional column to a database table. Youcan also use this utility to run custom SQL scripts for a failed upgrade.

Note: You can't use this utility to run scripts on disabled workspaces.

Use the following procedure to run the Custom SQL utility:

Note: Before running the utility, make sure that you have admin rights on the SQL server where thedatabases reside.

1. Double-click kCura.EDDS.CustomSQL.exe.2. Enter the following information on the Log In As EDDSDBO dialog. You may not need to enter this

information if you've already configured your credentials on the server.n Server Name - name of the database servern User Name and Password - name and password for SQL Server admin

3. Click Log In to display a database selection grid. This grid displays all workspaces, except disabled ones,that are available in the database. You can also search for specific workspaces by entering text in thetext box and selecting the columns that you want queried.


4. Select the workspaces that you want to run the custom SQL script against.5. Click Execute Custom SQL to display a dialog where you can enter your custom script.

6. Enter your custom script in the text box.7. Select the Include EDDS Database checkbox if you want the script to run on the EDDS as well as the

selected workspace databases.8. Click Execute to run the script. The dialog displays a progress bar, as well as the status and other inform-

ation about the script execution.


9. Click OK on the Upgrade Complete dialog, which displays the number of databases modified. This valueincludes the EDDS database if you selected to update it.

4.9.1 Script failuresWhen a script fails, you can view details about the error by clicking Show Details. You also receivean error message if you attempt to run a script against a disabled workspace, which can occur if auser disables a workspace while you are running the utility. To resolve this error, clear the checkboxfor the disabled workspace, and rerun the script.


5 Upgrading from Relativity 6.x to 8.2Use these instructions when upgrading from Relativity 6.x to 8.2. Before you begin this process,complete the steps in Required upgrade steps for all Relativity versions on page 5.

5.1 dtSearch index considerationsIf you're upgrading to Relativity 8.2 from any version of Relativity earlier than 8.0, note there is anew paradigm to configuring and building dtSearch indexes. Keep these items in mind about yourindexes after you upgrade:

n For indexes built in Relativity 5.9 or below, you must perform a Full Build for them to work normally.n Any active indexes built in Relativity 6.2 or above continue work normally.n After upgrading, you must initially perform a full build of a dtSearch index before you are able to run

incremental builds. You can then perform incremental builds, which follow the new paradigm.n For indexes that are in progress or in an error state when you upgrade, you must perform a Full Build.n Indexes with document level errors continue to work normally.

5.2 License RelativityAs part of the upgrade to Relativity 8.2, you need to apply a new Relativity license to yourinstallation. Run Procuro on all databases, and then request a new Relativity license key from kCuraClient Services, and apply the activation key. For more information, see the Relativity Licensingguide.

5.3 Pre-installation steps for web serversThis section describes pre-installation steps that are required for upgrading Relativity 6.xinstallations. They must be completed on all web servers before installing Relativity 8.2.

5.3.1 Setting IIS optionsUse these instructions to update IIS settings and other configuration options for environmentsrunning Windows Server 2008 or higher with IIS 7.5. These updates must be made on all web serversin your Relativity installation.

1. Install .NET Framework 4.0 on all web servers.2. Configure the Legacy Unhandled Exception Policy on all web servers.

a. Browse to the following directory on your web server: C:\Win-dows\Microsoft.NET\Framework64\v4.0.30319\

b. Open the Aspnet.config file in a text editor.c. Locate the tag <legacyUnhandledExceptionPolicy>. Set the enabled attribute to true.d. Save the changes to the file.

mailto:[email protected]?subject=Request for a new Relativity license key?subject=Request for a new Relativity license key

mailto:[email protected]?subject=Request for a new Relativity license key?subject=Request for a new Relativity license key


5.3.2 Setting role services on web serverRelativity 8.2 requires that you enable IIS 6 Metabase compatibility on all web servers.

1. Open the Server Manager.2. Right click on the Roles node, and select Role Services.3. On the Add Role Services window, highlight Role Services. Confirm that IIS 6Metabase Compatibility is

select as illustrated below. If necessary, enable or install this role service on your server.

5.4 Upgrade the viewerRelativity 8.2 uses Oracle Outside In version 8.4.0. When you upgrade to Relativity 8.2, you caninstall the new version of the viewer using the steps described in the Workspace Configurationguide. Any previous versions of the viewer aren't upgraded, but you can run two versions of theviewer concurrently, so there's no need to uninstall previous versions.

5.5 Upgrade agents and other componentsConfirm that your environment has all the required agents and other software components added inprior versions. For more information, see the Relativity Upgrade Guide v6.10 on the RelativityCustomer Portal.

If your environment uses custom applications, you may also need to upgrade event handlers, andother components. For more upgrade information, see the Relativity 8.2 Developers site.

Note: For information about recompiling syncs, contact the Client Services team ([email protected]).

http://rcp.kcura.com/home/home.jsp

http://rcp.kcura.com/home/home.jsp


5.6 Upgrading/installing Relativity Analytics 8.2An upgrade of your Analytics server is required for Relativity 8.2. To install Relativity Analytics 8.2,you must run the Relativity Analytics Server Setup wizard after installing or upgrading yourRelativity instance.

When you run the Relativity Analytics Server Setup wizard, you automatically do the following:

n Install the CAAT servicen Deploy the kCura library filesn Configure the java heap size (set by default to half of RAM)n Allow yourself to set an index path on new install, thus eliminating the need to manually set the loc-

ation of indexesn Set the CAATWindows service to log in as the Relativity Service Account

5.7 Document Table Trigger Removal ConsiderationsRelativity 8.1 included enhancements that may affect certain areas of your existing environmentwhen you upgrade. Improvements to the database schema make Relativity run faster in 8.1 than inprevious versions. If your environment contains custom-developed functionality that involves theRelationalIndex_X tables or explicitly uses the RI_X columns in the Document tables, then you shouldread this document.

6 Upgrading from Relativity 7.x to 8.2Use these instructions when upgrading from Relativity 7.x to 8.2. Before you begin this process,complete the steps in Required upgrade steps for all Relativity versions on page 5.

6.1 dtSearch index considerationsIf you're upgrading to Relativity 8.2 from any version of Relativity earlier than 8.0, note there is anew paradigm to configuring and building dtSearch indexes. Keep these items in mind about yourindexes after you upgrade:

n For indexes built in Relativity 5.9 or below, you must perform a Full Build for them to work normally.n Any active indexes built in Relativity 6.2 or above continue work normally.n After upgrading, you must initially perform a full build of a dtSearch index before you are able to run

incremental builds. You can then perform incremental builds, which follow the new paradigm.n For indexes that are in progress or in an error state when you upgrade, you must perform a Full Build.n Indexes with document level errors continue to work normally.

6.1.1 Adding dtSearches as choices to resource poolsWhen upgrading from Relativity 7.x, you need to create a choices with paths to your dtSearchrepositories, and then add these choices to the appropriate resource pools.

http://kcura.com/relativity/Portals/0/Documents/8.1_Documentation_Help_Site/index.htm#What_s_New_In_8.1/Document_Table_Trigger_Removal.htm?TocPath=What's new in Relativity 8.1|_____3


Use the following procedure to add dtSearches to resource pools:

1. Log in to Relativity.2. From Home, click the Choices tab.3. Click New Choice.4. In the Field option, select dtSearch Index Share Location.5. In theName option, enter the UNC path to the dtSearch repository that is shared with the Relativity

Services Account. The sharemust give this account read and write permissions.6. Click Save.7. Click the Resource Pools tab.8. Click on the name of the resource pool where you want to add the dtSearch choice.9. On the details view, locate the dtSearch Index Share Locations section.10. Click Add to display the Select dtSearch Index Share Locations dialog.11. Select the checkbox for your dtSearch Index Share Location and click OK. The details view nowdisplays

this share location in the dtSearch Index Share Locations section.

6.2 Analytics upgrade notesNote the following when upgrading to Relativity 8.2:

n In the Relativity Applications Library, the Analytics application contains the structured data analyticsfunctionality, and the Analytics Core application contains Analytics profiles, repeated content filters,and Analytics categorization sets.

Note: On upgrade to Relativity 8.2, you can choose whether or not to include the Analytics application(structured data analytics). The Analytics Core application deploys automatically.

n Beginning in Relativity 8, Primary Language Identification (PLI) is no longer supported. As a result, youdon't have to import PLI data into Relativity or set up a search index or categorization set to use PLI any-more. Instead, you can use the language identification operation when creating a Structured Data Ana-lytics set.

n Content Analyst 3.14 is required to use Analytics in Relativity 8.2.

See the Analytics Guide for more information on Language Identification.

6.3 Upgrading/installing Relativity Analytics 8.2An Analytics server upgrade is required for Relativity 8.2. To install Relativity Analytics 8.2, you mustrun the Relativity Analytics Server Setup wizard after installing or upgrading your Relativity instance.





6.4 License Relativity and ProcessingAs part of the upgrade to Relativity 8.2, you need to apply a new Relativity and optional Processinglicense to your installation.

6.4.1 Relativity installations onlyIf you aren't using Processing in your Relativity installation, run Procuro on all databases, thenrequest a new Relativity license key from kCura Client Services, and apply the activation key. Formore information, see the Relativity Licensing guide.

6.4.2 Relativity installations with ProcessingIf you are running Processing as part of your Relativity installation, complete the following steps toupgrade your licenses:

1. Run the Relativity installer on the Primary SQL server as described in Running the installer for anupgrade on page 7.

2. Run Procuro only on themaster (EDDS) database. See Upgrading a web server for Active DirectoryAuthentication (mixed mode authentication) on page 27.

3. Request a new Relativity license key from kCura Client Services, and apply the activation key. For moreinformation, see the Relativity Licensing guide.

4. Request a new Processing license key from kCura Client Services, and apply the activation key.

Note: You must apply the new Processing license before running Procuro. If you don't complete this step,Procuro can't upgrade your Processing application.

5. Run Procuro on your workspace databases.

6.5 Processing upgrade notesWhen upgrading the Processing application from 7.5 to Relativity 8.2, we strongly recommend thatyou first complete any outstanding processing sets in 7.5 before upgrading. However, note thefollowing if you perform an upgrade and outstanding processing sets exist in 7.5:

n All documents published in 7.5 will retain the 7.5 document numbering format of nine digits.n All documents published or republished in Relativity 8.2 will have the new 10 digit document num-

bering format. This new format extends to the Attachment Document ID, Parent Document ID, andGroup ID fields.

n Documents republished in Relativity 8.2 could potentially be duplicated with the new document num-bering format.

n Reference fields such as the Attachment Document ID, Parent Document ID, and Group ID on doc-uments republished in Relativity 8may not accurately reference the correct documents.

Specific versions of Invariant are exclusively compatible with specific versions of Relativity. For thisreason, don't attempt to upgrade Invariant independent of Relativity, as doing so will result insignificant issues. For example, don't upgrade from Invariant 3.2, which is supported by Relativity


8.1, to Invariant 3.3 without also upgrading to Relativity 8.2. The following table breaks down whichversions of Invariant are supported by which versions of Relativity:

Invariant version Relativity versionInvariant 3.0 Relativity 7.5Invariant 3.1 Relativity 8.0Invariant 3.2 Relativity 8.1Invariant 3.3 Relativity 8.2

6.6 RAR upgrade notesYou can upgrade an Assisted Review project while review is in progress for a round or betweenrounds. No work is required to ensure that Assisted Review operates properly in Relativity 8.2 beforeor after you upgrade Assisted Review from Relativity 7.5; however, it may be helpful to note thefollowing tasks that Relativity automatically completes when you upgrade Assisted Review.Relativity:

n Gives old rounds a round type value of 7.5.n Creates an Assisted Review saved searches folder if it didn't already exist.n Creates a project-specific saved searches folder.n Copies the project saved search to the new folder and creates four saved searches if categorization has

already occurred.n Sets all issues to a Medium Importance level.n Replaces the Net Change graph in the Round Summary with Volatility. Note that it will take several

rounds to generate volatility information; for example, if you upgrade prior to starting the fourthround, volatility displays in the report after you finish the fifth round.

Note: When upgrading from version 7.5 to 8.1, every project that is currently active (in the middle of around) will receive an error until you set the positive choice for designation.

6.7 Upgrade the viewerRelativity 8.2 uses Oracle Outside In version 8.4.0. When you upgrade to Relativity 8.2, you caninstall the new version of the viewer using the steps described in the Workspace Configurationguide. Previous versions of the viewer aren't upgraded, but you can run two versions of the viewerconcurrently, so there's no need to uninstall previous versions.

6.7.1 Configure the viewer drawing delayIf you anticipate multiple users using the same machine at the same time to perform a review, youcan use a registry value to establish a drawing delay in the image viewer. This is only recommendedwhen the standard refresh rate causes CPU utilization issues,which should only occur in a Citrixenvironment.


This value represents the number of milliseconds between calls to redraw the screen. In previousversions of Relativity, the image viewer behaved as though this value were set to 250. Increasingthis value will reduce CPU usage when creating and/or modifying redactions and highlights, but itwill also result in a choppier experience.

Changes to this value are not reflected in real-time, so you'll have to reload the image viewer forchanges to take effect.

To configure the drawing delay, perform the following steps:

1. Click the Start button and type regedit in the search box, then click Enter.2. Navigate to the appropriate location:

n If you're using a 64-bit OS, navigate to HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\kCura\ImageViewer

n If you're using a 32-bit OS, navigate to HKEY_LOCAL_MACHINE\SOFTWARE\kCura\ImageViewer

Note: If this is your first time using this feature, the ImageViewer registry key won't exist and you'll have tocreate it. To create this new key, right-click the kCura folder and hover over New, then click Key.

3. Right-click the ImageViewer folder and hover overNew, then click DWORD (32-bit) Value.4. Double-click the new value to open the Edit DWORD (32-bit) Value popup.5. In the Value name field, enter DrawingDelay.6. In the Value data field, enter the appropriate value for your environment.

6.8 Upgrade custom applications or codeIf your environment uses custom applications or code, you may also need to upgrade eventhandlers, and other components. For additional upgrade information, see the Relativity Developerssite.

7 Upgrading from Relativity 8 to 8.2Use these instructions when upgrading from Relativity 8 to 8.2. Before you begin this process,complete the steps in Required upgrade steps for all Relativity versions on page 5. ContactCustomer Support at [email protected] before upgrading.

7.1 Content Analyst upgrade and installationAn Analytics server upgrade is required for Relativity 8.2. To install Relativity Analytics 8.2, you mustrun the Relativity Analytics Server Setup wizard after installing or upgrading your Relativity instance.

For more information, see Upgrading or installing Relativity Analytics 8.2 on page 45.


7.2 Performance metrics and recommendationsSeveral Relativity features have seen significant performance increases in Relativity 8.1, includingimport, processing, searching, and Structured Analytics. For data on those increases and thespecifications of the environments on which the corresponding tests were run, see the PerformanceMetrics and Recommendations guide.

7.3 Structured Analytics field updatesRelativity 8.2 introduces the following field updates related to Structured Analytics:

n In Relativity 8.0, Structured Analytics Sets included a Preprocess extracted text field that allowed you touse a regular expression to reformat extracted text for analysis. In Relativity 8.2, the use of a regularexpression to reformat extracted text in a Structured Analytics Set is now handled by creating a RegularExpression type Repeated Content Filter and linking the filter to a Structured Analytics Set. This allowsyou to use the same regular expression across multiple Structured Analytics Sets without the need toenter the same expression multiple times. On upgrade, any existing Preprocess extracted text con-figurations in your Structured Analytics Sets are automatically converted to newRegular Expressiontype Repeated Content Filters and linked to the original Structured Analytics Sets.

n Email field mappings used by Structured Analytics Sets for fields such as Email From and Email To arenow stored in Analytics Profiles in a section named Email Threading Settings. When creating a Struc-tured Analytics Set for email threading, select an Analytics Profile containing your email field mappings.This allows you to use the same email field mappings with multiple Structured Analytics Sets withoutthe need to map the fields for every set running the Email threading operation. On upgrade, all fieldsused in the first existing Email Threading Set aremapped in the Default Analytics profile. The Default pro-file is then automatically linked to any other existing sets.

7.4 Processing upgrade notesThe following fields are removed from the Processing application and from the Processing setLayout:

n Filter by file extension(s)n File extensionsn Only apply filter to parent files

The above fields are remaining in already processed sets in case of retry. If new processing setshave values in those fields, they are cleared.

Specific versions of Invariant are exclusively compatible with specific versions of Relativity. For thisreason, don't attempt to upgrade Invariant independent of Relativity, as doing so will result insignificant issues. For example, don't upgrade from Invariant 3.2, which is supported by Relativity8.1, to Invariant 3.3 without also upgrading to Relativity 8.2. The following table breaks down whichversions of Invariant are supported by which versions of Relativity:



7.5 Document Table Trigger Removal ConsiderationsRelativity 8.1 included enhancements that may affect certain areas of your existing environmentwhen you upgrade. Improvements to the database schema make Relativity run faster in 8.1 than inprevious versions. If your environment contains custom-developed functionality that involves theRelationalIndex_X tables or explicitly uses the RI_X columns in the Document tables, then you shouldread this document.

8 Upgrading from Relativity 8.1 to 8.2

8.1 Processing upgrade notesSpecific versions of Invariant are exclusively compatible with specific versions of Relativity. For thisreason, don't attempt to upgrade Invariant independent of Relativity, as doing so will result insignificant issues. For example, don't upgrade from Invariant 3.2, which is supported by Relativity8.1, to Invariant 3.3 without also upgrading to Relativity 8.2. The following table breaks down whichversions of Invariant are supported by which versions of Relativity:


8.2 Production setsProduction sets run before you upgrade to Relativity 8.2 aren't available to select for merging withnew production sets when you select the new Existing production numbering choice. For moreinformation on new productions functionality, see the Admin guide.

8.3 Upgrading/installing Relativity Analytics 8.2An upgrade of your Analytics server is required for Relativity 8.2. To install Relativity Analytics 8.2,you must run the Relativity Analytics Server Setup wizard after installing or upgrading yourRelativity instance.


http://kcura.com/relativity/Portals/0/Documents/8.1_Documentation_Help_Site/index.htm#What_s_New_In_8.1/Document_Table_Trigger_Removal.htm?TocPath=What's new in Relativity 8.1|_____3




8.4 Structured analytics field changeUpgrading to Relativity 8.2 automatically updates the Minimum similarity percentage value forstructured analytics textual near duplicate identification to the new minimum value of 80 if it iscurrently set between 70-79. See Creating a structured analytics set in the Analytics Guide.

9 Upgrading or installing Relativity Analytics 8.2An upgrade of your Analytics server is required for Relativity 8.2. To upgrade to Relativity Analytics8.2, you must:

1. Install or upgrade your Relativity instance.2. Run the Relativity Analytics Server Setup wizard.


n Install the CAAT servicen Deploy the kCura library filesn Configure the java heap size (set by default to half of RAM)

o If you re-install the Analytics server after already adjusting the java heap size settings, the newinstallation will overwrite the java heap adjustments you made.

n Allow yourself to set an index path on new install, thus eliminating the need to manually set the loc-ation of indexes

n Set the CAATWindows service to log in as the Relativity Service Account

Note that earlier version of Relativity 8.2 support earlier versions of Content Analyst 3.15, as seen inthe following table:

Relativity version Supported Content Analyst versionPre-release 8.2 3.15.08.2.231.1 3.15.28.2.320.2 3.15.3

9.1 Pre-installation requirementsBefore completing the steps for upgrading to Relativity Analytics 8.1, make sure you've completedthe steps contained in the following sections:

1. Pre-installation requirements above2. Running the installer on the next page


You need the following items in order to successfully run the Relativity Analytics Server Setupwizard:

n A primary database server instance name and corresponding EDDSDBO password. If your SQL Serveruses SSL encryption, see Installing Analytics server when SQL Server uses SSL encryption on page 53before beginning the Analytics server installation.

n A valid Relativity service account username and password.o The Relativity Service Account must have the Full Control security setting for both the CAAT

install directory (e.g. C:\CAAT) and the optional index share directory.n .NET 4.5

In addition, note the following:

n All servers are required to be 64-bit.n Two different Relativity instances can't use the same Analytics server.n All SQL servers must be active and accessible at the time of the installation.n The web server needs to be able to communicate with the analytics server via TCP ports 445, 8080, and

8443.

9.2 Running the installerNote the following before running the Relativity Analytics Server Setup:

n We recommend running the server setup as the Relativity Service Account.n The account running the Relativity Analytics Server Setup packagemust have administrative rights to

both the Analytics server and the index share path in order to run the installer without interruption. Ifthe account doesn't have these rights, the installer will inform you that the directories can't be con-figured and that you must check to make sure that the permissions are correct.

Note: If a "Could not configure security for the following directories" warning occurs during yourAnalytics installation or upgrade, see Addressing "Could not configure security" installer warning onpage 53.

Verify the following permissions before running the Relativity Analytics Server Setup:

n The Relativity Service Account, the Users group, and the Administrators group has the Full Controlsecurity setting for both the CAAT install directory (e.g. C:\CAAT) and the optional index share directory.

n The Relativity Service Account is a member of both the local Administrators group and the local Usersgroup on the server.

n It may be necessary to disable UAC settings in your environment for the installer to completesuccessfully.

Follow these steps to run the Relativity Analytics Server Setup:

1. Open the Relativity Analytics Server Setup package. Right-click and click Run.2. Click Next on the server setup welcome screen.


3. Enter values for the following Primary Database Server Configuration fields and click Next:


n Primary Database Server Instance - the primary database to which you want to install the Con-tent Analyst service. The value you enter must match theName value recorded on the Serverstab in Relativity.

n EDDSDBO Password - the password to the EDDSDBO account of the primary database. If youchange the password to your primary database server instance, you must re-run the RelativityAnalytics Server Setup wizard.

n Relativity Service Account - the service account of the Relativity instance that is using this install-ation of Content Analyst. You must use the following format for the service account name:<domain>\<user>.

Note: If the machine running Analytics server runs Relativity as an all-in-one machine or isn't part of adomain, use the following format for the service account name: <machinename>\<user>.

n Relativity Service Account Password - the password for the Relativity instance.4. Enter values for the following REST API configuration fields and click Next. These values must match

those of the corresponding fields on the Analytics server object in Relativity. For more information, seeServers in the Admin Guide.

n REST Port - the port that the REST API will use via https. By default, this setting uses port 8443.n REST Username - the username that an admin or Relativity uses to authenticate with the

REST API. This can be any username that you choose, but for ease of use, you may want to enteryour Relativity Service account username. Whatever you enter here corresponds only with theREST API username field on the Analytics server that you will add in Relativity after you install theAnalytics server here. This value isn't related to any pre-existing part of the system, meaning thatit isn't a SQL login, Windows Domain user, or Relativity user.


n REST Password - the password you create for the REST API user. This can be any password thatyou choose, but for ease of use, you may want to enter your Relativity Service accountpassword. Whatever you enter here corresponds only with the REST API password field on theAnalytics server that you will add in Relativity after you install the Analytics server here. Thisvalue isn't related to any pre-existing part of the system, meaning that it isn't the password for aSQL login, Windows Domain user, or Relativity user.

n Confirm REST Password - retype the password you created for the REST API user.

5. Check, edit, or enter the values for the following Relativity Analytics Server Installation fields and clickInstall. These are automatically populated and are editable only if there is no existing installation of Con-tent Analyst. If there is an existing installation of Content Analyst that has a non-default service name,Relativity isn't able to detect that installation. Thus, you must enter the correct values for these fieldsto successfully upgrade your installation of CAAT:

n Analytics Server folder - the path to the folder containing the Analytics installation files.o We recommend using a path to a locally attached drive on the analytics server. This is typ-

ically left as the default path of C:\CAAT or C:\ContentAnalyst.o We recommend using a local directory name, i.e. C:\CAAT. However, do not create a local

drivemap to a UNC. For example, do not open \\servername\CAAT and map it to drive Z:.This is because drivemappings are specific to each Windows user and may not be avail-able to the Relativity Service Account.

o This path must be absolute, and it can’t contain spaces or invalid characters.o If the installer can't find or access the location you specify, it installs the application to the

default C:\CAAT folder.


n Analytics Server Service Name - theWindows service name of the Analytics instance. We recom-mend leaving this as the default value. This can't contain any invalid characters and it can'texceed 80 characters.

n Analytics Server Port Number - the port number of the Analytics server. The default port is8080, but you can configure a different port number.

n (Optional) Analytics Index Directory - the directory where indexes and structured analytics setsare stored on disk.

o We recommend that you not keep the index directory on the C: drive due to the sizerequirements.

o We recommend you use locally-attached storage referenced by a drive letter, i.e.E:\CAATindexes, rather than a UNC path. For more information, see Index directoryrequirements.

o Do not create a local drivemap to a UNC. For example, do not open \\servername\CAAT1and map it to drive Z:. This is because drivemappings are specific to each Windows userand may not be available to the Relativity Service Account.

o This path must be absolute, and it can’t contain spaces, invalid characters, or anyUnicode.

o Always use the installer to make changes to your Analytics configuration, including theindex directory. If you need to specify a new folder path, seeMoving Analytics indexesand structured analytics sets in the Admin Guide.

Note: If using a UNC path for the Analytics Server Folder and (Optional) Analytics Index Share Folder fields,the path must point to a Windows server directory.

n When you first click Install, Relativity unzips the Analytics installer. This can take several minutesto complete.

6. (Optional)Monitor the status of the installation. You don't have to click next once this process is com-plete.


7. (Optional) Note the installation specifications in the command line window. Don't close this duringinstallation. It closes automatically when installation is complete and the final step of the wizardappears.


8. Click Finish to complete the installation.

9. (Optional) Confirm that all components of the Analytics service are running by visiting http://<Ana-lytics Server Hostname>:<CA Port>/nexus/services and checking the Available Services list. Make sureto specify your Analytics server host name and CA port in the URL.

10. If this is a newAnalytics server, add it to the Servers list. For these steps, see Adding an Analytics or pro-cessing server on the Documentation site. If the server has already been added, navigate to the Serverstab and activate it. Make sure to enter the information on the server layout the same as you did in the


Analytics installer.n If you enter the information correctly, you can successfully save the server.n If you receive a not found error on the server, make sure the Analytics service is running and

that you used the correct port.n If you get an unauthorized error, make sure that you entered the credentials correctly.

Content Analyst is now installed in your environment, and you can now use Relativity Analytics.

9.2.1 Changing the REST passwordIf you need to change the REST password, perform the following steps:

1. Rerun the Analytics installer and enter the new password in the REST Password field.2. Go to the Servers tab in Relativity select the Analytics server.3. Enter the new password in the now-optional REST API password field and click Save.

9.2.2 Addressing "Could not configure security" installer warningThe following warning message may occur when upgrading or installing Relativity Analytics:

Could not configure security for the following directories:

Please confirm that the Relativity Service account has full control on them.

This warning that indicates that the user account running the installer failed to update thepermissions on the listed directories for the Relativity Service account . After you acknowledge thewarning, continue and complete the installation or upgrade of Analytics. The installation is still valid.

After finishing the Analyics installation or upgrade, complete the following steps to ensure theRelativity Service account has appropriate access to the directories listed in the warning message:

1. Stop the Content Analyst CAATWindows service if it's running.2. Add the Relativity Service Account user to the Administrators and Users groups.3. Grant the Relativity Service Account Full Control permissions on C:\CAAT (the installation directory).4. Grant the Users group Full Control permissions on C:\CAAT\pgsql\data.5. If the installation contains a C:\CAAT\data-default folder, grant the Users group Full Control per-

missions on this folder.6. If the index directory is different from the default (i.e. on another drive or share), ensure the Relativity

Service Account has Full Control permissions on the index directory.7. Restart the Analytics server after updating the user and group permissions.8. Verify the Relativity Service Account is running the CAAT Content Analyst Windows Service.

9.3 Installing Analytics server when SQL Server uses SSL encryp-tionWhen your primary SQL Server uses SSL encryption, you must satisfy the following additionalenvironment requirements in order for the Analytics server to communicate with SQL Server:


n The SQL Server's certificate is installed in the Analytics server KeyStore. See Install a SQL Server cer-tificate in the Analytics server KeyStore below

n The Common Name (CN) property of the SQL Server's certificatematches the server name value recor-ded for the SQL Server in Relativity. See Use the CN property of a SQL Server certificate in Relativitybelow.

9.3.1 Install a SQL Server certificate in the Analytics server KeyStoreComplete the following steps to install a SQL Server's certificate in your Analytics server KeyStore:

1. Export the SQL Server's certificate in X.509 DER format and place a copy of the certificate on the Ana-lytics server.

2. Note the CN property value recorded in the certificate.3. Open the following directory in a command prompt on your Analytics server :

<CAAT install drive>\jdk1.x\jre\lib\security

The <CAAT install drive> reference represents the Analytics server installation folder, and xrepresents the version of the JDK installed on your Analytics server. Browse to the securitydirectory using Windows Explorer first to ensure you use the correct Analytics serverinstallation path.

4. Run the following command from the command prompt:

..\..\bin\keytool.exe –import –alias <CN> -keystore cacerts –file <path to cert file fromStep 1>

Replace <CN> with the CN property recorded in the SQL Server's certificate and replace <pathto cert file from Step 1> with the path location of the certificate file you copied to theAnalytics server.

5. Enter your Java KeyStore password followed by yes when prompted to install the certificate.

Note: This step is only required if your Java KeyStore is password protected. Please refer to Oraclefor default Java password information.

9.3.2 Use the CN property of a SQL Server certificate in RelativityWhen running an Analytics server with a SQL Server that uses SSL encryption, the name of theSQL Server recorded on the Servers tab in Relativity and the name entered during Analytics serverinstallation must match the CN value recorded in the SQL Server's security certificate. Whenrunning the Relativity Analytics Server installation, enter the CN property value from yourSQL Server's certificate in the Primary Database Server Instance field on the Primary DatabaseServer Configuration dialog.

Note: If your SQL Server's Name value recorded on the Servers tab in Relativity doesn't match theCN property in the SQL Server's security certificate, contact [email protected] for assistance withupdating the SQL Server name in Relativity. Change the SQL Server's Name value in Relativity after youcomplete the Analytics installation.

mailto:[email protected]


9.4 Uninstalling the Relativity Analytics serverWe don't recommend uninstalling the Relativity Analytics Server application for any reason as itcauses data loss. If you uninstall the Relativity Analytics Server application from the analytics server,all structured analytics sets created in Relativity 8.2 and higher can't be used with anotherinstallation. There is no way to merge a previous Relativity Analytics Server installation with a newinstallation. As a result, structured analytics sets created in Relativity 8.2 and higher becomeunusable.

You shouldn't uninstall the application from the server unless you're certain you won't use theserver for Analytics functionality in the future, and you understand that uninstalling RelativityAnalytics renders structured analytics sets created in Relativity 8.2 and higher unusable.

If you still need to uninstall the Relativity Analytics components from the server, complete thefollowing steps:

1. Click your Startmenu.2. Select Add or remove programs.3. Right-click on Relativity Analytics Server and select Uninstall.

Uninstalling the Relativity Analytics server automatically:

n Removes the version key from the registryn Unregisters theWindows Service

Note: When you uninstall Relativity Analytics server, the indexes aren't deleted. However, any structuredanalytics sets created in Relativity 8.2 and higher are no longer usable.


Proprietary Rights

This documentation (“Documentation”) and the software to which it relates (“Software”) belongsto kCura LLC and/or kCura’s third party software vendors. kCura grants written license agreementswhich contain restrictions. All parties accessing the Documentation or Software must: respectproprietary 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 orSoftware in whole or in part. The Software and Documentation is protected by the Copyright Act of1976, as amended, and the Software code is protected by the Illinois Trade Secrets Act. Violationscan involve substantial civil liabilities, exemplary damages, and criminal penalties, including finesand possible imprisonment.

©2017. kCura LLC. All rights reserved. Relativity® and kCura® are registered trademarks of kCuraLLC.