Define load file source data in a Metadata Import Profile

Use a Metadata Import Profile to import metadata into a case where existing items are matched by a defined parameter such as item GUID. When defining a Metadata Import Profile for use in a legal export, you can use source data from a number of file types.

This section covers:

Useful tips on creating and using metadata for load files

How to define a Metadata Import Profile with a Concordance load file as source data (primarily used)

How to define a Metadata Import Profile with a CSV or TSV load file as source data

How to define a Metadata Import Profile with an XML load file as source data

How to define a Metadata Import Profile with a JSON load file as source data

Useful tips on metadata for load files

Create Metadata Profiles for specific item types (email or files), specific purposes (exception handling), or for specific load file formats. Save, store, and share Metadata Profiles and Custom Metadata templates using the import and export functions.

You can effectively rename a Nuix-defined metadata property but have the value of your own label. For example, if you need the SortDate field in your load file, you can use item-date as its source.

In the Edit Derived Metadata window, select the Use custom date format option to create a formatting mask to convert date fields to other formats. This is useful in scenarios when using a load file format that only supports a specific time and date format (for example, MM/DD/YYYY in Concordance load files).

To create a date-formatted Derived Metadata field, click Add Field to build the required formats. If any special characters (/) are required between each date segment, you must insert them into the text box. Use the preview to help you see if the date is correctly formatted.

Use scripted metadata to create custom views of one or more pieces of metadata based on Nuix APIs. By using scripted metadata, you have complete control over the values that are returned. For instance, you can create a FileSize Human Readable field in your load file by using the getFileSize API method as its source. Scripted Metadata fields are fully exportable and can be part of a load file. See Add a Scripted Metadata Profile under Work with Metadata in the Nuix Workstation User Guide for more information.

Define a Metadata Import Profile with a Concordance load file as source data

The Concordance load file is primarily used as source data in Metadata Import Profiles that are used for legal export. To define a Metadata Import Profile with a Concordance load file as source data:

From the File menu, select Global Options, then Metadata Import Profiles.

In the Metadata Import Profiles dialog, click the plus icon (+) to add a new profile.

Select Case, User or Local Computer as the available Scope for the profile.

The Add Metadata Import Profile window opens and displays the Data Source, Column Mapping, and Value Mapping tabs that provide the attributes you can add to this profile.

On the Data Source tab, select either File as a data source type.

In File type select Concordance load file as your supported data source. Some fields on this dialog auto-populate according to your selection of File type.

In File Path browse your directory to select the Concordance load file you want.

In Opticon file, select the load file with links to image files with associated entries and provide the path to it.

In Delimiter Mode, select:

Standard to use these default delimiters:

Line delimiter:

Line Feed (used in Unix-like OS such as Linux and macOS)

Carriage Return (used in classic Mac OS and other types of OS)

CR LF (used in Microsoft Windows)

Column delimiter:

COMMA (used in CSV files)

TAB (used in TSV files)

CONCORDANCE (used in Concordance files)

Quote character:

DOUBLE_QUOTE (used in CSV and TSV files)

CONCORDANCE (used in Concordance files)

Custom to select available options for Line delimiter, column delimiter, and quote character delimiters, or enter a single character or the hexadecimal number of a Unicode character. For example, if you want the column delimiter to be a hash, enter ‘#’ in the column delimiter field or use its Unicode hexadecimal representation ‘0023’.

Note: Custom delimiters do not ingest structured data. They are used to read the import profiles.

In Charset, select the file encoding charset from the menu, then perform one of the following steps:

Select Use default date time format (yyyy-MM-dd) if you want to use this default format.

In Date time formatter, manually enter the date-time format you want.

Click Add Field to create your required format.

For Digest Settings, perform ‘Fetch Preview Data’ before the Source column becomes available, then perform the following steps:

Select Replace MD5 Digest if you created a different MD5 externally using a different algorithm and want to use it in Nuix Workstation mainly for deduplication. This selection enables the Source Column menu.

In Source Column, select the column in the Concordance file containing the required MD5 that you want to use to replace the Nuix MD5 digest.

Select one of the following:

Extract natives as separate items to extract the natives of a given load file item as a separate item.

Extract children of the native items to enable the child items of extracted natives to be processed.

Define a Metadata Import Profile with CSV or TSV load file as source data

To define a Metadata Import Profile with a CSV or TSV load file as source data:

Follow Steps 1 through 5 of the previous Define a Metadata Import Profile with a Concordance load file as source data, but at Step 5, in File type, select CSV or TSV as your supported data source.

In File Path browse to and select the relevant CSV or TSV source file.

Follow Steps 8 through 10 of Define a Metadata Import Profile with a Concordance load file as source data.

Note: The Opticon file field is disabled; and the Digest Settings and both Extract natives settings are hidden.

Define a Metadata Import Profile with an XML load file as source data

To define a Metadata Import Profile with an XML load file as source data:

Follow Steps 1 through 5 of the previous Define a Metadata Import Profile with a Concordance load file as source data, but at Step 5, in File type, select XML as your supported data source.

In File path, browse to and select the relevant XML source file.

In Namespaces, optionally enter XML namespaces for the XPaths, where each entry must contain a prefix and the URI using a comma separator. 

In XPath of row element, enter the path to be used to select records, where each record is a line item, and the XPath is absolute. If you use a XPath namespace prefix, it must match one of the namespace prefixes in the Namespaces field.

Example with namespace prefix: /ns:mediawiki/ns:page

Example without namespace prefix: /root

In XPaths, enter the paths to be used to select the elements or attributes in each record. They can be either:

An absolute XPath if the element or attribute is not in a row's context.

For example: /ns:mediawiki/ns:siteinfo/ns:namespaces/ns:namespace/@key

A relative XPath in the current context, for example: ns:title

If you use a XPath namespace prefix, it must match one of the namespace prefixes in the Namespaces field.

Other examples with a namespace prefix include:

ns:id

ns:revision/ns:id

ns:revision/ns:timestamp

ns:revision/ns:contributor/ns:username

ns:revision/ns:model

Define a Metadata Import Profile with a JSON load file as source data

To define a Metadata Import Profile with a JSON load file as source data:

Follow Steps 1 through 5 of the previous Define a Metadata Import Profile with a Concordance load file as source data, but at Step 5, in File type, select JSON as your supported data source.

In Row-level JSON Path, optionally enter the path to be used to select records in a JSON document where each record is a line item and the JSON Path is absolute.

For example: $.links.*

In JSON Paths, enter the paths to be used to select the elements or attributes in each record. They can be either:

A relative JSON Path in the current context. For example:

id

description

An absolute JSON Path if values are not in a row's context. For example:

$.title

$.templates[*].name

For more information on writing a JsonPath query, see https://github.com/json-path/JsonPath