The material in this document is for informational purposes only. This guide assumes that the most recent version of Rampiva software is in use unless otherwise noted in the prerequisites. The products it describes are subject to change without prior notice, due to the manufacturer’s continuous development program. Rampiva makes no representations or warranties with respect to this document or with respect to the products described herein. Rampiva shall not be liable for any damages, losses, costs or expenses, direct, indirect or incidental, consequential or special, arising out of, or related to the use of this material or the products described herein.

Introduction

We use diagnostic data from Rampiva software to provide reporting, to enforce licensing and to help us improve our products and services.

How Rampiva Handles Diagnostic Data

Data Collection

Diagnostic data is collected on the device on which the Rampiva software is running. The scope of the data collected depends on the diagnostic level configured in the application settings. Later in this document, we provide further details on how to configure this level.

Data Transmission

All diagnostic data is encrypted using TLS during transfer from the device to the Rampiva data management services. The following endpoints are used to send data back to Rampiva:

Software	Endpoint

Software	Endpoint
Workflow	api.rampiva.services
Scheduler	api.rampiva.services
Engine Server	N/A - transmission is performed by Scheduler
Baseline	api.rampiva.services

What Data is Collected and Why

The type of data collected depends on the diagnostic level configured in the application.

Diagnostic Level – None

No diagnostic data is collected and sent to Rampiva. This setting is is only available when using Rampiva with an offline license file, in an air-gapped environment.

Diagnostic Level – Required

The required diagnostic data is information about the Rampiva software version and license, the Nuix version and license, the Relativity service ID, and how often and what volumes of data are processed through Rampiva. This is the minimum level of diagnostic data needed to enforce the Rampiva license, and includes:

Rampiva license details;
Application name and version;
Related third-party software consumption details, such as Nuix Workstation, Nuix Engine, Relativity license details, product name, version, tenant, workspace, item IDs;
Utilization sessions time, duration and volume of data processed.

Diagnostic Level – Enhanced

The enhanced diagnostic data includes additional details about how the Rampiva software is configured and used. It contains unique identifiers and settings for the various objects from Rampiva and statistical information about the data processed. This data does not include the user-defined names of projects, cases, users, workflows etc., nor does it include the names or contents of the files processed through Rampiva. This information helps us understand how our customers use Rampiva and make product improvements, and enables us to provide reporting services. The information at this level includes:

Data from the Required level;
Unique identifiers and settings corresponding to objects in the Application, such as Cases, Servers, Resource Pools, Jobs, Users, etc., but not their assigned names or descriptions;
Statistical information about the data processed through the Application, such as the count and size of files processed by extension, type, operation, etc., but not the file names or content;

Diagnostic Level – Optional

The optional diagnostic data additionally includes the user-defined names of the projects, cases, workflows, users, etc., which are omitted from the enhanced diagnostic data. Before sending this information to us, the Rampiva software encrypts the data with a key that is only stored on the device running the software. It is not possible for us to read the contents of this data without the encryption key, and the Rampiva software never sends the encryption key to us. This information allows us to develop a reporting service for our customers, and provide a mechanism for customers to access the user-defined data when supplying the encryption key. The Information at this level includes:

Data from the Enhanced level;
Mapping between the unique identifiers and the user-defined names associated to these objects.

Configuring Diagnostic Levels

Use the steps in this section to configure the diagnostic data settings for the Rampiva software.

Workflow

The diagnostic level is set when applying a Rampiva license, in the license window. This window is shown automatically when starting Workflow without a license applied. After a license is applied, the license window can be accessed using the Help → About menu.

The diagnostic level settings can also be viewed and changed from the options window, which can be accessed using the Edit → Options menu.

These settings apply to the user logged on to the operating system, and are stored in the user profile.

Scheduler

The diagnostic level is set when applying a Rampiva license, in the Rampiva license panel. This panel is shown automatically when starting Scheduler without a license applied and browsing to the Scheduler application.

After a license is applied, the diagnostic level can be viewed and the license and diagnostic level can be updated from the Rampiva license panel, which can be accessed using the Settings → Rampiva License menu.

Engine Server

All Engine Servers managed by Scheduler will automatically inherit the diagnostic level configured in Scheduler. If a change is made to the diagnostic level in Scheduler, this change will propagate to the Engine Servers.

Baseline

The diagnostic level is set to Enhanced, and displayed when applying the Rampiva license, in the Rampiva license panel.

Sample Diagnostic Data per Level

This section provides sample data that is collected at each diagnostic level.

Diagnostic Level – Required

Session Start

{
    "date": 1610533130756,
    "properties": {
        "jobId": "869b35bf-891b-4886-9b54-d1bfc47a9516",
        "nuixLicenseDetails": {
            "deadline": "20210404000000",
            "id": "453d40df427149ea8a8f4d06e5e2b89b@NX024726",
            "limit.embedded-export-workers": "2",
            "limit.embedded-load-workers": "2",
            "profile": "enterprise-workstation-with-automatic-classifier",
            "profile.features.plus": "EXPORT_DISCOVER",
            "token": "453d40df427149ea8a8f4d06e5e2b89b"
        },
        "nuixLicenseFingerprint": "4c0680ef",
        "nuixLicenseShortName": "enterprise-workstation",
        "nuixVersion": "8.8.1.131",
        "nuixWorkersCount": 2,
        "productName": "ENGINE",
        "productVersion": "5.0.0",
        "rampivaLicenseId": "38a367d8-46a2-4de2-a798-17e8fa00aaaf"
    },
    "sessionId": "102eeaa8-6acd-41f2-aa4b-9ea7eda8a856",
    "type": "SESSION_START"
}

Session Ping

{
    "date": 1610533487027,
    "sessionId": "102eeaa8-6acd-41f2-aa4b-9ea7eda8a856",
    "relativityServiceId":"SERVER1/780fb0e6-955f-4202-9f4a-6bf40e70e351"
    "type": "SESSION_PING"
}

Session Metrics

{
    "date": 1610533571319,
    "properties": {
        "activity": "LOAD",
        "volume": 64284991
    },
    "sessionId": "102eeaa8-6acd-41f2-aa4b-9ea7eda8a856",
    "subSessionId": "862745c3-0870-432b-b8db-abf2e58763b2",
    "type": "SESSION_METRICS"
}

Introduction

How Rampiva Handles Diagnostic Data

Data Collection

Data Transmission

What Data is Collected and Why

Diagnostic Level – None

Diagnostic Level – Required

Diagnostic Level – Enhanced

Diagnostic Level – Optional

Configuring Diagnostic Levels

Workflow

Scheduler

Engine Server

Baseline

Sample Diagnostic Data per Level

Diagnostic Level – Required

Session Start

Session Ping

Session Metrics

Session End

Transfer Volume

Consumption

Diagnostic Level – Enhanced

User Time Zone

User Activity

Data Upload

Job Queuing

Job-Related Objects

Operation-Related Statistics

Nuix Case

Nuix Case Statistics

Relativity Workspace

Collection

Collection Target

Legal Hold Setup

Legal Hold Custodian Response

Diagnostic Level – Optional

User Time Zone

Data Upload

Job Queuing

Job-Related Objects

Nuix Case

Nuix Case Statistics

Relativity Workspace

Collection

Collection Target

Legal Hold Setup

Legal Hold Custodian Response