Disclaimer

The material in this document is for informational purposes only. 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.

© Nuix Canada Inc. 2024 All Rights Reserved

Introduction

This guide describes the features and options of Rampiva Baseline. This document works like a reference - use the table of contents to look for the topic that you find out about.

To report any issues with this guide or with Rampiva Baseline, please use the Rampiva Community.

Styles Used in This Guide

Note: This is icon indicates that additional clarifications are provided, for example what the valid options are.
Tip: This icon lets you know that some particularly useful tidbit is provided, perhaps a way in which to use the application to achieve a certain behavior.
Warning: This icon highlights information that may help you avoid an undesired behavior.

Emphasized: This style indicates the name of a menu, option or link.

code: This style indicates code that should be used verbatim, and can refer to file paths, parameter names or Nuix search queries.

1. Logging In

To log in to Rampiva Baseline use the Sign in with Microsoft button.

Logging in will only be possible with the Microsoft account specified when Rampiva Baseline was installed. If the user does not have access to it anymore, uninstall and re-install Rampiva Baseline, and specify a different account during installation.

After a period of inactivity (by default 15 minutes), a warning will be displayed and the user will be logged out if no actions is performed.

2. Rampiva License

The Rampiva License tab is used to inspect and update the currently deployed Rampiva License. Rampiva licenses use a License ID and Key mechanism which is validated against the Rampiva License Service.

To obtain a license, register on the Rampiva Portal

3. Scan Settings

The Scan Settings tab is used to view and modify the current settings the scans are using.

3.1. Run Scans under a different user

To configure scans to under a different user account, check the Run scan as option and provide the account Username and Password.

To verify that the credentials are correct and that the account has the required privileges to run as a service, use the Test button.

4. Locations

The Locations tab is used to define the locations where to search for Nuix cases.

To add a new Location, use the Add + button and provide the following information:

  • Location: The path to search for cases. This can be a local path such as C:\Cases or a file share. When using file shares, a service account needs to be configured in the Scan Settings tab, in order for Rampiva Baseline to have access to the file share.

5. Engines

The Engines tab is used to configure the Nuix Engines used to scan the cases.

To add a new Engines, use the Add + button and provide the following information:

  • Location: The path to search for Nuix engines.

If the user does not have Nuix Engines configured on the server on which Rampiva Baseline is running, Nuix Engines can be downloaded from the Nuix Customer Portal, from the Nuix Engine section. Then, unzip the file downloaded and move it to C:\Program Files\Nuix\engine-dist-win32-amd64-xyz, where xyz is the version downloaded.

6. Nuix License

The Nuix License tab is used to inspect and update the Nuix License to be used by the Nuix Engines when scanning cases.

Baseline supports three types of Nuix Licenses.

6.1. NMS

A Nuix Management Service (NMS) is the classical way to assign Nuix licenses in an environment with multiple Nuix servers or workstations.

If a filter value is provided, a license will be selected only if the short name, full name or description of the license contains the text provided in the filter, for example, enterprise-workstation. The filter is case-insensitive. TIP: If a filter value is provided, a license will be selected only if the short name, full name or description of the license contains the text provided in the filter, for example, enterprise-workstation. The filter is case-insensitive.

To use NMS with Baseline, click the Update License and provide the following information:

  • Type: The license type, set this to NMS

  • Server Name: The host name or the IP address of the NMS.

  • Server Port: The port on which the NMS is configured to listen, by default 27443.

  • Username: The username with access to the license.

  • Password: The password for the Username above.

  • Filter: A text filter to select licenses of a certain type.

  • Ignore Certificate Warnings: An optional checkbox to ignore warnings when connecting to an NMS with an invalid certificate.

6.2. CLS

A Cloud License Service (CLS) is a service managed by Nuix that can be used to acquire a license.

To use CLS with Baseline, click the Update License and provide the following information:

  • Type: The license type, set this to CLS

  • Username: The username with access to the license.

  • Password: The password for the Username above.

  • Filter: A text filter to select licenses of a certain type.

  • Ignore Certificate Warnings: An optional checkbox to ignore warnings when connecting to an NMS with an invalid certificate.

6.3. Nuix Dongle

A Nuix Dongle is a physical USB device that store Nuix Licenses and is typically used when using a Nuix Workstation or the Nuix Engine on a single server or workstation.

To use a Nuix Dongle for Baseline, click the Update License and provide the following information:

  • Type: The license type, set this to Dongle

  • Filter: A text filter to select licenses of a certain type.

7. Cases

The Cases tab shows the list of Nuix Cases that have been identified and their scan status.

On the Cases tab the user can manually start or stop a scan.

7.1. Case View

The Case View is shown when clicking on a Nuix Case in the list, and contains the following information:

  • Status: The status of the case, such as queued for scanning, scan in progress, warnings or errors.

  • Case Info: Information about the Nuix Case such as the name, location, version and unique identifier.

  • Volume Info: Volume information from the last scan of the case.

To download the raw utilization data from a case, click the menu icon dropdown beside the name of the case and select Download Utilization.
To view and analyze the utilization data from all of the cases scanned, use a PowerBI dashboard from the Rampiva Community

8. User Resources

The User Resources tab provides links to resources such as the download page if a new version is available, help resources, other Rampiva products, and third-party licenses.