Nuix shared application folder
The Nuix shared application folder is a directory that consolidates the artifacts and data resources that are shared between Nuix applications into a common location. This location is configurable within the Global settings of the Nuix Config tool using The Nuix shared application folder property. For distributed systems in a HA environment, a single network share can be configured for this location to easily share data resources between applications.
Default location: <InstalDir>Nuix/Shared
Note: The Nuix shared application folder is only created when Nuix Investigate is installed.
Within the shared application folder, sub-folders exist for each of the following types of data:
| Sub-folder |
Location that contains… |
| cases |
Nuix cases. Use this property when storing cases in the same location or network share as other shared Nuix application data. |
| export-discover |
Exported items for Nuix Discover. |
| exports |
Exported items and reports. |
| group-config |
Custom highlighting and hotkey configurations. |
| searchFilterIcons |
Custom icons used for user-created search filters. |
| shared-user-data |
Search lists, custom metadata, and other profiles. |
| users-config |
User-created Dashboard perspectives. |
| user-scripts |
User-generated scripts. |
| visualizationConfig |
Custom dashboard analytics. (Nuix Investigate) |
| workflows |
User-created workflows. (Nuix Investigate) |
Modify the Nuix shared application folder
Follow the instructions included in this section to modify the shared application folder using the Nuix Configuration Utility.
Important: Using the Configuration Utility to change the location of the Nuix shared application folder does not move existing files on the file system or create the required directory structure in the new location.
To modify the location of the Nuix shared application folder:
Create a new directory or networked file share.
Copy the directory structure including all files from the original location to the new location.
Access the Configuration Utility and select Global from the service selector.
Locate The Nuix shared application folder property and update its value with the new location.
Save your changes and restart all services.
Upgrade to the Nuix shared application folder
The Nuix shared application folder was introduced in Nuix Neo v1.1. If upgrading an earlier version of Nuix Neo to v1.1 or later, follow the instruction in this section to migrate your data.
Note: Migrating to the new Nuix shared application folder is optional and only required if you want to take advantage of the new single directory structure.
To upgrade your installation to use the Nuix shared application folder:
Run the installer to upgrade your previous Nuix Neo installation to version 1.1 or later.
Follow the steps in the Modify the Nuix shared application folder section to create a new directory or networked file share.
Navigate to the global distributed properties folder at the following location:
<InstallDir>/Nuix/Nuix-Config/properties
Locate the files identified in the following table and make the indicated modifications:
| Properties file |
Modify |
| application.properties |
Add: engine.userDataDirs=./nuix-engine,${app.globalShare}/shared-user-data app.userScriptsLocation=${app.globalShare}/user-scripts |
| investigate/application.properties |
Remove: engine.userDataDirs app.userScriptsLocation Update: engine.exportsFolder=${app.globalShare}/exports app.workflowFolderLocation=${app.globalShare}/workflows app.visualizationConfig=${app.globalShare}/visualizationConfig app.searchFilterIconsLocation=${app.globalShare}/searchFilterIcons app.userFoldersLocation=${app.globalShare}/users-config app.groupConfigFolderLocation=${app.globalShare}/group-config discover.exportDir=${app.globalShare}/export-discover |
Save your changes and restart all services.
Upload external artifacts
External artifacts such as user-generated lists or profiles can be uploaded for use within Nuix Neo applications. These artifacts can be accessed and used within the application to organize the view of data or supplement queries and search filters with predetermined data sets that may be relevant to the case.
To use an artifact, an administrator must upload it to the server so that it is available to users at runtime. Artifacts placed on the server will be accessible to all cases.
The following table provides the server locations where supported artifacts can be uploaded for use in Nuix Neo.
| Artifact |
Installation location |
| Custom metadata |
<INSTALLDIR>\Nuix\shared\shared-user-data\Custom Metadata |
| Digest lists |
<INSTALLDIR>\Nuix\shared\shared-user-data\Digest Lists |
| Fuzzy Hash lists |
<INSTALLDIR>\Nuix\shared\shared-user-data\Fuzzy Hash Lists |
| Shingle lists |
<INSTALLDIR>\Nuix\shared\shared-user-data\Shingle Lists |
| Word lists |
<INSTALLDIR>\Nuix\shared\shared-user-data\Word Lists |
| Imaging Profiles |
<INSTALLDIR>\Nuix\shared\shared-user-data\Imaging Profiles |
| OCR Profiles |
<INSTALLDIR>\Nuix\shared\shared-user-data\OCR Profiles |
| Metadata profiles |
<INSTALLDIR>\Nuix\shared\shared-user-data\Metadata Profiles |
| Named entities |
<INSTALLDIR>\Nuix-Investigate\shared-user-data\Named Entities |
| Processing Profiles |
<INSTALLDIR>\Nuix\shared\shared-user-data\Processing Profiles |
| Production Profiles |
<INSTALLDIR>\Nuix\shared\shared-user-data\Production Profiles |
| Scripts |
<INSTALLDIR>\Nuix\shared\user-scripts |
| Search macros |
<INSTALLDIR>\Nuix\shared\shared-user-data\Search Macros |
Note: If a metadata profile is updated or removed while in use by an open case, any query that is performed using that profile at the time of the change will fail initially. After the failure, the list of metadata profiles known to Nuix Investigate will refresh to include the changes.
Perform the initial search again to return results using the updated profile. If the selected metadata profile was removed, the default metadata profile will be applied to the result set.