Installing ARM

    Notes:
  • You must have valid Relativity Community credentials in order to download any Community file linked to the documentation site. You'll need to enter those credentials on the Community login screen if you're not already logged in. If you're already logged in to the Community at the time you click a link, the file is automatically downloaded in the bottom left corner of your screen. If you get an error message stating "URL No Longer Exists" after clicking a Community link, it may be due to a single sign-on error related to the SAML Assertion Validator, and you should contact your IT department.

This page includes the following content:

Download ARM

The ARM application is available on the Relativity Community.

Install ARM

Note: ARM should be installed only in the Admin Case (on Instance Level), it should NOT be installed in the workspaces.

Perform the following steps to install the ARM application:

  1. Navigate to the Application Library.
  2. Click Upload Application.
  3. Under the Application Information section, select the Choose File button.
  4. From the dialog, select the ARM application, then click Open.
  5. Click Save.

Once the application has imported, you will see a new ARM admin tab in the instance.

Add ARM agent

The ARM agent is responsible for performing the work for each type of function in an ARM job. Only one ARM agent is required; however, it’s a good idea to install more than one, if you are planning on running multiple ARM jobs in parallel. An optimal setup typically consists of no more than 6 ARM agents per agent server (and no more than 24 agents in an environment) when running multiple jobs.

Perform the following steps to install these agents:

  1. From the Home menu, navigate to the Agents tab, and then click New Agent.
  2. Click Browse next to Agent Type, and then click the ARM agent radio button.
  3. Click OK.
  4. Leave all other settings at their default values, and then click Save.

Relativity service account

The Relativity service account must be enabled with an integrated authentication provider correctly setup for ARM to login to the WebAPIPath (and run ARM jobs).

  1. First, you must create an authentication provider with the Provider Type set to Integrated Authentication (if one does not already exist).
  2. When adding the login method to the Relativity Service Account user, select the integrated authentication provider and set the Windows account to the Relativity service account user's Windows username (e.g., domain\username or .\username).

Update BcpShareFolderName instance setting

ARM will automatically retrieve the SQL Server machine name upon install. If your SQL Servers are in a clustered setup, you must update the BcpShareFolderName instance setting.

To do this manually, use the following to directly change the SQL code:

Update [EDDS].[eddsdbo].[InstanceSetting]

Set Value = '\\SQLName\BCPPath'

where name = 'BcpShareFolderName' and section = 'kCura.ARM'

Note: This value can be changed to accommodate larger cases if location does not have enough storage space for the workspace(s) to use as a temporary location.

Upgrade ARM

Perform the following steps to upgrade the ARM application:

    Notes:
  • Do not upgrade while jobs are running, errored, or created. The ARM queue should be clear before upgrading or those jobs will be nonrecoverable.

  • You must have valid Relativity Community credentials in order to download any Community file linked to from the documentation site. You'll need to enter those credentials on the Community login screen if you're not already logged in. If you're already logged in to the Community at the time you click a link, the file is automatically downloaded in the bottom left corner of your screen. If you get an error message stating "URL No Longer Exists" after clicking a Community link, it may be due to a single sign-on error related to the SAML Assertion Validator, and you should contact your IT department.

  1. ARM is available for download through the Relativity Community or contact Support to request the newest version of ARM that is compatible with your version of Relativity.
  2. Navigate to the Application Library.
  3. Click on the currently installed version of ARM. The Application page appears.
  4. Click Edit.
  5. Click Clear in the Application File field. The original file is cleared.
  6. Click Choose File in the Application File field.
  7. From the dialog, select the newest version of ARM, then click Open.
  8. Click Save.