Upgrading your agent server

This section provides the prerequisites and the steps required to upgrade your agent server to a new version of Relativity. For more information, see Pre-installation.

Before you begin upgrading your agent server, confirm that you have upgraded the SQL Server and have started the SQL service. Additionally, you must install or upgrade the Relativity service bus.

Note: After you run the installer on at least one agent server, the system begins upgrading individual workspaces. You can now log in to Relativity to monitor workspace upgrades via the Workspace Upgrade queue.

Agent server upgrade

Contact Relativity Client Services to get a copy of the Relativity installer.

Save the following files to the root directory of any server contributing to the Relativity environment:

  • Relativity.exe - The executable file that installs Relativity components determined by the values entered in the RelativityResponse.txt file.
      Notes:
    • 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.
    • The Relativity.exe file does not open a user interface. Use Install.bat to proceed with installation.
  • 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
      Notes:
    • You may need to run this file from an elevated command line prompt to avoid permission issues.
    • You must surround the name of the Relativity installation file with quotation marks.
  • 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.

To upgrade the agent server:

Open the RelativityResponse.txt file in a text editor and edit the parameters as follows to upgrade Relativity on the machine that serves the role of the agent server:

Note: The following settings assume that the same machine does not host the agent server that hosts the primary or distributed SQL database servers.

Common properties

  • 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 can't use unicode special characters for this path.
    INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
  • 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
  • EDDSDBOPASSWORD - Enter the EDDS database object password.
    EDDSDBOPASSWORD=MySecretPassword
  • SERVICEUSERNAME - Enter the service username. The Windows login must already exist.
    SERVICEUSERNAME=example\exampleusername
  • SERVICEPASSWORD - Enter the service password.
    SERVICEPASSWORD=MySecretPassword
  • 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.

  • SQLUSERNAME - Enter the SQL username to use SQL Server login authentication.
    SQLUSERNAME=mySqlUserName

    Note: This value is ignored if USEWINAUTH is set to one.

  • SQLPASSWORD - Enter the SQL password to use SQL Server login authentication.
    SQLPASSWORD=myPassword

    Note: This value is ignored if USEWINAUTH is set to one.

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

Save your edits to the RelativityResponse.txt file, and launch the Install.bat file to proceed with the upgrade.

A sample RelativityResponse.txt file for a agents only upgrade looks like this:

INSTALLAGENTS=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword
USEWINAUTH=1

Note: Every line in the RelativityResponse.txt file that starts with ### is a comment and meant to provide instruction.

Service Host Manager HTTPS configuration

Service Host Manager runs Relativity services on all web and agent servers in your environment. The services are used by applications like Production and Processing on. If your web and agent servers must be set up for HTTPS access, special setup is required for Service Host Manager.

For more information, see HTTPS configuration in Service Host Manager.