Relativity Installation
July 26, 2017 - Version 9.3
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
For the most recent version of this document, visit our documentation website.
Table of Contents
1 Relativity installation
3
1.1 Installation prerequisites
3
1.2 Download the Relativity installer
3
1.2.1 Using the Relativity installer
3
1.2.2 Command line alternative to the RelativityResponse.txt file
4
1.3 Optional installer inputs
1.3.1 Using PowerShell script
5
6
1.4 Primary SQL Server installation
6
1.5 Distributed SQL server installation
9
1.6 Web server installation
11
1.7 Verifying the machine key settings on the IIS
13
1.8 Agent installation
15
1.9 Install the worker manager server
17
1.10 Configure an SMTP Server
17
1.10.1 Testing your SMTP server configuration
19
1.11 Enable telemetry
19
1.12 Log files
19
Relativity | Relativity Installation - 2
1 Relativity installation
In line with our commitment to quality, kCura provides you with comprehensive support during your
initial installation of Relativity. Contact the Client Services team (support@kcura.com) for detailed
information about pre-deployment steps you must complete as part of a first-time installation.For
more information about pre-deployment steps, see Installation prerequisites below.
Use the following instructions to install Relativity for the first time in your environment. These
instructions provide you with the information necessary to install Relativity. For additional
assistance, contact the Client Services team (support@kcura.com).
Note: For instructions about how to upgrade an existing Relativity environment, see Relativity upgrade and
Running the installer for an upgrade on the Relativity 9.3 Documentation site.
1.1 Installation prerequisites
Before you install Relativity, review the following information to confirm that your environment
meets the installation requirements. Make sure that you created the directories as well as obtained
the user names and passwords that the installer requires. Review the following pages for
information about the hardware, software, and infrastructure requirements for Relativity
installations available on the Relativity Documentation site:
n
n
System Requirements
Pre-installation
Note: We recommend changing the default password for the Relativity admin account and the Relativity
service account when you first log in to a new environment.
1.2 Download the Relativity installer
Contact kCura Client Services to get a copy of the Relativity installer.
Note: If you want to set up a single server installation of Relativity, change the setting for all applicable
components from 0 to 1 in the Feature Selection section of the RelativityResponse.txt file before running
Install.bat. During a single server installation, the installer won't add any component that isn't set to 1 for a
new installation. Any feature set to 0 in the RelativityResponse.txt file gets uninstalled if it detects a
previous installation for that component.
1.2.1 Using the Relativity installer
A basic instance of Relativity requires multiple servers. You must configure two or more machines
to fulfill the following roles:
Relativity | Relativity Installation - 3
n
n
n
n
Primary SQL Server - The master database called the EDDS resides on the primary SQL Server.
Distributed database server - The secondary database that accommodates a distributed instance of
the primary SQL Server and can store multiple workspace databases.
Agents server - The server that launches all Relativity agents and runs the agents framework.
Web server - The server that facilitates web background processing and handles authentication tasks.
Save the following files to the root directory of any server contributing to the Relativity
environment:
n
Relativity.exe - The executable file that installs Relativity components determined by the values
entered in the RelativityResponse.txt file.
Note: You must save Relativity.exe on a drive local to the server. Running Relativity.exe from a shared location
results in upgrade or installation failure.
Note: The Relativity.exe file does not open a user interface. Use Install.bat to proceed with installation.
n
Install.bat - The code that prompts Relativity.exe to proceed with the installation process. You must
edit line 11 of the Install.bat file with the exact name of the Relativity installation file.
start /wait "" "INSERT EXACT NAME OF RELATIVITY INSTALLATION FILE" /log InstallLog.txt /responsefilepath=RelativityResponse.txt
Note: You may need to run this file from an elevated command line prompt to avoid permission issues.
Note: You must surround the name of the Relativity installation file with quotation marks.
n
RelativityResponse.txt - The text file that determines which components Relativity.exe installs, uninstalls, or upgrades on the server.
Note: Every line in the RelativityResponse.txt file that starts with ### is a comment and meant to
provide instruction.
1.2.2 Command line alternative to the RelativityResponse.txt file
You can pass in response file parameters on the command line during installation if you don't want
your password information in a file stored locally on the machine hosting Relativity components.
The command line parameters overwrite (or if left blank, insert) the parameters that are in the
RelativityResponse.txt file.
Use the following steps to enter parameters you don't want to include in the RelativityResponse.txt
file.
1. Launch the Windows command prompt as an administrator.
2. Navigate to the directory that stores Relativity.exe, Install.bat, and RelativityResponse.txt.
Relativity | Relativity Installation - 4
3. Enter the following command:
start /wait Relativity.exe /log installLog.txt /responsefilepath=RelativityResponse.txt
EDDSDBOPASSWORD=my_password
Note: If you don’t have your password in the RelativityResponse.txt file and the password includes a space,
you must insert quotation marks around the password if you opt to use command line input. The following
example assumes that your password is: my password
start /wait Relativity.exe /log installLog.txt /responsefilepath=RelativityResponse.txt
EDDSDBOPASSWORD="my password"
Note: If you don’t have your password in the RelativityResponse.txt file and if your password includes a
quotation mark, use the following format to escape the command prompt's default interpretation of that
character. The following example assumes that your password is: my"password
start /wait Relativity.exe /log installLog.txt /responsefilepath=RelativityResponse.txt
EDDSDBOPASSWORD=my/"password
1.3 Optional installer inputs
You can edit the Install.bat file in a text editor to alter the default behavior of the Relativity installer.
There are four optional inputs:
n
Dry Run - This configuration only runs validations and doesn't perform a full installation.
start /wait "" "9.2.159.3 Relativity.exe" /log InstallLog.txt /responsefilepath=RelativityResponse.txt /dryrun
n
Skip Validations - This configuration skips validations in the bundle. The validations still run during MSI
execution.
start /wait "" "9.2.159.3 Relativity.exe" /log InstallLog.txt /responsefilepath=RelativityResponse.txt /skipvalidations
n
Uninstall - This configuration uninstalls Relativity, but you can also accomplish the same task through
the Windows Control Panel in the Add or Remove Programs list.
start /wait "" "9.2.159.3 Relativity.exe" /log InstallLog.txt /responsefilepath=RelativityResponse.txt /uninstall
n
Repair - This configuration repairs a failed installation.
start /wait "" "9.2.159.3 Relativity.exe" /log InstallLog.txt /responsefilepath=RelativityResponse.txt /repair
Relativity | Relativity Installation - 5
1.3.1 Using PowerShell script
An alternative installation method to using the Install.bat file is available in the form of a sample
Windows PowerShell script. You can obtain a sample PowerShell batch script from your kCura
support representative. It contains default values for the various installer processes you can modify
in a text editor according to your preferences. The sample script contains custom logic for basic
input prompting, parsing, and status indication. The sample file is intended to be an example of a
script that uses custom logic to drive the different installer behaviors. For example, the script
prompts you to enter the location of the installer executable, but the script also contains default
editable values for the RelativityResponse.txt file and log file locations. It displays any errors that
occur and the last line in the most recent log file. You can execute it from a PowerShell prompt and
pass options in, like the location of the installer executable or the installer mode.
1.4 Primary SQL Server installation
The master database called the EDDS resides on the primary SQL Server. You must first install the
primary SQL database server. After you install the primary SQL Server, you can run the distributed
database server, as well as the agent and web server installations in parallel.
Open the RelativityResponse.txt file in a text editor and edit the parameters as follows to install
Relativity on the machine that serves the role of the primary SQL Server:
1.4.0.1 Common properties
Note: The following non-alpha-numeric characters are not allowed in passwords: \, ", <, >.
n
INSTALLPRIMARYDATABASE - Set this value to one.
INSTALLPRIMARYDATABASE=1
n
INSTALLDISTRIBUTEDDATABASE - Verify that this value is set to zero. You can't store the distributed
database on the same machine as the primary database.
INSTALLDISTRIBUTEDDATABASE=0
n
INSTALLDIR - Enter the installation directory. This is the target directory for all files related to the local
installation. This path must be local to the machine and accessible by the server. You must use ASCII
characters for this path.
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
n
PRIMARYSQLINSTANCE - Enter the primary SQL instance. If you are installing to a cluster, specify the
cluster and instance name. If you are installing to a named instance, specify the server and instance
name. All features require this input.
PRIMARYSQLINSTANCE=ML12
Relativity | Relativity Installation - 6
n
EDDSDBOPASSWORD - Enter the EDDSDBO password.
EDDSDBOPASSWORD=MySecretPassword
n
SERVICEUSERNAME - Enter the service username. The Windows login must already exist.
SERVICEUSERNAME=example\exampleusername
n
SERVICEPASSWORD - Enter the Service password.
SERVICEPASSWORD=MySecretPassword
n
USEWINAUTH - Set the value to one to use Windows authentication for the SQL server.
USEWINAUTH=1
Note: If the USEWINAUTH value is set to one, then the user running the installer must be a SQL sysadmin, and
any values entered for SQLUSERNAME and SQLPASSWORD are ignored.
n
ENABLEWINAUTH - Set the value to one to use Windows authentication in your Relativity environment.
ENABLEWINAUTH=1
n
SQLUSERNAME - Enter the SQL username if you want to use SQL Server login authentication.
SQLUSERNAME=mySqlUserName
Note: This value is ignored if USEWINAUTH is set to one.
n
SQLPASSWORD - Enter the SQL password if you want to use SQL Server login authentication.
SQLPASSWORD=myPassword
Note: This value is ignored if USEWINAUTH is set to one.
1.4.0.2 Primary database properties
n
DEFAULTFILEREPOSITORY - Enter the default file repository. This path must be a shared folder to which
both the user running the installer and the Relativity Service Account have read and write permissions.
DEFAULTFILEREPOSITORY=\\yourmachine\FileShare
n
DTSEARCHINDEXPATH - Enter the dtSearch index. This path must be a shared folder to which both the
user running the installer and the Relativity Service Account have read and write permissions.
DTSEARCHINDEXPATH=\\yourmachine\dtSearch
n
RELATIVITYINSTANCENAME - Enter the Relativity instance name. Only set this value during a first-time
installation. The installer ignores this value on upgrade.
RELATIVITYINSTANCENAME=My Relativity Instance
Relativity | Relativity Installation - 7
n
EDDSFILESHARE - Enter the EDDS fileshare path. This path must be a shared folder to which both the
user running the installer and the Relativity Service Account have read and write permissions.
EDDSFILESHARE=\\yourmachine\Fileshare
1.4.0.3 Common database properties
We recommend that the following database paths are local to the SQL Server and accessible.
However, we also support UNC paths on SQL Server 2012 and above.
n
DATABASEBACKUPDIR - Enter the database backup directory.
DATABASEBACKUPDIR=C:\Backup
n
LDFDIR - Enter the LDF directory.
LDFDIR=C:\Logs
n
MDFDIR - Enter the MDF directory.
MDFDIR=C:\Data
n
FULLTEXTDIR - Enter the full text directory.
FULLTEXTDIR=C:\FullText
Save your edits to the RelativityResponse.txt file, and launch the Install.bat file to proceed with the
installation.
A sample RelativityResponse.txt file for a primary SQL database installation using Windows
authentication looks like this:
INSTALLPRIMARYDATABASE=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword
DEFAULTFILEREPOSITORY=\\yourmachine\FileShare
DTSEARCHINDEXPATH=\\yourmachine\dtSearch
RELATIVITYINSTANCENAME=My Relativity Instance
EDDSFILESHARE=\\yourmachine\Fileshare
DATABASEBACKUPDIR=C:\Backup
LDFDIR=C:\Logs
MDFDIR=C:\Data
FULLTEXTDIR=C:\FullText
USEWINAUTH=1
Note: Every line in the RelativityResponse.txt file that starts with ### is a comment and meant to provide
instruction.
Relativity | Relativity Installation - 8
1.5 Distributed SQL server installation
If your Relativity environment uses a distributed SQL server, then you need to run the installer on a
machine other than the one that hosts the primary SQL database. You must install the primary SQL
server before you install a distributed server. You can install the distributed database server in
parallel with the web and agent servers. Make sure that you review the steps for the database
server setup in the Pre-installation Guide, including those in the Optionally configure an
authentication token-signing certificate section.
Open the RelativityResponse.txt file in a text editor and edit the parameters as follows to install
Relativity on the machine that serves the role of the distributed SQL server:
1.5.0.1 Common properties
Note: The following non-alpha-numeric characters are not allowed in passwords: \, ", <, >.
n
INSTALLPRIMARYDATABASE - Set this value to zero. You can't store the distributed database on the
same machine as the primary database.
INSTALLPRIMARYDATABASE=0
n
INSTALLDISTRIBUTEDDATABASE - Set this value to one.
INSTALLDISTRIBUTEDDATABASE=1
n
INSTALLDIR - Enter the installation directory. This is the target directory for all files related to the local
installation. This path must be local to the machine and accessible by the server. You must use ASCII
characters for this path.
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
n
PRIMARYSQLINSTANCE - Enter the primary SQL instance. If you are installing to a cluster, specify the
cluster and instance name. If you are installing to a named instance, specify the server and instance
name. All features require this input.
PRIMARYSQLINSTANCE=ML12
n
EDDSDBOPASSWORD - Enter the EDDSDBO password.
EDDSDBOPASSWORD=MySecretPassword
n
SERVICEUSERNAME - Enter the service username. The Windows login must already exist.
SERVICEUSERNAME=example\exampleusername
n
SERVICEPASSWORD - Enter the Service password.
SERVICEPASSWORD=MySecretPassword
Relativity | Relativity Installation - 9
n
USEWINAUTH - Set this to one to use Windows authentication for the SQL server.
USEWINAUTH=1
Note: If the USEWINAUTH value is set to one, then the user running the installer must be a SQL sysadmin, and
any values entered for SQLUSERNAME and SQLPASSWORD are ignored.
n
SQLUSERNAME - Enter the SQL username to use SQL Server login authentication.
SQLUSERNAME=mySqlUserName
Note: This value is ignored if USEWINAUTH is set to one.
n
SQLPASSWORD - Enter the SQL password to use SQL Server login authentication.
SQLPASSWORD=myPassword
Note: This value is ignored if USEWINAUTH is set to one.
1.5.0.2 Distributed database properties
n
DISTRIBUTEDSQLINSTANCE - Enter the Distributed SQL instance. You can't store the distributed database on the same machine as the primary SQL Server.
DISTRIBUTEDSQLINSTANCE=ML14
1.5.0.3 Common database properties
n
DATABASEBACKUPDIR - Enter the database backup directory. This path must be local to the SQL Server
and accessible.
DATABASEBACKUPDIR=C:\Backup
n
LDFDIR - Enter the LDF directory. This path must be local to the SQL Server and accessible.
LDFDIR=C:\Logs
n
MDFDIR - Enter the MDF directory.
MDFDIR=C:\Data
n
FULLTEXTDIR - Enter the full text directory.
FULLTEXTDIR=C:\FullText
Save your edits to the RelativityResponse.txt file, and launch the Install.bat file to proceed with the
installation.
A sample response file for a distributed SQL database installation using Windows authentication
looks like this:
Relativity | Relativity Installation - 10
INSTALLDISTRIBUTEDDATABASE=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword
DISTRIBUTEDSQLINSTANCE=ML14
DATABASEBACKUPDIR=C:\Backup
LDFDIR=C:\Logs
MDFDIR=C:\Data
FULLTEXTDIR=C:\FullText
USEWINAUTH=1
Note: Every line in the RelativityResponse.txt file that starts with ### is a comment and meant to provide
instruction.
1.6 Web server installation
The web server hosts Relativity and its services, such as the Services and Web APIs. After you have
installed the primary SQL server, you can run the web and agent server, as well as the distributed
database server installations in parallel. The following settings assume that the web server resides
on a machine that doesn't host the primary or distributed databases.
Note: When you install Relativity, it is configured to use HTTPS by default. If you decided not to use HTTPS
in your environment, you must set the CookieSecure instance setting to False before logging in to
Relativity, or you receive an error message. For more information, see Instance setting on the Relativity 9.3
Documentation site. If you later decide to use HTTPS in your environment, you can find information about
how to set up this functionality in the section called Configuring SSL on a web server on the Pre-installation
page.
Open the RelativityResponse.txt file in a text editor and edit the parameters as follows to install
Relativity on the machine that serves the role of the web server:
1.6.0.1 Common properties
Note: The following non-alpha-numeric characters are not allowed in passwords: \, ", <, >.
n
INSTALLWEB - Set this value to one.
INSTALLWEB=1
Note: If the web server is already installed on this machine and the above value is set to zero, the installer
removes the previously existing web server.
n
INSTALLDIR - Enter the installation directory. This is the target directory for all files related to the local
installation. This path must be local to the machine and accessible by the server. You must use ASCII
Relativity | Relativity Installation - 11
characters for this path.
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
n
PRIMARYSQLINSTANCE - Enter the primary SQL instance. If you are installing to a cluster, specify the
cluster and instance name. If you are installing to a named instance, specify the server and instance
name. All features require this input.
PRIMARYSQLINSTANCE=ML12
n
EDDSDBOPASSWORD - Enter the EDDSDBO password.
EDDSDBOPASSWORD=MySecretPassword
n
SERVICEUSERNAME - Enter the service username. The Windows login must already exist.
SERVICEUSERNAME=example\exampleusername
n
SERVICEPASSWORD - Enter the service password.
SERVICEPASSWORD=MySecretPassword
n
USEWINAUTH - Set this to one to use Windows authentication for the SQL server.
USEWINAUTH=1
Note: If the USEWINAUTH value is set to one, then the user running the installer must be a SQL sysadmin, and
any values entered for SQLUSERNAME and SQLPASSWORD are ignored.
n
SQLUSERNAME - Enter the SQL username to use SQL Server login authentication.
SQLUSERNAME=mySqlUserName
Note: This value is ignored if USEWINAUTH is set to one.
n
SQLPASSWORD - Enter the SQL password to use SQL Server login authentication.
SQLPASSWORD=myPassword
Note: This value is ignored if USEWINAUTH is set to one.
n
KEEPCONNECTIONSTRINGS - Set this to one to save the save the current connection strings in all app.config/*.exe.config/web.configs and write them back to the config files after the upgrade. This preserves both encrypted and unencrypted connections strings.
KEEPCONNECTIONSTRINGS=1|0
Note: Setting this value to one on is valid only on upgrades from Relativity version 9.2 or later. Set to zero for
all previous versions of Relativity.
Relativity | Relativity Installation - 12
1.6.0.2 Web properties
n
ENABLEWINAUTH - Set this property to 1 to enable Integrated Authentication for your Relativity
instance. It updates IIS configuration and sets the value of the UseWindowsAuthentication instance setting to True.
ENABLEWINAUTH=1
Note: After Integrated Authentication is enabled by the installer, you must configure it for individual Relativity
users.
Save your edits to the RelativityResponse.txt file, and launch the Install.bat file to proceed with the
installation.
A sample RelativityResponse.txt file for a web only installation looks like this:
INSTALLWEB=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword
USEWINAUTH=1
KEEPCONNECTIONSTRINGS=1
ENABLEWINAUTH=1
Note: Every line in the RelativityResponse.txt file that starts with ### is a comment and meant to provide
instruction.
1.7 Verifying the machine key settings on the IIS
When setting up the IIS for a Relativity installation, you need to verify that the machine keys are
configured to use the appropriate methods for the encryption and decryption of forms
authentication data.
Use these steps to set the machine key for the IIS:
1. Open the IIS Manager.
2. On the IIS dashboard, highlight your Relativity website to display configuration options in the Feature
View.
3. Double-click the Machine Key icon.
4. Update the following fields for your version of Windows server:
n
Windows Server 2008 R2 - Select SHA1 for the Encryption method and AES for the Decryption
method.
Note: You could also select Auto for the Decryption method, but we recommend setting it to AES.
Relativity | Relativity Installation - 13
n
Windows Server 2012 R2 - Select SHA1 for the Validation method and AES for the Encryption
method.
Relativity | Relativity Installation - 14
5. Save your changes.
1.8 Agent installation
The agent server runs background processes for Relativity, such as those used for imaging,
branding, and others. After you install the primary SQL Server, you can run the agent and web
server, as well as the distributed database server installations in parallel.
Note: To ensure that Relativity functions properly, confirm that agents can connect to a valid Services API
endpoint. Configuring your Agent service to utilize the self-hosted Services API endpoint requires minimal
configuration and results in better performance. For more information, see Testing the Services API
configuration on the Relativity 9.3 Developers site.
The following settings assume that the same machine does not host the agent server that hosts the
primary or distributed SQL database servers.
Open the RelativityResponse.txt file in a text editor and edit the parameters as follows to install
Relativity on the machine that serves the role of the agent server:
Relativity | Relativity Installation - 15
1.8.0.1 Common properties
n
INSTALLAGENTS - Set this value to one.
INSTALLAGENTS=1
Note: This value only effects first time installations. The setting is ignored by all subsequent upgrades.
n
INSTALLDIR - Enter the installation directory. This is the target directory for all files related to the local
installation. This path must be local to the machine and accessible by the server. You must use ASCII
characters for this path.
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
n
PRIMARYSQLINSTANCE - Enter the primary SQL instance. If you are installing to a cluster, specify the
cluster and instance name. If you are installing to a named instance, specify the server and instance
name. All features require this input.
PRIMARYSQLINSTANCE=ML12
n
EDDSDBOPASSWORD - Enter the EDDSDBO password.
EDDSDBOPASSWORD=MySecretPassword
n
SERVICEUSERNAME - Enter the service username. The Windows login must already exist.
SERVICEUSERNAME=example\exampleusername
n
SERVICEPASSWORD - Enter the service password.
SERVICEPASSWORD=MySecretPassword
n
USEWINAUTH - Set this to one to use Windows authentication for the SQL server.
USEWINAUTH=1
Note: If the USEWINAUTH value is set to one, then the user running the installer must be a SQL sysadmin, and
any values entered for SQLUSERNAME and SQLPASSWORD are ignored.
n
SQLUSERNAME - Enter the SQL username to use SQL Server login authentication.
SQLUSERNAME=mySqlUserName
Note: This value is ignored if USEWINAUTH is set to one.
n
SQLPASSWORD - Enter the SQL password to use SQL Server login authentication.
SQLPASSWORD=myPassword
Note: This value is ignored if USEWINAUTH is set to one.
Relativity | Relativity Installation - 16
1.8.0.2 Agent properties
n
DEFAULTAGENTS - Set this value to one.
DEFAULTAGENTS=1
Save your edits to the RelativityResponse.txt file, and launch the Install.bat file to proceed with the
installation.
A sample RelativityResponse.txt file for a agents only installation looks like this:
INSTALLAGENTS=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword
DEFAULTAGENTS=1
USEWINAUTH=1
Note: Every line in the RelativityResponse.txt file that starts with ### is a comment and meant to provide
instruction.
1.9 Install the worker manager server
After completing the Relativity installation, you must install the worker manager server. For more
information, see the following pages on the Relativity 9.3 Documentation site:
n
n
Worker manager server pre-installation steps
Installing the worker manager server
1.10 Configure an SMTP Server
You can configure your SMTP server to relay messages from Relativity agent and web servers. You
need to configure your SMTP server so that it can send email messages outside of your domain with
encrypted attachments. In addition, you must update specific instance setting values on the Instance
setting table in the EDDS database.
Use this procedure to configure your SMTP server:
1. To enable SMTP communication, verify that port 25 is open on your Relativity agent and web servers.
Also, verify that it is configured to allow relaying.
2. Use the kCura.Notification.WinForm utility to verify that SMTP relay works properly. Click here to
download this utility, extract it, and run it in your environment.
3. Log in to Relativity as an admin.
4. Click the Relativity Script Library tab to display a list of Relativity scripts.
5. Click New Relativity Script.
Relativity | Relativity Installation - 17
6. Copy and paste the following code in the Script Body box. This script outputs a list of instance settings
and their current settings.
SELECT *
FROM eddsdbo.[Configuration]
WHERE Name IN
('SMTPServer','Account','Instance','EnvironmentName','EmailFrom','EmailTo','CaseStatisticsNotificationList')
Your code should look similar to this screen shot:
7.
8.
9.
10.
Click Save.
On the details view, click Run Script to display a pop-up window.
Click Run to display a list containing the settings in your instance settings.
Optionally output a .csv file with these settings. Select Export to File in the mass operation drop-down
box and click Go. Save the file in a local directory.
Note: If you have already set any of the instance settings, keep a copy of these settings in case you need to
refer to it later.
11. To update the instance settings, click the Relativity SMTP Configuration script on the Relativity Script
Library tab.
12. Click Run Script to display a dialog where you can update the settings for your instance settings. For
information about the settings on this dialog, see Relativity SMTP configuration script on the Relativity
Documentation 9.3 site.
13. Enter your new settings in the dialog. The following table illustrates sample entries. The Account,
Instance, EnvironmentName, and EmailFrom must match the values for your kCura account.
Field
Sample setting
Account
Salt Corporation
CaseStatisticsNotificationList relativitystats@kcura.com (The script for the Billing statistics report
sends the output directly this email address.)
Instance
SaltCorpUK
Relativity | Relativity Installation - 18
Field
EnvironmentName
EmailFrom
EmailTo
SMTPServer
Sample setting
Salt Corporation
This email address displays in the From field on outgoing email messages.
Error notifications are sent to this email address. This value is optional.
SMTP server information for your environment, such as 192.168.1.10 or
smtp.kcura.com.
14. Click Run.
1.10.1 Testing your SMTP server configuration
You can test the configuration of your SMTP server to make sure that it has the proper settings.
Use this procedure to test your SMTP configuration:
1. Create a test workspace.
2. Build a small dtSearch index in your test workspace, and enter your email address in the Email notification recipients field.
3. Build the index and verify that you received an email.
4. From Home, check the Errors tab to determine if any errors occurred.
5. Re-run this test on an email address outside of your domain.
6. From Home, check the Errors tab to determine if any errors occurred.
1.11 Enable telemetry
After you install Relativity, complete the steps to enable telemetry in your environment. Telemetry
allows you to collect metrics for performance, usage, and billing. For more information, see
Telemetry on the Relativity 9.3 Documentation site.
1.12 Log files
The Relativity installer automatically creates log files to assist in troubleshooting. There’s not a set
list of log file names, but all the log files save to the same directory and share the same naming
scheme as the log specified in the batch script.
For example, the following command saves a log to the directory that the command prompt is
pointing to when run:
start /wait Relativity.Installer.exe /log Install.log
The above command yields the following logs:
n
n
Install.log - This is the main installer log. Check this log first when troubleshooting. The log records the
error and directs you to the next log file to check. This is the only log created during a dry run.
Install_0_<package identifier>.log - This is the log for the first package run.
Relativity | Relativity Installation - 19
n
n
Install_1_<package identifier>.log - This is the log for the second package run.
Install_2_<package identifier>.log - This is the log for the third package run.
Package identifiers might display as VCRedist2005x86, Agents, PrimaryDatabase, etc.
Relativity | Relativity Installation - 20
Proprietary Rights
This documentation (“Documentation”) and the software to which it relates (“Software”) belongs
to kCura LLC and/or kCura’s third party software vendors. kCura grants written license agreements
which contain restrictions. All parties accessing the Documentation or Software must: respect
proprietary rights of kCura and third parties; comply with your organization’s license agreement,
including but not limited to license restrictions on use, copying, modifications, reverse engineering,
and derivative products; and refrain from any misuse or misappropriation of this Documentation or
Software in whole or in part. The Software and Documentation is protected by the Copyright Act of
1976, as amended, and the Software code is protected by the Illinois Trade Secrets Act. Violations
can involve substantial civil liabilities, exemplary damages, and criminal penalties, including fines
and possible imprisonment.
©2017. kCura LLC. All rights reserved. Relativity® and kCura® are registered trademarks of kCura
LLC.
Relativity | Relativity Installation - 21
Download PDF