Pre-Installation Guide

Transcription

1 Pre-Installation Guide v7.5 May 10, 2013 For the most recent version of this document, visit kcura's Documentation Site.

2 Table of Contents 1 Relativity pre-installation overview 4 2 Windows Updates 4 3 Required active directory users and groups Relativity upload users group Relativity service account Relativity service account requirements for installation 4 4 Required document share - file repository Designate directory Create share 5 5 Required index share - dtsearch repository Designate directory Create share 6 6 Background processing server setup 7 7 Web server setup Required software Setting IIS options IIS role service configuration Enable IIS 6 Metabase compatibility Configuring log file options Setting file size for IIS requests log Setting the file size for failed trace logging 12 8 Database server setup Required software Create SQL server login Create BCP share 14 9 SMTP server setup Analytics server setup Native imaging database/queue manager server setup Required software Relativity Service Account Create Invariant worker network file path share Native imaging worker server setup Required software 16 Relativity Pre-Installation Guide - 2

3 12.2 Relativity Service Account Logo customization Resource groups 17 Relativity Pre-Installation Guide - 3

4 1 Relativity pre-installation overview This document guides you through the prerequisite software and operating system installation and configuration steps necessary to prepare your environment for Relativity installation. Note: This document does not cover the setup and configuration of the necessary hardware for your Relativity system. Hardware requirements and recommendations can be found in the System Requirements Guide. 2 Windows Updates After installing Windows updates, make sure that you reboot your machines before attempting to install Relativity. Complete this step to ensure that all Relativity components are properly installed. Incomplete Windows updates lock system files, which may cause silent failures and prevent the proper installation of Relativity components. 3 Required active directory users and groups 3.1 Relativity upload users group The group of users responsible for uploading documents through the Win Relativity component should be given Full Control in the Document Repository Share. Members of this group will import and export in Direct mode. Non-members will import and export in Web mode. Direct mode is significantly faster than Web mode. 3.2 Relativity service account Actions performed by Relativity the Windows Service Component and the kcura COM Plus Component run under this account. The account must be: Created in the network s Active Directory. Added to the Administrators group on all machines running Relativity components. Since Windows Server 2008 or 2008 R2 is required, be sure to disable UAC controls for this account. If using a Workgroup rather than Domain, ensure this account has identical credentials on all Relativity servers. Note: If you are installing a Workgroup, contact kcura Support for additional configurations required during Relativity installation Relativity service account requirements for installation As a best practice, run Relativity installations logged in as the Relativity Service Account. The service account requires the following to install Relativity: Relativity Pre-Installation Guide - 4

5 Local Administrator access permissions on the target server SQL sysadmin role privileges on the SQL server Note: The Relativity Service Account requires additional permissions for installing and running the Relativity Native Imaging feature. For more information, see Native Imaging Database/Queue Manager Server Setup and the Processing Server Installation guide. 4 Required document share - file repository 4.1 Designate directory A directory must be created as the root of the directories and documents that will be created through the Relativity system. This file share must be an actual folder, not merely a drive letter. For example, C:\Fileshare instead of just the C drive. In addition, make sure that the Full Text, LDF files, MDF files, and Backups are all specified to the folder level and not just the drive. 4.2 Create share The document root directory is exposed to the Relativity application through a shared drive. In order to share the folder: 1. Right-click on the folder and go to Properties. 2. Open the Sharing tab and click Share. 3. Enter the Relativity Service Account name (domain\account) and click Add. 4. Select the service account on the share list and change Permission Level to Co-owner. 5. Enter the Relativity Upload Users group and click Add. 6. Select the Group on the share list and change Permission Level to Co-owner. Relativity Pre-Installation Guide - 5

6 7. Click Share. 8. When the share completes, click Done. 9. Back on the Document Properties screen, switch to the Security tab. 10. Verify that the users and groups you added to the Share also have Full Control security permissions to the folder itself. 5 Required index share - dtsearch repository 5.1 Designate directory A directory must be created as the root of the directories that will be created by dtsearch index builds within the system. 5.2 Create share The dtsearch index directory is exposed to the Relativity application through a shared drive. In order to share the folder: 1. Right-click on the folder and go to Properties. 2. Open the Sharing tab and click Share. 3. Enter the Relativity Service Account name (domain\account) and click Add. 4. Select the service account on the share list and change Permission Level to Co-owner. Relativity Pre-Installation Guide - 6

7 5. Click Share. 6. When the share completes, click Done. 7. Back on the Document Properties screen, switch to the Security tab. 8. Verify that the Relativity Service Account also has Full Control security permissions to the folder itself. 6 Background processing server setup The background processing server setup requires the following actions: Install Windows Server 2008, or 2008 R2 Install.NET 3.5 with Service Pack 1 Install.NET 4.0 (Full Profile is required for Web, Agent, and SQL Servers) 7 Web server setup This section describes how to prepare your web server for installing Relativity. 7.1 Required software The following software must be installed on the web server: Windows Server 2008 or 2008 R2 x64 IIS 7.0 or higher.net 3.5 with Service Pack 1.NET 4.0 Full Profile IIS 6 Metabase Compatibility 7.2 Setting IIS options These updates must be made on all web servers in your Relativity installation. Relativity Pre-Installation Guide - 7

8 1. Install.NET Framework 4.0 Full Profile 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:\Windows\Microsoft.NET\Framework64\v \ b. Open the Aspnet.config file in a text editor. c. Locate the tag <legacyunhandledexceptionpolicy>. Set the enabled attribute to true. This sample code illustrates the attribute that you need to update. <legacyunhandledexceptionpolicy enabled="true" /> d. Save the changes to the file. 7.3 IIS role service configuration A number of role services within IIS are required, at minimum, for Relativity to function properly. If you wish to fully install the Web Server (IIS) role this is also acceptable. Minimum role service requirements for Relativity are as follows: Relativity Pre-Installation Guide - 8

9 7.3.1 Enable IIS 6 Metabase compatibility Relativity requires that you enable IIS 6 Metabase compatibility on all web servers. 1. Open the Server Manager. 2. Right click on the Web Server IIS node, and select Add Role Services. Relativity Pre-Installation Guide - 9

10 3. On the Add Role Services window, highlight Role Services. Confirm that IIS 6 Metabase Compatibility is selected as illustrated below. If necessary, enable or install this role service on your server. 7.4 Configuring log file options If you have enabled logging on the IIS, you can avoid performance and other issues by limiting the size of log files, as well as the number of trace files stored on the IIS. This section describes how to configure these features in your environment for optimum performance Setting file size for IIS requests log Logging is a default role installed on the IIS, and enabled in most environments. Use the following instructions to set the maximum size for the log files. 1. Open the IIS Manager. 2. On the IIS dashboard, highlight your server name to display configuration options in the Feature View. Relativity Pre-Installation Guide - 10

11 3. Double-click the Logging icon. You will see the Logging page displayed. 4. Select the option Maximum file size (in bytes), and enter a value for the file size in the text box. In the following illustration, the maximum file size restricts the log files from growing larger than 3 MB. You will need to adjust this file size to meet the needs of your environment. Relativity Pre-Installation Guide - 11

12 7.4.2 Setting the file size for failed trace logging If you have manually installed the failed trace logging through the Role Services on your IIS, complete the following steps to set the maximum number trace files stored. 1. Open the IIS Manager. 2. On the IIS dashboard, highlight your default web site to display configuration options in the Feature View. 3. Double-click the Failed Request Tracing Rules icon. 4. Right-click on the current set of enabled rules. Click Edit Tracing Settings. Relativity Pre-Installation Guide - 12

13 5. Update the value in the Maximum number of trace files box. This value should be set no higher than Database server setup Set up the database server by completing the steps in this section. 8.1 Required software The following software must be installed on the database server: Windows Server 2008 or 2008 R2 x64 Microsoft SQL Server 2008 and all service packs OR Microsoft SQL Server 2008 R2 Note: Confirm that the SQL Full Text Service is included as part of the installation..net 3.5 with Service Pack 1.NET 4.0 Full Profile Create SQL server login The following login must be added to the SQL Server environment. This account should be configured to Never Expire and Not Enforce Password policy: EDDSDBO This login is the owner of all objects in the EDDS system databases. Authenticate this user with SQL Server Authentication. This login must be given the following server roles only: o o o bulkadmin dbcreator public Relativity Pre-Installation Guide - 13

14 If you have multiple SQL servers, this account should be created on each server with the same name, permissions, and credentials Create BCP share A directory should be created on the SQL server in a location where the Relativity Service Account can read and write. SQL services should also be able to read from this directory. This directory must be an actual folder, not merely a drive letter. If the account running SQL does not have access to this folder they will not be able to create new cases. This directory is used for temporary files during imports, exports, case creations, and dtsearch queries. kcura recommends placing this share on the drive housing the Backup files for optimal performance. This share should be named BCPPath in every instance. If you have multiple SQL servers, this share should be created on each server with an identical name, BCPPath. You should provide the account that is running SQL services with rights to the BCPPath; if this is not provided, the bulk import will fail. Note: You may want to set up an SQL Service Account (domain account with local admin rights). You should review the security requirements of your organization before setting up this account. See the following instructions for creating a SQL Server Service account available from Microsoft: Complete the following steps to share the folder: 1. Right-click on the folder and go to Properties. 2. Open the Sharing tab and click Share. 3. Enter the Relativity Service Account name (domain\account) and click Add. 4. Select the service account on the share list and change Permission Level to Co-owner. 5. Click Share. 6. When the share completes, click Done. Relativity Pre-Installation Guide - 14

15 7. Back on the Document Properties screen, switch to the Security tab. 8. Verify that the Relativity Service Account also has Full Control security permissions to the folder itself. 9 SMTP server setup Relativity requires access to an SMTP server to handle the delivery of error messages, job notifications, and billing statistics to both internal contacts and to kcura. kcura provides an easy to use SMTP connectivity tool, which Client Services will run against your system to verify the servers can properly communicate with your specified SMTP server. 10 Analytics server setup Set up the Analytics server by disabling the Windows Firewall. 11 Native imaging database/queue manager server setup Set up the database server by completing the steps in this section Required software The following software must be installed on the database server: Windows Server 2008 or 2008 R2 x64 Microsoft SQL Server 2008 and all service packs OR Microsoft SQL Server 2008 R2.NET 3.5 with Service Pack 1.NET 4.0 (Full Framework) 11.2 Relativity Service Account The Relativity Service Account must have a login to the SQL Server environment. This account is the owner of all objects in the Invariant system databases. It must be set up as follows: Configure the account with Windows Authentication. This account will be authenticated with Windows Authentication. Ensure that the account has local administrator rights to perform the installation of the native imaging database and queue manager. Ensure that this account has only these server roles: o o Public Sysadmin Relativity Pre-Installation Guide - 15

16 11.3 Create Invariant worker network file path share A directory should be created on the SQL server in a location where the Relativity Service Account can read and write. SQL services should also be able to read from this directory. This directory must be an actual folder, not merely a drive letter. This directory is used for storing the installation files for worker servers. 12 Native imaging worker server setup Set up the database server before completing the steps in this section Required software The following software must be installed on the worker server: Windows Server 2008 (64-bit) or 2008 R2 x64.net Version 3.5 w/service Pack 1.NET Version 4.0 (Full Framework) Desktop Experience ( available as a Windows Server feature) Microsoft Office 2010 Professional (32-bit) Microsoft One Note Professional 2010 Microsoft Visio Professional 2010 Microsoft Project Professional 2010 Microsoft Publisher Professional 2010 Lotus Notes v8.0 or higher Adobe Reader 4.0 or higher SolidWorks edrawings 2012 Viewer (32-bit) (with the option to view 3D XML and PRO/E files) JungUm Global Viewer v9.0 or higher 12.2 Relativity Service Account The Relativity Service Account must be given local administrator rights to each worker server. This account will be used during installation and must remain logged on each server to run local processes during native imaging. 13 Logo customization You can customize your Relativity web interface by adding your company s logo to it. To address variable space requirements, you should provide two logos with different sizes. If a user has Data Focus turned on, the small logo will be displayed. The height of the logo must be less than 25 pixels. The width is discretionary. If Data Focus is off then the height can be 50 pixels and the width is still discretionary. The logo can be turned on and off using a setting in the configuration table. The name of the logo file is set in the configuration table, as well. The logos must be then placed in the images folder at the root of the EDDS directory. Relativity Pre-Installation Guide - 16

17 14 Resource groups A workspace contains no resource servers after an initial installation of Relativity; it is only after the agents start up that servers self-register. Note that after they self-register, they are not automatically associated with a Resource Group. To associate these servers to a resource group, you must manually add them through the Resource Group tab in Admin mode. For more information on Resource Groups and Servers, refer to the Admin guide. Relativity Pre-Installation Guide - 17

18 Proprietary Rights This documentation ( Documentation ) and the software to which it relates ( Software ) belongs to kcura Corporation 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 kcura Corporation. All rights reserved. Relativity and kcura are registered trademarks of kcura Corporation. Relativity Pre-Installation Guide - 18