Configure Nuix NLP with Nuix Workstation
To authenticate the connection from Nuix NLP to Nuix Workstataion v.9.11 or later in either an on-premise or SaaS deployment, you must have a trusted SSL self-signed certificate wtih a token key installed in its trust store.
This section includes how to:
Authenticate with NLP on-premises
Authenticate with NLP in a SaaS environment
Connect Nuix NLP with Nuix Workstation on-premises
To connect Nuix NLP to Nuix Workstation in an on-premises environment and authenticate the connection, you need to ensure that you have the following:
Nuix NLP feature as part of your Nuix Workstation license
Nuix NLP credentials that authorize sending and retrieving data from Nuix NLP or accessing NLP APIs.
To use the credentials required to authenticate Nuix NLP on-premises:
Locate and copy the certificate's credentials.
Import, validate, and install the required Nuix NLP SSL access certificate and token.
Add these Nuix NLP credentials into Nuix Workstation.
Locate and copy the certificate's credentials
Before you can add your NLP credentials in Nuix Workstation, you must obtain the relevant certificate from the Nuix NLP Text Editor to authenticate your use of Nuix NLP in an on-premises installation of Nuix Workstation.
Together the SSL certificate and key are stored in the keystore file. You must have a trusted SSL certificate and key in your keystore location, and then copy the access certificate.
To find and copy the certificate's credentials:
Log into the NLP server as an administrator. The Nuix NLP Text Editor opens.
From the editor's left menu panel, select System Info.
On the System Info page, scroll down under Server and System details, to find entries for the following:
Access token
Access certificate
Under the Access token, copy the whole Access token. This is what you must paste into the Nuix NLP credential field in the following Add your Nuix NLP credentials in Nuix Workstation section.
Under the Access certificate, copy the whole Access Certificate and save it as a standalone certificate.pem file.
Name and save this file as one-half of the keystore under your Nuix Workstation installation directory inside the \lib\security folder.
For example, save it to: C:\Program Files\Nuix\Nuix 100.x\jre\lib\security.
Optionally, you can save the Access token as a standalone token.pem file in the same location as the certificate.pem file.
Together, they establish the trust relation between the server running Nuix NLP on-premises and the server running Nuix Workstation.
Import, Validate, and install the SSL access certificate and token
Ensure the certificate is pre-installed at the correct Java path under your Nuix Workstation installation. It must be inside the \lib\security folder (for example, in C:\Program Files\Nuix\Nuix 100.x\jre\lib\security).
To import, validate, and install your SSL access certificate, using a command line:
Create a new file named certificate.pem (or any .pem file) and paste the Nuix NLP certificate text into it.
Move this certificate file to: C:\Program Files\Nuix\Nuix 100.x\jre\lib\security
It must be inside the \lib\security folder under your Nuix Workstation installation.
Open up a command prompt as 'administrator'.
Enter $ cd C:\Program Files\Nuix\Nuix 100.x\jre\lib\security
Then enter: $ "C:\Program Files\Nuix\Nuix 100.x\jre\bin\keytool.exe" -import -alias nuix-nlp-on-prem -storepass changeit -keystore cacerts -file "C:\Program Files\Nuix\Nuix 100.x\jre\lib\security\certificate.pem"
When prompted to 'Trust the certificate type?', enter Yes.
A prompt informs you that the 'Certificate was added to keystore'. Now you must add the digital key for the access token to test whether it is trusted.
Add your Nuix NLP credentials in Nuix Workstation
To add your Nuix NLP credentials:
Open Nuix Workstation and in the Global Options window, select Configuring Connections.
Select the Nuix NLP tab, and in the Nuix NLP credential field, paste in the copied digital key for the access token, from step 4 of the Locate and copy the certificate's credentials section.
To validate the connection, click Test connection. If the connection is successful, the Test connection succeeded message appears. The connection value is persistent and available for further NLP analysis.
Note: Nuix Workstation stores Nuix NLP credentials at the user level.
Connect Nuix NLP with Nuix Workstation in a SaaS environment
To connect Nuix NLP to Nuix Workstation and authenticate the connection in a SaaS environment, you need to ensure that you have the following:
Nuix NLP feature as part of your Nuix Workstation license.
Nuix NLP credentials that authorize you to send and retrieve data from Nuix NLP.
To use the credentials needed to authenticate Nuix NLP in a SaaS environment:
Locate and copy the Nuix NLP's credentials.
Add your Nuix NLP credentials in Nuix Workstation.
Locate and copy your Nuix NLP credentials
To authenticate your use of Nuix NLP in a SaaS installation of Nuix Workstation before you can add your NLP credentials in Nuix Workstation, you must locate the relevant certificate using the Nuix NLP Text Editor. Together the SSL certificate and key are stored in your keystore file. If you already have a trusted SSL certificate and key in your keystore location, copy the access certificate.
To find and copy the NLP certificate's credentials:
Sign into the Nuix SaaS Portal as an administrator using the credentials Nuix provides to you.
Click on the NLP icon.
Add your Nuix NLP credentials in Nuix Workstation
To add your Nuix NLP credentials:
Open Nuix Workstation and in the Global Options window, select Configuring Connections.
Select the Nuix NLP tab, and in the Nuix NLP credential field, paste in the copied digital key for the Access token, from Step 4 of the preceding Locate and copy the certificate's credentials.
To validate the connection, click Test connection. If the connection is successful, the Test connection succeeded message appears. The connection value is persistent and sticky for further NLP analysis.
Note: Nuix Workstation stores Nuix NLP credentials at the user level.