Automate - Preparing for a Nuix Rampiva Upgrade Installation

The material in this document is for informational purposes only. This guide assumes that the most recent version of Rampiva Automate 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

This article will provide guidance on how to upgrade a Nuix Rampiva environment. Careful planning and validation steps should be defined prior to performing a product upgrade. Due to the complexity and available configurations in Nuix Rampiva it is important to consider numerous settings, functions, workflows, operations, and stakeholders when performing an upgrade. For additional questions, please contact Nuix Rampiva’s Client Success team for further guidance.


A. Planning and Review

1

Review the Nuix Rampiva changelog.

https://downloads.rampiva.com/automate/release/changelog.html

2

Review Upgrade KB Articles.

Major version upgrades (7.x to 8.x) typically require a full uninstallation of the existing product. In-Place upgrades should only be used on the current version minor release upgrades (8.1 to 8.1.11).

https://rampiva.atlassian.net/l/cp/ZFzyWZ7z

https://rampiva.atlassian.net/l/cp/9190xYAU

https://rampiva.atlassian.net/l/cp/NRJYJDNJ

3

Review the Nuix Rampiva Known Issues KB Article.

4

Review the Nuix Rampiva API Changelog

https://downloads.rampiva.com/automate/release/api-changelog.html

5

Review your existing API Calls and authentication methods used in the API calls.

 

6

Review your existing workflows and determine if existing functionality will be impacted by the upgrade.

 

7

Process a known dataset with existing Production workflows and document their outcomes.

 

B. Performing a Backup - SQLite (default configuration)

1

Stop the Rampiva Scheduler service

 

2

Browse to C:\Programdata\Rampiva\Automate\Scheduler

image-20240202-194915.png
3

Backup the stores folder. Copy or Zip the files in place.

C. Perform Test Server Upgrade - SQLite (default configuration)

1

Install your current version of Nuix Rampiva on a separate upgrade server.

This server will be used as a test deployment of Nuix Rampiva for upgrade validation only. You may use your existing PROD license for this purpose.

2

Stop the Rampiva Scheduler service

3

Restore the database backup files to the test server from Section B, step 3.

4

Start the Rampiva Scheduler service.

5

Stop the Rampiva Scheduler service.

6

Perform the product upgrade on the test server.

  • When upgrading to a version in the same Major Release EG: (8.1.1 upgrading to 8.1.13) use the In-Place Upgrade option

  • When upgrading to a Major version from a Major version EG: (7.x upgrading to 8.x), perform a complete uninstall of the current version using Add/Remove Programs. Install the new version using the Single Server installer.

 

D. Performing a Backup - MSSQL

1

Stop the Rampiva Scheduler service

 

2

From the Production Server, copy the config.yml file located at C:\Programdata\Rampiva\Automate\Scheduler\config to the same location on the Test Server.

image-20240202-195032.png
3

Backup the Rampiva Master and Utilization databases in MSSQL

4

Restore the Rampiva Master and Utilization databases in MSSQL as different database name(s).

E. Perform Test Server Upgrade - MSSQL

1

Install your current version of Nuix Rampiva on a separate upgrade server.

 

2

Stop the Rampiva Scheduler service

 

3

Update the config.yml in C:\Programdata\Rampiva\Automate\Scheduler\config to utilize the TEST SQL database names in the SQL redirect settings.

4

Start the Rampiva Scheduler service.

 

5

Stop the Rampiva Scheduler service.

 

6

Perform the product upgrade on the test server.

  • When upgrading to a version in the same Major Release EG: (8.1.1 upgrading to 8.1.13) use the In-Place Upgrade option

  • When upgrading to a Major version from a Major version EG: (7.x upgrading to 8.x), perform a complete uninstall of the current version using Add/Remove Programs. Install the new version using the Single Server installer.

 

F. Workflow, Operations, and Functionality Validation

1

In the Test environment test and review all workflows and validate the results and outcomes.

2

Test all API calls and validate the result and outcomes.

3

Process a known dataset with existing Production workflows and document their outcomes.

4

Compare the new version results to the previous version results and determine if an upgrade of the Production Server is appropriate.

G. Production Upgrade

1

Stop the Rampiva Scheduler service

2

Perform the product upgrade on the Production server.

  • When upgrading to a version in the same Major Release EG: (8.1.1 upgrading to 8.1.13) use the In-Place Upgrade option

  • When upgrading to a Major version from a Major version EG: (7.x upgrading to 8.x), perform a complete uninstall of the current version using Add/Remove Programs. Install the new version using the Single Server installer.

3

Perform validation testing as described in Section F.