Enable Data Grid Audit

Setup Stage

This section applies to Datagrid Only.

After installing the required Elastic components for Data Grid Audit, the integration between Elastic and Relativity is configured by running the Relativity Server CLI on the Primary SQL Server.

Please review the following important information before proceeding:

  • For Existing Data Grid Audit Customers: You must be on Elasticsearch 7.17 when initially running this setup. After the setup is complete, you can upgrade to Elasticsearch 8.17.3.
  • Before upgrading to Elasticsearch 8.17.3, the ESIndexCreationSetting may need to be updated. For details, refer to the Instance setting Details.
  • Always verify the minimum required Elasticsearch version in your specific release bundle, as it may differ from the versions mentioned here.

Prerequisites

  1. Install the mapper-size plugin on all nodes in the Elasticsearch cluster (instructions available here). The Elasticsearch service must also be restarted after installing the plugin.

  2. The Server-bundle zip file has been downloaded and extracted to `C:\Server.Bundle.x.y.z'

  3. Verify that the InfraWatch Services application is installed in the Relativity instance (this RAP is delivered as part of the base Relativity Server 2024 installation package).

Set up instructions

Follow these steps to set up Data Grid Audit using the Relativity Server CLI. All setup will occur on the SQL Primary server.

  1. Open elevated command prompt/powershell. Run below command. Select Datagrid

    Copy
    C:\Server.Bundle.x.y.z\relsvr.exe setup
    Relativity Server CLI - 24.0.1196
    Copyright (c) 2025, Relativity ODA LLC

    What would you like to setup?
    > DataGrid
      Environment watch
      Exit

  2. Enter the required Relativity and Elasticsearch parameters.

    Copy
    Confirm you would like to perform the 'DataGrid' setup [y/n] (y): y

    Existing settings do not exist
    Enter the Relativity admin username (relativity.admin@kcura.com): relativity.admin@kcura.com
    Enter the Relativity admin password: *********
    Enter the Relativity instance url (https://emttest/Relativity): https://emttest/Relativity
    Relativity instance is verified
    Enter the Elasticsearch admin username (elastic): elastic
    Enter the Elasticsearch admin password: *********
    Enter the Elasticsearch cluster endpoint URL (https://emttest:9200): https://emttest:9200

  3. Wait for Setup to Complete.

    Copy
    Elasticsearch cluster endpoint URL is verified
    Elasticsearch plugin verified

    API Key creation and validation completed ------------------------- 100%
    Relativity instance setting validation completed ------------------ 100%
    Relativity secret store updated ----------------------------------- 100%
    Elastic Stack settings validation completed ----------------------- 100%
    Relativity toggles validation completed --------------------------- 100%

    The Relativity Data Grid setup has been completed. Please restart all Relativity services, including "kCura Edds Agent Manager," "kCura Edds Web Processing Manager," and "kCura Service Host Manager" on each server contained within this Relativity instance to complete the setup.

    If the setup completes successfully, Datagrid is now configured for the environment.

  4. Restart the Relativity services on all machines for the changes to take effect.

  5. Verify Audit Dashboard - navigate to the Audit tab in the Relativity environment and confirm that the dashboard and its data are loading correctly.

Next

Click here for the next step

Return to top of the page
Feedback