Nuix SDK – Release Notes

Getting Started: Version 9.4 Release Notes

Tue, 27 Jul 2021 00:00:00 +0000

Nuix Engine

Nuix RESTful Service has been updated to use version 9.4 of the Nuix Engine. Details about what is included with this update can be found in the v9.4 changelog.

Nuix Collector for Microsoft 365

Nuix RESTful Service now supports the ability to ingest data directly from Microsoft Office 365 using the following new processing endpoint.

POST /cases/{caseId}/evidence/ms365

Using the new endpoint in conjunction with your Microsoft tenant and the Microsoft Graph API, you can now access data from the following Office 365 applications:

Teams
- Threaded channel and private messages
- Attachments
- Calendars
Exchange
- Email
- Contacts
SharePoint
- Sites
- Subsites
- Lists (Retrieval of list attachments is not supported.)

For more information, see Ingesting from Microsoft Office 365.

Access

Nuix RESTful Service now supports the ability to configure specific license server types during installation. Supported server types include:

Nuix Management Server (NMS)
Relay server with NMS users
Relay server with CLS users
Cloud License Server (CLS)

For more information, see Licensing Configuration.

Culling

Item sets

The GET /cases/{caseId}/itemSets/{itemSetName}/items endpoint has been enhanced to now support item marshaling through a new optionsRequest parameter. The new parameter includes the following configurable options:

{
  "caseId": "string",
  "query": "string",
  "startIndex": 0,
  "numberOfRecordsRequested": 100,
  "deduplicate": "md5",
  "metadataProfile": "string",
  "fieldList": [
    "string"
  ],
  "customMetadataList": [
    "string"
  ],
  "propertyList": [
    "string"
  ],
  "itemParameterizedFields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "asc"
}

Deprecated endpoints

The following endpoints have been deprecated as they include a payload body which has no defined semantic meaning within a DELETE request:

DELETE /cases/{caseId}/itemTags
DELETE /cases/{caseId}/tags
DELETE /cases/{caseId}/itemCustomMetadata
DELETE /cases/{caseId}/itemSets/{itemSetName}/items

The functionality of the deprecated DELETE endpoints has been integrated in the following new PATCH endpoints:

PATCH /cases/{caseId}/itemTags

Create or remove tags from query items in bulk.
PATCH /cases/{caseId}/tags

Create or delete tags for a case in bulk.
PATCH /cases/{caseId}/itemCustomMetadata

Add or remove custom metadata on items in bulk.
PATCH /cases/{caseId}/itemSets/{itemSetName}/items

Add or delete items to an item set in bulk.

Default JVM arguments

The following JVM arguments are no longer required and have been removed from the default startup configuration of Nuix RESTful Service:

-Dnuix.processing.worker.timeout=3600

Sets the timeout in seconds before an item is considered poisoned.
-Dnuix.region.enableIterruptChecking=true

Controls whether interrupts are checked when data is read.
-Dnuix.storage.index.lazyLoadFields=false

Minor search performance improvement.
-Dnuix.storage.index.readers=shared

Minor search performance improvement.
-Dnuix.store.textIndexDirectoryType=mmap

Specifies the type of directory to use.

The following JVM argument has been added:

-Dnuix.worker.useNuixFs=false

Controls whether to use Nuix fs for local or remote workers.

Export

When generating thumbnails, if an export directory has not been defined, thumbnails will be exported to a default directory and a warning message will be logged.

Resolved Issues

The name parameter is now required within the request body of the POST /cases/{caseId}/itemSets endpoint to prevent errors when creating a new item set.

Getting Started: Version 9.2 Release Notes

Tue, 20 Apr 2021 00:00:00 +0000

Nuix Engine

Nuix RESTful Service has been updated to use version 9.2 of the Nuix Engine. Details about what is included with this update can be found in the v9.2 changelog.

Nuix Developer Documentation

Nuix is proud to announce the introduction of the Nuix Developer Portal as a new source for online based Nuix SDK developer documentation.

Access the portal to find the latest documentation for installing and configuring your instance of Nuix RESTful Service, API references, quick start guides, tutorials, code samples, and more.

Visit https://nuix.github.io/sdk-docs/latest/ to access to the latest Nuix SDK developer documentation to help automate your workflows using the Nuix APIs.

Promote to Nuix Discover®

Nuix RESTful Service now supports the ability to export items from a Nuix case directly to an existing Nuix Discover SaaS case using the new Promote to Nuix Discover endpoint

/cases/{caseId}/promoteToDiscover/{discoverCaseId}

With this endpoint, users can promote a subset of discoverable items to an existing Nuix Discover SaaS case for further analysis, review, and production.

Access

The /authenticatedUsers/login endpoint has been updated to now accept both US and UK spellings of the licenseShortName parameter. Accepted parameter spellings include:

licenseShortName - (US)
licenceShortName - (UK)

Processing

The default values associated with the ProcessorSettings parameter have been updated to match the current version of the Nuix Engine.

General Enhancements

The Dnuix.executor.threads system property has been removed from the default startup java options used by Nuix RESTful service.

Resolved Issues

Nuix RESTful Service no longer sets a system path variable for the Nuix Engine in Windows based installations. This modification allows multiple instances of the Nuix Engine to coexist on the same machine.
Instances where source evidence is missing or has been removed from a case are now indicated with the correct error message.
An issue has been resolved that caused a null pointer exception to occur when making calls to the /cases/{caseId}/thumbnails endpoint.
Nuix Server has been added as a valid Nuix license type that can be consumed by Nuix RESTful Service.
Accessing the API Swagger documentation at http://<serverName>:8080/nuix-restful-service/svc/docs no longer causes a 401 Unauthorized Error due to a jsessionid being appended to the URL after redirect.
Custom processing profiles are no longer ignored and replaced with default processing settings when using the Nuix Scripting API.

Getting Started: Version 9.0 Release Notes

Tue, 20 Apr 2021 00:00:00 +0000

Nuix Engine

Nuix RESTful Service has been updated to use version 9.0 of the Nuix Engine. Details about what is included with this update can be found in the v9.0 changelog.

Java 11

Nuix RESTful Service has been upgraded to OpenJDK 11.

Elasticsearch 7.8.1

Nuix RESTful Service has been updated to support Elasticsearch v7.8.1. To use existing Elasticsearch based Nuix cases, your Elasticsearch cluster must first be upgraded to v7.8.1.

Refer to the Elasticsearch Reference [7.8] documentation for details on performing this upgrade.

Note

Nuix RESTful Service v9.0 is not compatible with earlier versions of Elasticsearch.

Culling

The AsyncItemSetDelete function of the /cases/{caseId}/itemSets/{itemSetName} endpoint has been modified to now function asynchronously.

OCR Profile Details

A new OCR endpoint has been added that enables users to retrieve the template details of a specified OCR profile.

GET /ocrProfiles/{name}/details

Paginated Results

The numberOfRecordsRequested parameter used by search-based endpoints has been modified to now return paginated results by default. This changes the previous default behavior which was to return all results at once. Calls to any of the following endpoints will now return results in increments of 100 by default. This value can be modified by updating the numberOfRecordsRequested parameter with a custom value.

Endpoints affected by this change include:

/cases/{caseId}/clusterRuns/{clusterRunName}/items
/cases/{caseId}/itemSets/{itemSetName}/items
/cases/{caseId}/productionSets/{productionSetId}/items
/cases/{caseId}/search

General Enhancements

All code and dependencies associated with the User Management Server (UMS) have been removed from Nuix RESTful Service as UMS is not functionally required for the operation of Nuix REST.

Resolved Issues

An issue has been resolved that prevented failed functions from returning a failure status.
OCR text output is now immediately available to the case when an OCR function completes successfully.
MD5 deduplicated requests to the /v1/cases/{caseId}/count endpoint no longer generates a null pointer exception.

Getting Started: Known Issues

Tue, 20 Apr 2021 00:00:00 +0000

Creating Item Sets

Creating an item set from a user-generated script where the query parameter is not defined automatically includes all items in the generated item set by default.

Workaround: To prevent all items from being included, ensure that the query parameter is defined with either a valid query or a null value to prevent all items from being included.

NTLM Authentication

The use of NTLM authentication is no longer supported by Nuix. If NTLM authentication is used, an authentication token is always acquired when calling the PUT /v1/authenticatedUsers/login endpoint.

Workaround: Nuix recommends using basic authentication with Nuix Management Server and Nuix RESTful Service.

Licence Description Parameter

The licenceDescription parameter used in conjunction with the /v1/authenticatedUsers/login endpoint has been deprecated because the description associated with this parameter is subject to change. The LicenseDescription parameter will be removed in a future release.

Workaround: The licenceShortName parameter should be used in its place along with the license’s short name.

Cookies2.dat

When a Nuix-generated cookies2.dat file is located in any userDataDirs folder set in nuix-restful-service.properties, an authentication token is always acquired when calling the PUT /v1/authenticatedUsers/login endpoint.

Workaround: Nuix recommends periodically checking to ensure that this folder does not contain a cookies2.dat file.

/v1/cases/{caseId}/keyStore Endpoint

The POST /v1/cases/{caseId}/keyStore endpoint is still under development and not intended for customer use in this release.

Case Title Migration Issues

Cases that contain a comma (,) or dollar sign ($) in the title will fail the migration process to version 7.0.

Workaround: Cases that have titles that include these symbols should be renamed prior to migration.