Versions Compared

Old Version 1

changes.mady.by.user Ryan Best

Saved on

compared with

New Version Current

changes.mady.by.user Ryan Best

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Prerequisites 

  • Nuix Engine

  • Java Runtime Environment (JRE)

  • Local Administrative rights to install software

  • Internet connection

  • download.nuix.com login credentials - to download Nuix software

...

Instructions: 3rd Party Components

A. Nuix Engine Binaries

1

If not already installed, download the latest version of the Nuix Engine. Available versions can be downloaded from the link provided: https://download.nuix.com/releases/engine/ .

Note

Ensure to use the same Nuix Engine version as Nuix Workstation to avoid issues opening cases.

Info

A Nuix Download account is required to access the Nuix Download Portal. Speak with your Nuix representative to issue an account.

Image Modified
2

Extract the Nuix Engine Binaries to C:\Program Files\Nuix\Nuix Engine\

Note

Ensure that a previous version is not already installed in the same location.

B

...

Download the latest version of the AdoptOpenJDK Library using the default settings. Available versions can be downloaded from the link provided: https://adoptium.net/?variant=openjdk8&jvmVariant=hotspot.

Note

Ensure that the ‘Add to PATH’ option is enabled for the installation.

...

For Nuix Engine versions 9.4 and newer, Rampiva will use the JRE that ships with the Nuix Engine and no additional Java installation is required.

...

.

...

Nuix

...

Rampiva

...

1

Download the latest Rampiva Automate Release version from: https://downloads.rampiva.com/automate/release/index.html

Image Modified
2

Execute the Rampiva Automate installer and start the installation wizard by clicking Next. Then, read and accept the Rampiva End User License Agreement (EULA).

3

Select the server role as Scheduler and Workflow Designer, then click next.

Note

Only one Scheduler server should be installed per environment. Multiple Engine Servers can be installed in a single environment, one on each Virtual Machine or Host.

Image Modified
4

Confirm the installation and if prompted by Windows Account Control by clicking Yes to accept the action.

5

Configure Rampiva Automate Administrative Access by setting a username and password.

Info

The Administrative Access login is designed for initial setup and configuration of Rampiva Automate only. Refer to our Knowledge Base article on configuring additional authentication methods:

https://rampiva.atlassian.net/l/c/jRuxc4qa

Image Modified

6

OPTIONAL - For Multi Server Environments.

Set the API Secret to be used by the Rampiva Engine Servers.

Info

The API Secret can be any value and should be treated as a secure password. Rampiva recommends setting a random value of at least 16 characters.

Image Modified
7

Click Close to complete the installation.

Image Modified

B. Rampiva Automate - Configuration

1

Open a web browser and browse to https://localhost.

Note

Ensure you use HTTPS when entering the URL or the Scheduler Server.

Info

By default, Scheduler listens on HTTP (unencrypted) only on the localhost interface, and on HTTPS on all IP addresses / network adapters on the Rampiva Server. The HTTP (unencrypted) should only be exposed on localhost for troubleshooting.

Rampiva Scheduler uses a self-signed certificate. See Rampiva Scheduler documentation to update certificates. https://downloads.rampiva.com/automate/release/guides/scheduler/en_US/installation-guide.html#_managing_certificates

Image Modified

2

Log in with the Administrative Access username and password combination.

Image Modified
3

Click the Update License button to add a valid Rampiva License.

Image Modified
4

FOR RLS CLIENTS

Enter the License ID and License Key values provided by your Rampiva representative and click Update.

Info

Don’t Have a Rampiva Automate License?

See our KB article on requesting and applying licenses: https://rampiva.atlassian.net/l/c/mCStNmUs. Once a license has been obtained, return to this section to continue the Rampiva Automate installation.

Image Modified

5

Select the appropriate Diagnostics Level for your organization.

Info

See our Knowledge Base article https://rampiva.atlassian.net/l/c/y941RXhi for more information on Diagnostic Levels.

Info

Review our Privacy Policy here https://rampiva.com/privacy-policy/#diagnostic-level.

Image Modified

6

Click Update to apply the License ID and License Key.

Note

If you received the following error message when using the License ID and License Key combination:

IOException: java.net.UnknownHostException: api.rampiva.services

this means that the Rampiva Automate installation cannot communicate with the Rampiva License Server. Check your internet connection and ensure that the Rampiva Automate server has outbound internet access on port 443.

Image Modified
7

For Legacy licensing or Clients without open internet access.

Click Browse and select the .rlic file provided by your Rampiva representative.

Info

When using the Legacy licensing method, License ID, License Key, and Diagnostic Level are ignored.

Image Modified
8

Tip

If successful, information about your license will be displayed.

Image Modified

C. Rampiva Automate - Installation (Engines)

1

Execute the Rampiva Automate installer and start the installation wizard by clicking Next. Then, read and accept the Rampiva End User License Agreement (EULA).

Image Modified
2

Select the server role as Engine Server and Workflow Designer, then click next.

Info

Install the Engine Server role on any machine that will participate in Nuix Processing.

Note

Only one Scheduler server should be installed per environment. Multiple Engine Servers can be installed in a single environment, one on each Virtual Machine or Host.

Note

Workflow Designer must me installed on all machines where Engine Server is installed.

Image Modified
3

Confirm the installation and if prompted by Windows Account Control by clicking Yes to accept the action.

4

Click Close to complete the installation.

Image Modified

E. Rampiva Automate - Settings (Nuix License Sources)

1

Log in with the Administrative Access username and password combination used in Section C.

Image Modified
2

From the Settings menu, select Nuix License Sources.

Image Modified
3

Click the Add+ button next to the appropriate license source type.

Info

Rampiva Supports all Nuix license source types, except soft/virtual dongles.

4

Name the License Source and enter a valid username and password.

Info

The username and password entered here will either be provided by Nuix directly, or provided by the Nuix Management Server administrator.

Info

If multiple license types exist on the same server, you can use the Filter input to limit license acquisition to only that license type.

Image Modified
5

Click Test Source. If a successful test is completed, click Add Source

F. Rampiva Automate - Settings (Engine Servers)

1

From the Settings menu, select Engine Servers.

Image Modified
2

Click the Add+ button to add an Engine Server.

3

Name the Engine Server and enter the machine's IP address in the URL input. Optionally, add a description to the Engine Server.

4

Click the Add Server button to add the server to the Rampiva Automate Settings.

5

Typically an error will be displayed. This is by design. From within the error message, copy the GUID string at the end of the error, before clicking OK.

Image Modified

6

Click OK, then paste the value in the Whitelist section of the Add Engine Server dialogue box.

Image Modified
7

Click the Add Server button to add the Engine Server.

8

Repeat this section for each Rampiva Engine server role.

G. Rampiva Automate - Settings (Engines)

1

From the Settings menu, select Engines.

Image Modified
2

Click the Add+ button to add an Engine.

3

Name the Engine.

4

Select the corresponding Engine Server for the Engine.

5

Select the Nuix License source that the Engine will use.

6

Select the Target Worker count that best suits your environment.

7

Leave the Min Workers value set to 1.

8

Repeat this section for each Rampiva Engine role.

H. Rampiva Automate - Settings (Resource Pools)

1

From the Settings menu, select Resource Pools.

Image Modified

2

Click the Add+ button next to the appropriate Resource Pool type.

Info

Typical installations use Local Resource Pools

Image Modified
3

Name the Resource Pool.

4

Select the Engine(s) to use in the Resource Pool.

5

Basic Installation is now complete. Advanced installation requires configuration of the following items:

  • Notification Rules

  • Execution Profiles

  • Security Policies

  • Client Pools (if applicable)

  • Data Repositories (if applicable)

Contact us a support@rampiva.com for guidance on how to configure these items for your environment.

Page Properties
hiddentrue

Related issues