v1.18.0 Preview 20240326

The primary addition to the script is the new options for what things are hyperlinked on each summary:

This will control which of these things are hyperlinked in the summary:

If a given item does not have the given thing to link to, it will note it with a message in place of the hyperlink. Note that these settings do not control whether the given thing is exported or generated, just whether the summary has a column to try and hyperlink to it. Whether PDFs, Natives or Item Details are exported is determined by the choices under Item Products, with a new setting named Generate Item Details to set whether Item Details are generated:

Version 1.17.1

Removed code that attempted to pull some processing preferences from the Windows registry. Code was on the older side and attempting to get registry values that Nuix no longer populates. In most instances I do not expect this update to provide much difference for those already using the script, with the noted exception that the script may now run on non-windows machines where it may not have before.

Version 1.16.3

Summary column values which should be wrapped in a <pre> tag to attempt to preserve originally text formatting can now be configured at the top of the file InvestigatorReport.rb by editing the default value :preformatted_summary_columns. By default this includes columns:

• Comment
• Body

defaults = {
	:export_directory => "C:\\InvestigatorReports".gsub(/[\/\\]$/,File::SEPARATOR),
	:worker_count => nil,
	:worker_memory => 1024,
	:worker_temp => "C:\\NuixWorkerTemp".gsub(/[\/\\]$/,File::SEPARATOR),
	:report_title_prefix => "Report ",
	:report_excluded_items => true,
	:item_details => {
		"export_natives" => false,
		"export_pdfs" => false,
		"export_text" => false,
		"export_thumbnails" => false,
		"image_spreadsheets" => false,
		"regenerate_stored_pdfs" => false,
		"include_comments" => false,
		"include_properties" => true,
		"include_tags" => false,
		"include_custom_metadata" => false,
		"include_profile" => false,
		"included_profile_name" => "Default metadata profile",
		"include_text" => true,
	},
	:summary_default_profile_name => "Default metadata profile",
	:summary_default_item_sort => "Item Position",
	:preformatted_summary_columns => ["Comment","Body"]
}

Version 1.16.2

As of v1.16.0, when the field Comment is included in a profile used for summary pages, the comment is wrapped in a <pre></pre> to preserve manually added line breaks.

This update extends this functionality a bit further. The Comment field values are now wrapped in <pre class="comment_col"></pre> which can be edited in styles.css in the resources sub-directory of the script. This style definition now wraps lines that extend beyond the <pre> container, while still attempting to maintain original formatting when possible.

Note that if you wish to restrict the maximum width of this comment containing <pre> container, edit styles.css to include a maximum width:

/*
This class is added to <pre> tag wrapping cells in Comment column of summaries.  If you wish to restrict how wide
that <pre> can get then add this to the below, changing width to desired value:
max-width:250px;
*/
pre.comment_col {
	white-space:pre-wrap;
	white-space:-moz-pre-wrap;
	white-space:-pre-wrap;
	white-space:-o-pre-wrap;
	word-wrap:normal;
	word-break:keep-all;
}

Version 1.16.0

Now when profile used to generate a summary contains the field Comment the value written to the table will be wrapped with <pre></pre> tags to preserve newlines someone may have entered into that item's comment field in Nuix.

Version 1.15.0

Added "Index" column to summaries which acts as a convenient row reference. Index value restarts at beginning of each new summary and continues through the various pages of a given summary sequentially.

Version 1.14.1

Fixed 4 wide zero fill used while generating summary report links in main HTML file, while actual file names would be generated with 8 wide zero fill. This was causing the links to fail showing the relevant summary page in the inner frame when clicked.

Fixed so that both locations now use 8 wide zero fill.

Version 1.14.0

• Added support for specifying default summary sort order by editing the following setting at the top of InvestigatorReport.rb:

:summary_default_item_sort => "Item Position"

• New summary sort order "None" which applies no sort to items and instead writes them to the summary files in whatever order Case.searchUnsorted may return them. If a given tag/summary contains many items, this sort order can drastically reduce memory used while generating summary pages.
• Added logic to use sort methods added to ItemUtility if Nuix version is 8.0 or higher
• HTML escaping now provided by Apache Commons Text. Was originally using Ruby built in html_escape provided by ERB::Util but I factored it out in cases it was causing excessive string allocations for some reason. Ultimately didn't seem to make much of a difference in my testing, but I decided to just leave it in there.
• Various other small tweaks in attempts to reduce memory used by summary generation methods before I realized item sort seems to be the biggest culprit of out of memory exceptions while generating summaries for large collections of items.

Version 1.13.0

• Re-wrote most of the code responsible for generating summary pages in an attempt to optimize things and write values to disk as soon as possible versus storing up calculated values in memory and writing them in big chunks. This should hopefully relieve some issues encountered when a large number of items are to be reported for any one summary.
• Added button to change the sort order of all summary definitions at the same time.
• Added a setting to the top of InvestigatorReport.rb that allows you to configure the default metadata profile for summary generation:

:summary_default_profile_name => "Default metadata profile",

Version 1.12.0

Improved how item content text is written to item detail pages.

• Most of HTML template is first rendered and written to file
• If text is being included in details page, it is written in a separate pass, to reduce chances for large text to cause problems.
  • If using Nuix 8.6, the new Text.usingText method is now used to stream item text a line at a time to the output file. This should hopefully prevent a class of errors that can occur with really large item text.
  • If using a version of Nuix prior to 8.6 then old Text.toString method is still used due to lack of alternative in these versions.
• Very basic HTML compression now applied to details files. Ultimately will probably reduce report sizes very little, but I figure save it where you can.