Tiered Report

View the GitHub project here or download the latest release here.

Overview

Written By: Jason Wells

This script allows you to define and generate reports on data ingested into one or more Nuix cases. The report is generated as Excel XLSX work book with one or more work sheets. For each work sheet you select one or more Item Aspects, which represent information which can be captured about an item such as:

• Custodian
• Item Kind
• Tags
• etc.

Each report sheet is then generated in a tiered manner.

For example if I were to specify a sheet in the report with the following aspects:

• Evidence Name
• Item Kind
• Irregular Categories

I would get a report sheet which is first broken down by Evidence Name and then within that evidence further broken down by Item Kind and then finally broken down by Irregular Item Category.

For each tier the total number of items is reported as well as optionally things like total audited size and total file size.

Cloning this Repository

This script relies on code from Nx to present a settings dialog and progress dialog. This JAR file is not included in the repository (although it is included in release downloads). If you clone this repository, you will also want to obtain a copy of Nx.jar by either:

1. Building it from the source
2. Downloading an already built JAR file from the Nx releases

Once you have a copy of Nx.jar, make sure to include it in the same directory as the script.

Getting Started

Setup

Begin by downloading the latest release of this code. Extract the contents of the archive into your Nuix scripts directory. In Windows the script directory is likely going to be either of the following:

• %appdata%\Nuix\Scripts - User level script directory
• %programdata%\Nuix\Scripts - System level script directory

Item Aspects

These are aspects of items which you would like reported. Each selected aspect represents a tier in the report.

Customizations

Custom Metadata Based Aspects

By editing the file CustomMetadataAspects.json you can choose custom metadata fields to be includable in reports. The file has the following structure:

[
    {
        "enabled": false,
        "field_name": "UnconfiguredTemplate1",
        "report_label": "Unconfigured Template 1",
        "value_if_missing": "No Value"
    },
    {
        "enabled": false,
        "field_name": "UnconfiguredTemplate2",
        "report_label": "UnconfiguredTemplate2",
        "value_if_missing": "No Value"
    },
    {
        "enabled": false,
        "field_name": "UnconfiguredTemplate3",
        "report_label": "Unconfigured Template 3",
        "value_if_missing": "No Value"
    }
]

The structure consists of an outermost array in which each element is an object with the following structure:

For each entry in this file, an item aspect is created upon script startup. These choices will then appear in the script settings dialog along side the built in aspects.

Proprty Metadata Based Aspects

Similar to Custom Metadata Based Aspects mentioned above, metadata property based item aspects can be included as well by editing PropertyMetadataAspects.json.

Custom Basic Aspects

If you need something more complex that is not quite provided by values in custom metadata fields or metadata properties, you can also define code based item aspects in the file BasicScriptableAspectDefinitions.rb. In this file you can register a scripted item aspect by calling the following method:

ItemAspectFactory.registerBasicScriptableAspect(aspectName,aspectReportLabel,valueFunction)

For example, if I wanted to classify items in the report by how many characters are in their name, I could do the following:

ItemAspectFactory.registerBasicScriptableAspect("Item Name Length","Name Length Chars") do |nuix_case,item|
    next item.getLocalisedName.size
end

Value yielded should be a basic data type such as String, Integer or Boolean (think basic data types that translate to Excel well).

License

Copyright 2022 Nuix

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.