Skip to main content
Version: v0.16.0

Nuix Connector

The Sequence Nuix Connector allows users to automate forensic workflows using Nuix Workstation.

This connector has Steps to:

  • Create new cases
  • Ingest concordance and loose files
  • Search and tag items
  • Create and update item and production sets
  • Extract entities
  • Create reports
  • Export concordance or document metadata

Nuix SCL examples available here.

Source code available on GitLab.

Nuix Connector Settings

The NUIX Connector requires additional configuration which can be provided using the settings key in connectors.json.

Supported Settings

NameRequiredTypeDescription
exeConsolePathstringThe path to the Nuix Console application.
featuresstring[]The available Nuix features.
versionVersionThe installed version of Nuix.
consoleArgumentsstring[]List of console arguments to append to the nuix command.
consoleArgumentsPoststring[]List of console arguments to prepend to the nuix command.
environmentVariablesstring[]Environment variables to set before running Sequence.
ignoreWarningsRegexstringRegex used to ignore java warnings coming from the Nuix connection. The default values ignores warnings from Nuix Version up to 9.
ignoreErrorsRegexstringRegex used to ignore java errors coming from the Nuix connection. The default values ignores errors from Nuix Version up to 9.
licencesourcelocationstringSelects a licence source if multiple are available.
licencesourcetypestringSelects a licence source type (e.g. dongle, server, cloud-server) to use.
licencetypestringSelects a licence type to use if multiple are available.
licenceworkersintegerSelects the number of workers to use if the choice is available.
releaseboolReleases the semi-offline licence at the end of the execution.
signoutboolSigns the user out at the end of the execution, also releasing the semi-offline licence if present.

Using a License Dongle

"Reductech.Sequence.Connectors.Nuix": {
"id": "Reductech.Sequence.Connectors.Nuix",
"enable": true,
"version": "0.10.0",
"settings": {
"exeConsolePath": "C:\\Program Files\\Nuix\\Nuix 9.0\\nuix_console.exe",
"version": "9.0",
"licencesourcetype": "dongle",
"features": [
"ANALYSIS",
"CASE_CREATION",
"EXPORT_ITEMS",
"METADATA_IMPORT",
"OCR_PROCESSING",
"PRODUCTION_SET"
]
}
}

Using a License Server

"Reductech.Sequence.Connectors.Nuix": {
"id": "Reductech.Sequence.Connectors.Nuix",
"enable": true,
"version": "0.10.0",
"settings": {
"exeConsolePath": "C:\\Program Files\\Nuix\\Nuix 9.0\\nuix_console.exe",
"version": "9.0",
"licencesourcetype": "server",
"licencesourcelocation": "myserver",
"licencetype": "law-enforcement-desktop",
"ConsoleArgumentsPost": [
"-Dnuix.licence.handlers=server",
"-Dnuix.registry.servers=myserver"
],
"EnvironmentVariables": {
"NUIX_USERNAME": "user.name",
"NUIX_PASSWORD": "password"
},
"features": [
"ANALYSIS",
"CASE_CREATION",
"EXPORT_ITEMS",
"METADATA_IMPORT",
"OCR_PROCESSING",
"PRODUCTION_SET"
]
}
}