Skip to content

Installation and Configuration

Prerequisites

Installation

Instance Installation to Application Library

For more detailed information on how to install Relativity Applications, refer to Relativity's documentation here: Installing Applications

  1. From the homepage, navigate to the Application Library admin tab.

  2. Click the Upload Application button at the top of the page.

  3. In the Application File field, click Choose file and select the ExcelRedact.rap file you were provided with.

    Application file field

  4. Relativity will immediately begin reading the application file and will complete the relevant Application Information. If you are happy with the install, click on the Import button at the top of the page.

  5. Once the application has completed installing you will be shown a page to confirm the installation.

  6. Apply the supplied licence in the ExcelRedact Licence Instance Setting – instructions on how to do this can be found in the Licence section.


Workspace Installation

Relativity provides two methods to install an application onto a workspace.

If you added the application to the Application Library, you can install it to the current workspace without importing an external file to Relativity.

Application Library
  1. From the homepage, navigate to the Application Library admin tab.
  2. Filter the list for ExcelRedact and click to open the application.
  3. At the bottom of the page under Workspaces Installed, click the Install button.
  4. A new page will open. Click image-20200602130153215 under the Workspace section to open the list of workspaces.
  5. Tick the targeting workspaces Excel Redact is to be installed on, then click Ok.
  6. Click Save at the top of the page.
  7. Under Workspaces Installed, you should see Pending installation on all selected workspaces.


Workspace
  1. Navigate to the Workspace ExcelRedact is to be installed in and then to the Relativity Applications tab.
  2. Click the New Relativity Application button at the top of the page.

  3. In the Application Type field select the Select from Application Library choice.

  4. Use the picker for the Choose from Application Library field to select RTK.ExcelRedact – this will populate more information on the layout automatically.

  5. If you are happy with the install, click the Install button at the top of the page.
  6. Once the application has completed installing you will be shown a page to confirm the installation.

Note

If you are importing from an external file, select Import from File in the Application Type field and follow steps 3-6 in the Instance Installation section above.

Warning

ExcelRedact includes a custom page so the Relativity instance will require the correct folders and Custom Page Deployment Manager agent to be running to allow the deployment of custom pages.


Instance Configuration

Agents

ExcelRedact requires two agents to process Excel documents. Without the agents configured redacted Excel files will not be generated and automatic redactions will not be applied.

  1. Navigate to the Agents admin tab.
  2. Click New Agent at the top of the page.
  3. On the Agent Type field, click the image-20200602130153215 button and filter the list for ExcelRedactManager.
  4. On the Agent Server field select the server you wish to install the agents on.
  5. Set the Run Interval and Logging level field. We recommend the interval to be set at 5 (seconds) and logging level to Log critical errors only.
  6. Click Save.
  7. Repeat steps 1-6 to configure the ExcelRedactWorker agent.


Licensing the Application

Excel Redact requires a licence to be able to process Excel documents. Anexsys should have provided you with a license key which needs to be added to the Relativity Instance.

  1. Navigate to the Instance Setting admin tab.
  2. Filter the list under Name for ExcelRedact Licence.
  3. Click Edit to open up the edit page.
  4. Under Instance Setting Details section, enter the provided license key text into the Value field.
  5. Click Save.

Info

The instance setting should be automatically created upon successful installation. If the instance setting does not exist, refer to the Troubleshooting page Licence section.