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

Name	Required	Type	Description
exeConsolePath	✔	string	The path to the Nuix Console application.
features	✔	string[]	The available Nuix features.
version	✔	Version	The installed version of Nuix.
consoleArguments		string[]	List of console arguments to append to the nuix command.
consoleArgumentsPost		string[]	List of console arguments to prepend to the nuix command.
environmentVariables		string[]	Environment variables to set before running Sequence.
ignoreWarningsRegex		string	Regex used to ignore java warnings coming from the Nuix connection. The default values ignores warnings from Nuix Version up to 9.
ignoreErrorsRegex		string	Regex used to ignore java errors coming from the Nuix connection. The default values ignores errors from Nuix Version up to 9.
licencesourcelocation		string	Selects a licence source if multiple are available.
licencesourcetype		string	Selects a licence source type (e.g. dongle, server, cloud-server) to use.
licencetype		string	Selects a licence type to use if multiple are available.
licenceworkers		integer	Selects the number of workers to use if the choice is available.
release		bool	Releases the semi-offline licence at the end of the execution.
signout		bool	Signs the user out at the end of the execution, also releasing the semi-offline licence if present.

Using a License Dongle

"Sequence.Connectors.Nuix": {
  "id": "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

"Sequence.Connectors.Nuix": {
  "id": "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"
    ]
  }
}