RTK.ExcelRedact Install

Prerequisites

To install RTK.ExcelRedact into an instance of Relativity, the user who is installing the product must be a part of the “Relativity Script Admins” group.

The RTK.Manager workspace and RTK.Manager application must also already be installed and configured.

RTK.ExcelRedact has been tested on Relativity versions 8.0.275.3 and higher - this is the minimum requirement for the install.

Instance Installation

Instance Installation RTK.ExcelRedact Manager

The RTK.ExcelRedact manager installs a queue application in the RTK.Manager workspace, this allows a user to review documents that are in the queue to be processed or redacted. It is required for the application to work. 1. Log in to Relativity and enter the RTK.Manager workspace 2. Select the application tab and add a new application 3. Select the RTK.ExcelRedact_Manager.xml application and install into the workspace

Instance Installation RTK.ExcelRedact

  1. Log in to Relativity, enter the Admin section and the Application Library tab
  2. Click the Upload Application button at the top of the page
  3. In the Application File field you will need to browse and find the RTK.ExcelRedact.rap file you were provided with, and select it
  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 RTK.Manager application – instructions on how to do this can be found in the RTK.Manager installation section

Workspace Installation

  1. Enter the workspace you require RTK.ExcelRedact to be installed in and move to the Relativity Applications tab
  2. Click the New Relativity Application button at the top of the page
  3. In the Application Type field choose the “Select from Application Library” choice – this will change the layout
  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

Instance Configuration

  1. RTK.ExcelRedact requires an agent to run the processing of the Excel documents, select the agents tab and add a new agent.
  2. Filter the agent list for “ExcelRedactionWorkerAgent” and add select an appropriate Agent Server for your Relativity instance. We recommend you leave the default 5 second run interval but this can be configured to suit your needs.

Upgrading

Upgrading the RTK.ExcelRedact program can be performed through the application platform in Relativity.

RTK.ExcelRedact_Manager

If there is a new RTK.ExcelRedact_Manager rap file this can be installed in the RTK.Manager workspace. 1. Log in to Relativity and enter the RTK.Manager workspace 2. Select the application tab and open the RTK.Manager application 3. Select to upgrade the application and then select the latest RAP file 4. The RTK.ExcelRedact application can then be updated 5. Log into Relativity and go to the application library tab in the admin section 6. Open the RTK.ExcelRedact application and select to edit and upload a the new RAP file. 7. Once complete you can upgrade the required workspaces

Notes

By default the Order in dropdown value for the RTK.ExcelRedact layout is 9,999. You may need to change this so it appears in the right place in your layout list. Although RTK.ExcelRedact will respect the Relativity permissions already set, we would recommend hiding the layout from any groups that don’t have redacting privileges.

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

If you encounter an errors during the post install event handler there are two scripts that are installed by the application as well.

These two scripts replicate the functionality of the post install event handler and can be used in the case of an installer error. Run the Install database tables, followed by the install updated redaction table

RTK.Manager Install

RTK.Manager is the configuration and licensing pplication for the RTK suite of products. Whether you have a single RTK product or all of them, the RTK.Manager application will hold instance wide settings. This only needs to be installed in a single workspace, rather than an Application library install

Prerequisites

To install RTK.Manager into an instance of Relativity, the user who is installing the product must be a part of the “Relativity Script Admins” group. To be in this group you also need to be a part of “System Administrators”. RTK.Manager has only been tested on Relativity versions 8.0.275.3 and higher - this is the minimum requirement for the install.

Installation

  1. Create a new workspace titled “RTK.Manager” – the template can be anything, but we would recommend using one of the default kCura templates such as “kCura Starter Template” or “New Case Template”
  2. Inside the new workspace access the Relativity Applications tab and click the New Relativity Application button at the top of the page
  3. A new layout will open. For Application Type choose “Import from File” – this will alter the layout
  4. In the File field you will need to browse and find the RTK.Manager.rap you were provided with, and select it
  5. Relativity will immediately begin reading the rap file and will fill out the relevant Application Information. If you are happy with the install click on the Import button at the top of the page
  6. Once the application has completed installing you will be shown a page to confirm the installation

Licensing products

  1. Enter the RTK.Manager workspace and Licence tab – click the New Licence button at the top of the page
  2. In the Application field you will need to provide the exact name of the RTK application as specified in the product’s installation guide
  3. In the Key field you will be required to copy and paste in the licence key that has been provided to you for the product you are installing
  4. Click Save at the top of the page (or Save and New to install another new licence) and the record will be added to the database and the product will be considered licenced

Notes

A licence will be valid from the time it is distributed, not the time it is installed. Only one licence should exist per product – multiple licences for a product may cause failures of the product to operate