SaaS / Hosted Monthly Release Notes - October 2020 (10.4.009 - 10.5.000)

Tools > Imaging: Image viewer support for Adobe Photoshop file formats (.psd and .psb)

In the Imaging window, you can now submit .psd and .psb files, which are Adobe Photoshop file formats, for imaging to a TIFF, JPEG, or PDF format, as shown in the following figure.

Once the files are imaged, you can view the imaged files in the Image viewer in the View pane.

Imaging > Properties page

Case Setup > Issues: Issue administration enhancements

The Issue administration feature has been enhanced in this release and include the following updates:

Note: Administrators grant group leaders access to issue management on the Security > Administration page by setting the Case Setup - Issues - Properties and Case Setup - Issues - Security functions to Allow.

Add a root issue with child issues at the same time

Use the following procedure to add a root issue and child issues at the same time.

Note: Previously, this was a two-step process.

  1. On the Case Setup > Issues page, on the toolbar, click Add.
  2. In the Add issues dialog box, as shown in the following figure, provide a Name for the root issue.
  3. Add issues dialog box
  4. In the Child issue name(s) box, provide the names of the child issue.
  5. Note: Create a new line for each issue.

  6. Click Save.
  7. The root issue appears on the Issues page, as shown in the following figure. In the Name column, click the name of the root issue.
  8. Case Setup > Issues page
  9. The Child Issues page appears. To add additional issues to the child issues that you created, click the Add issue button, as shown in the following figure.
  10. Child Issues page

Clone a root issue and include child issues

You can now clone an existing root issue, including all of its child issues.

Note: When you clone an issue, the application clones only the issue structure, but not the document membership, that is, documents that were coded to the issues that you cloned.

Use the following procedure to clone an existing root issue.

  1. On the Case Setup > Issues page, hover over the row for an issue, and then click the Clone Issue button, as shown in the following figure.
  2. Case Setup > Issues page showing the Clone Issues button
  3. In the Clone Issue dialog box, as shown in the following figure, leave the name of the cloned issue or edit the name.
  4. Clone Issue dialog box
  5. Click OK.
  6. The cloned issue appears on the Issues page.

Import issues

You can now import issues using a .csv file.

Use the following procedure to import issues.

  1. On the Case Setup > Issues page, on the toolbar, click Import issues.
  2. In the Import issues dialog box, as shown in the following figure, do one of the following:
  3. Import issues dialog box
    • If you have a .csv file with issues, click Browse to upload your .csv file.
    • If you do not have a .csv file prepared, click the Download template link to download and populate a .csv file, and then click Browse to upload your .csv file.
    • Note: In the .csv file, the parent and child issues must be separated by a comma.

    The following figure provides an example of the format for the .csv file (created in a text editor).

    Example of format for .csv file in text editor

    The following figure provides an example of the format for the .csv file (opened in Microsoft Excel). The root issue name is in column A, the parent issue name is in column B, and the child issue names are in column C.

    Example of format for .csv file in Excel
  4. After you upload your .csv file, click OK.
  5. Note: If the application encountered errors when importing the .csv file, a notification appears, with a link to the errors. Fix the errors, and upload the .csv file again.

Export issues

You can now export issue to a .csv file format.

Use the following procedure to export issues.

  1. On the Case Setup > Issues page, select the check box next to an issue.
  2. On the toolbar, click Export issues.
  3. In the Export issues dialog box, click OK.
  4. The application downloads the .csv file to your computer.

    If you open the .csv file in Microsoft Excel, the information in the .csv file will look similar to what is shown in the following figure.

    Example of export issues .csv file in Excel

    If you open the .csv file in a text editor, the information in the .csv file will look similar to what is shown in the following figure.

    Example of export issues .csv file in text editor

Move child issues to a different root issue

You can now move child issues from one root issue to another root issue. You cannot currently move child issues within the same root issue.

Note: When you move issues, the application maintains the document membership, that is, documents that are coded to issues.

Use the following procedure to move child issues.

  1. On the Case Setup > Issues page, click the link for a root issue.
  2. On the Child Issues page, select the check boxes next to one or more issues, as shown in the following figure. To select all child issues, select the top check box.
  3. On the toolbar, click Move.
  4. Cild Issues Move feature
  5. In the Move Issues dialog box, as shown in the following figure, under Root issues, click the link for a root issue.
  6. Move Issues dialog box
  7. Click OK.
  8. The application moves the selected child issue or issues from the current root issue to the destination root issue.

    Note: If a child issue with the same name already exists in the destination root issue, the application will notify you and the issue is not moved. Change the name of the child issue and repeat the previous steps.

Case Setup > People Identity: Names Normalization enhancements

There are enhancements to the Names Normalization feature on the Case Setup > People Identity page in this release, including:

  • People Identity page: Information header over the columns and a link to non-normalized people in the banner
  • Assign identity dialog box: Delete empty identities after identity assignment option
  • Delete identity conformation message

These enhancements are described in the following sections.

People Identity: Information header over the document count columns and link to non-normalized names in the banner

The People Identity page has a new informational header, Occurrences in documents, located above the document count columns, as shown in the following figure. The counts in these columns reflect the number of occurrences that names appear in documents. See the infotip located next to the header for more information.

There is a link to View non-normalized names, located in the banner, as shown in the following figure. If you click the link, the rows are filtered to show all Non-normalized people.

People Identity page showing non-normalized people

Assign identity: Delete empty identities after assigning identities

When you assign people to a new identity, there is now an option to delete the source identity after you make the assignment, if there are no remaining people linked to that identity. If the source identity has fields coded, the coding will also be deleted. This option, shown in the following figure, is not selected by default. If you decide to delete the empty identities, select the check box, and then click OK.

Assign identity dialog box

Delete identity: Confirmation when deleting an identity

When you delete an identity that has no people assigned to it, the Delete identity dialog box appears, as shown in the following figure. If you are sure you want to delete the identity, click OK.

Delete identity dialog box

If you try to delete an identity that has user-created fields with coded values, the Delete identity dialog box shows a warning and lists the fields that are coded, as shown in the following figure.

To delete the identity, click OK.

Delete identity dialog box showing message of user created fields warning

Manage Documents > Imports: Delimiter column removed from field map for Ringtail MDB load files

Ringtail MDB load files do not support using a delimiter to separate multiple field values.

Starting with this release, when you add an import job on the Manage Documents > Imports page, if you select the Ringtail - MDB job type on the Import Details page in the Import window, the Delimiter column no longer appears on the Field Map page in the Import window.

The Delimiter column still appears for a Flat file job.

Note: If you clone a previous Ringtail - MDB import job and the Delimiter value was set, the value is not applied to the new import job.

Case and Servers > Case Options: New case options for the Predictive Coding feature

The following case options for Predictive Coding have been added to the Portal Management > Case and Servers > [Case] > Case Options page.

Tip: Hover over an infotip to view additional information about an option.

  • Predict Large Document Truncation Length: Amount of characters to keep at the beginning of a long text after truncation.
    • Default value: 100000000
  • Predict Max Document Size: Maximum size (in MB) of a document allowed before its contents are truncated.
    • Default value: 500
  • Predict Tokenization Batch Max Size: Maximum size in bytes of a batch allowed when there is more than one document.
    • Default value: 300

Case and Servers > Case Options: New case option when translating with a Microsoft custom translation model

Portal administrators can now configure a custom translation model to be used for Microsoft translations for a specific case and for a specific language pair.

Note: You must work with Nuix to configure this feature in your SaaS environment. To request access to this feature, submit a ticket on the Nuix Support Portal, located at https://nuix.service-now.com/support.

A custom translation model allows you to create a customized dictionary of domain-specific source language and target language terms for a specific language pair.

Microsoft refers to this feature as the Microsoft Custom Translator. Custom models will need to be created in Microsoft’s Custom Translator portal in Azure.

To use a custom translation model for a case, enter the Category ID, which is the unique identifier for the custom model, in the Translate with Microsoft custom model box on the Portal Management > Case and Servers > [Case] > Case Options page, shown in the following figure.

Translate with Microsoft custom model field box

Organizations: Note about changing case metrics settings

When you change the case metrics settings for an organization in the Case metrics settings dialog box on the Portal Management > Organizations page, a banner that indicates that the daily metrics are being saved for organizations will now appear at the top of the page while the scheduled jobs are being saved for cases in the organizations, as shown in the following figure. The banner will be removed after all jobs are saved.

Case metrics settings dialog box banner message

Important: You can continue working while the jobs are being saved, but do not log out of Nuix Discover until you see that the banner is removed.

The time that it takes for the jobs to finish saving depends on the size of your environment.

SaaS / Hosted Monthly Release Notes - September 2020 (10.4.005 - 10.4.008)

Tools menu: Introducing the redesigned Tools menu

This release includes a redesigned Tools menu that provides an enhanced user experience when working with various tools. The menu was redesigned based on user feedback. The tools are organized into logical groupings. The names of the tools have not changed.

All tools: Allows you to access the entire list of tools, as shown in the following figure. The tools in each section mirror the logical groupings.

Tools menu

Frequently used tools

Frequently used tools such as Report and Batch Print are now at the top of the menu, as shown in the following figure.

Tools menu Frequently used options

Find tools quickly

The search box at the top of the menu, shown in the following figure, allows you to find tools without having to scroll through the list.

Find search box

Logical groupings

The tools are organized into the following logical groups that you can access by clicking the buttons in the navigation pane on the menu:

  • Output
  • General
  • Results
  • Processing

Output: The tools in this grouping include Report, Batch print, Export, and Archive files, as shown in the following figure.

Tools menu Output option

General: The tools in this grouping include History, Load search file, Workflow, Quick code, Add document, Coding history report, Document count, and Theme, as shown in the following figure.

Tools menu General option

Results: The tools in this grouping include Base docs\Renditions, Find masters family, Find family duplicates, Find individual duplicates, Remove family duplicates, and Remove individual duplicates, as shown in the following figure.

Tools menu Results option

Processing: The tools in this grouping include Imaging, Reverse previous imaging, OCR processing, Extract text, Transcribe audio, Indexing and enrichment, Thread analysis, Convert page annotations, and Translate, as shown in the following figure.

Tools menu Processing option

Tools menu: Access to Transcribe audio and Translate options

Users can now use the Transcribe audio and Translate options on the Tools menu even if they do not have access to private binders.

Introducing the Hierarchies feature

This release includes a new feature that allows you to view Hierarchies in the Browse pane, for example, to view the folder hierarchy of a file path for a custodian.

An example is shown in the following figure.

Note: Your administrator must configure and grant you access to hierarchies.

Browse pane Hierarchies

Tip: You can also search for a Hierarchy on the Search page.

Introducing the Names Normalization feature

The names normalization feature allows administrators to link the various people names (email addresses and names) for an individual person to an identity. This is especially helpful, for example, when creating a privilege log because the normalized identity name can be used instead of the non-normalized people names.

For example, if John Doe is associated with the following people names in Nuix Discover, an administrator can consolidate these email addresses and names into a single identity on the Case Setup > People Identity page.

  • john.j.doe@gmail.com
  • john.doe@gmail.com
  • jdoe@aol.com

After your administrator creates identities, you can work with the identities in the following ways on the Search page, in the List pane, and in the Communication Network pane.

Note: To use identities on the Search page and in the List pane, the user’s group must have permissions set to Allow for People\Organizations on the Security > Objects > Document Fields page. To access the Communication Network pane, the user’s group must have permissions set to strong for the Communication network feature on the Security > Features page.

  • Search for documents using identities on the Search page.
    • If an administrator has created identities, you can search for documents based on their connection to those identities using the following fields on the Search page:
      • Identity
      • Identity - BCC
      • Identity - CC
      • Identity - From
      • Identity - To
  • Add identity fields to the List pane column templates.
    • You can add the following identity columns to the List pane when documents are in the search results:
      • Identity
      • Identity - BCC
      • Identity - CC
      • Identity - From
      • Identity – To

      Tip: Adding these columns and using the Download feature in the List pane allows you to quickly generate a privilege log or other report showing the normalized names associated with documents.

  • Use identities to view normalized names in the Communication Network pane.
    • In the Communication Network pane, in addition to viewing communications for non-normalized person names, you can now also view information based on the normalized Identity names. To view the communications for an Identity, for example, for William S. Bradford, on the toolbar in the Communication Network pane, select Identity from the list, as shown in the following figure.
    • Communication Network pane Identity selection

Conditional Coding: Add a binder

In the Conditional Coding pane, group leaders with permissions to work with binders can now add a binder and apply security to that binder.

Use the following procedure to add a shared binder.

  1. In the Conditional Coding pane, in the list on the toolbar, select the Binders template.
  2. On the toolbar, click the Add binder button, as shown in the following figure.
  3. Conditional Coding pane Add binder button
  4. In the Add binders dialog box, as shown in the following figure, on the Properties page, provide a name and an optional description.
  5. Add binders dialog box
  6. Under Type, leave the Shared binder type option selected.
  7. Optionally, under Use as, set the binder to be used as a Security override or Mobile binder.
  8. Click Next.
  9. On the Security page, set the user group security for the shared binder.
  10. Click Save.
  11. The binder appears in the Conditional Coding pane.

Use the following procedure to add a private binder.

  1. In the Conditional Coding pane, in the list on the toolbar, select Binders.
  2. On the toolbar, click the Add binder button.
  3. In the Add binder dialog box, on the Properties page, provide a name and an optional description.
  4. Under Type, select Private.
  5. The Owner list appears, as shown in the following figure.

    Add binders dialog box Owner list
  6. In the Owner list, select an owner.
  7. Click Save.
  8. The binder appears as a private binder in the Conditional Coding pane.

Note: If you are a group leader with permissions and need to delete a binder, you can do that on the Case Setup > Binders page, but not in the Conditional Coding pane.

Analysis > Search Terms: Term query column added

The Analysis > Search Terms page now includes a new column named Term query, as shown in the following figure. This column contains the term query value or values for a Search Term Family.

You can use the information in the Term query column to effectively determine how to modify the search to increase or decrease the number of hits.

Analysis page Term query column

Case Setup: Introducing the Hierarchies feature

This release includes a new feature on the Case Setup > Hierarchies page that you can use to set up hierarchies, for example, to browse the folder hierarchy of a file path for a custodian.

Once you have set up hierarchies and granted access to user groups, users can view the hierarchies in the Browse pane.

Note: Administrators can grant group leaders access to this feature by setting the Case Setup - Hierarchies to Allow for Leaders on the Security > Administration page.

Use the following procedure to add a hierarchy.

  1. On the Case Setup > Hierarchies page, on the toolbar, click Add.
  2. In the Add hierarchy window, shown in the following figure, on the Properties page, do the following:
    • Provide a Name.
    • Select a Field, for example, All File Paths.
    • Select a Delimiter.
    • Click Next.
    Add hierarchy > Properties page
  3. On the Security page, shown in the following figure, set the security for groups, and then click Save.
  4. Add hierarchy > Security page

    The hierarchy appears on the Hierarchies page, as shown in the following figure.

After you create a hierarchy, you must run an indexing and enrichment job to populate and update the hierarchy.

Note: As documents are added to the case and submitted or resubmitted for indexing and enrichment, the hierarchies are updated as part of those jobs.

Use the following procedure to run an indexing and enrichment job for a hierarchy.

  1. On the Case Setup > Hierarchies page, select the check box next to a hierarchy, as shown in the following figure.
  2. On the toolbar, click Run.
  3. Case Setup > Hierarchies page

Use the following procedure to delete a hierarchy.

  1. On the Case Setup > Hierarchies page, select the check box next to a hierarchy, as shown in the previous figure.
  2. On the toolbar, click Delete.

Security > Administration: Enable the People Identity feature for group leaders

If you want group leaders to use the People Identity feature, you must enable it for them.

Use the following procedure to enable the People Identity feature for group leaders.

  1. Go to the Security > Administration page.
  2. In the Leaders column, click the Allow button next to Case Setup - People Identity, as shown in the following figure.
  3. Click Save.
  4. Security > Administration page

Case Setup: Introducing the Names Normalization feature

You can now use the Normalize feature on the Case Setup > People Identity page to normalize new non-normalized people names in a case. You can also use the Assign identity feature to change the connections between people and identities.

Using this feature, you can:

  • Run the Normalize job to create identities and link non-normalized people names
  • Assign (or reassign) people to an identity
  • Edit the identity name and description
  • Delete identities
  • View the identities and people for a specific document set
  • Download an identity report

You can find the Names Normalization feature on the Case Setup > People Identity page.

Note: Case administrators have access to this feature by default. If you want group leaders to have access to this feature, you must enable it first. See the Security > Administration: Enable the People Identity feature for group leaders section for more information.

Normalize people names

Use the following procedure to normalize names.

  1. Go to the Case Setup > People Identity page.
  2. If there are non-normalized names, a banner appears at the top of the page telling you that new people have been added and to click Normalize to normalize the people names to an identity. The following figure shows the data before it is normalized. Click the Normalize button.

    Case Setup > People Identity page
  3. In the Normalize dialog box, the following message appears, as shown in the following figure: The normalize job will link non-normalized people to an identity. People that are already linked to an identity will not be affected. To confirm, click OK.
  4. Normalize dialog box
  5. The application will run a Normalization RPF job to analyze the people name data and logically group the people under a unique identity. The banner at the top of the page lets you know that the normalization job is running, as shown in the following figure.
  6. Note: The job only operates on non-normalized people names. People that were linked to an identity before running the job are not affected.

    Case Setup page with Normalization job processing message
  7. Refresh the page to see the updated results. The banner at the top of the page lets you know that the normalization job is complete and that all people are linked to an identity, as shown in the following figure.
  8. Note: In the tree view in the Name column, the identities are the parent rows (shown in bold font) and the people are the child rows (in non-bold font).

    Case Setup page Name column

Working with the table on the People Identity page, you can:

  • Filter by the Name column to return specific people and their linked identities.
  • Note: When filtering by the Name column, the text you enter will match on people names (in child rows), and the filtered results will include the identities (parent rows) for those people that match your filter as well as all other people that are linked to those identities.

  • Sort the columns in ascending or descending order.
  • Note: No matter how you sort the columns, if there are non-normalized people names, they will always appear under the Non-normalized section at the bottom of the last page.

  • Click the plus and minus sign to collapse and expand the people beneath each identity.
  • Click a number link in the Total, From, To, CC, or BCC columns to view the documents that are associated with a person or identity.
  • Note: The counts in the Total column and identity rows reflect the number of occurrences that the identity or person name appears in documents. The counts do not represent the actual number of documents. For example, if Jane Smith sends an email and copies (CCs) herself, her name will appear in the same document two times (From and CC), so the Total column will show a count of 2 but the link will only return one document on the Documents page.

Assign an identity

The Assign identity feature allows you to change the identity that is assigned to people. You can reassign people to an existing identity or create a new one.

Use the following procedure to assign an identity.

  1. Select the check box next to a person, and then click Assign identity.
  2. Note: You can assign an identity to multiple people at one time by selecting more than one person and then clicking Assign identity.

    The Assign identity dialog appears, as shown in the following figure.

  3. Under Assign identify, select one of the following options:
    • Select an existing identity: Select an existing identity from the list.
    • Add new identity name: Select this option and enter a name in the box.
    Assign Identity dialog box
  4. Click OK.
  5. The person (or people) are then listed under the identity.

Edit identity name and description

You can edit the identity name or the identity description.

Note: The system Data Model now includes a new entity named Identity, shown in the following figure. The Identity entity was created to support the Names Normalization feature. The Identity entity has a one-to-many connection to the Person entity.

System > Entities page

For the Identity name and Identity description to be editable on the Case Setup > People Identity page, the user’s group must have Write access to these fields.

Use the following procedure to set make the identity name or identity description fields editable.

  1. Go to the Case Setup > Data Models > System > Entities > Identity > Fields page.
  2. On the Fields page, click the link for the Identity Description or Identity Name, as shown in the following figure.
  3. Identity > Fields page
  4. In the navigation pane, click Security.
  5. Set the security to Write for a user group, as shown in the following figure.
  6. Identity Name > Security page

Tip: On the Case Setup > Data Models > System > Entities > Identity > Fields page, click the Add button to add new fields to use for coding identities. Set the appropriate group permissions for your new fields on the field’s Security page. You can use your new fields in Column Templates or Conditional Templates for the Identity entity. You must enable the Conditional Template.

Use the following procedure to edit the identity name.

  1. Click on the Identity name or Identity description. An editable field appears, as shown in the following figure.
  2. Identity name or Identity description editable field
  3. Type the new identity name or description.
  4. To save your changes, click outside the field.

Delete identities

You can delete an identity that does not have any people assigned to it.

Use the following procedure to delete an identity.

  1. Hover over the row of the identity you want to delete and click the Delete identity button, as shown in the following figure.
  2. Delete identity button
  3. A message appears, confirming that the identity has been deleted.
  4. Note: You cannot delete an identity that has people assigned to it or delete the individual people.

View the identities and people for a document set

Select a Document set to view the identities and people that are associated with those documents.

Use the following procedure to view the identities and people for a specific document set.

  1. In the Document set list, select the type of document set you want to use, and then select the document set in the field that appears to the right.
  2. The page will refresh when the document set is changed, and the displayed identities will be filtered to only those that have people connected to documents in the selected set.

Note: All people are displayed for identities that have at least one person connected to documents in the selected set, even if some people in those identities are connected to 0 documents. The counts in the columns reflect the number of occurrences within the selected set. Your selected document set will be selected by default the next time you return to the People Identity page.

The Normalize job always operates on all documents in the case, regardless of which document set is selected on the page.

Download an identity report

You can download an identity report to a .csv file.

Use the following procedure to download an identity report.

  1. Click the Download report button. Nuix Discover saves the identity information to a .csv file under your Downloads folder.
  2. Note: The Download report feature will respect the document set that is selected. The report file name has a time stamp with the local time so that each time you download a new report with a new time stamp the report will be saved and will not overwrite a previous report.

  3. To view the report, open the .csv file in Microsoft Excel.

Manage Document > Ingestions: NIST list updated - June 2020

The Ingestions feature now uses an updated version of this list, released in June 2020. For more information, go to https://www.nist.gov/itl/ssd/software-quality-group/national-software-reference-library-nsrl/nsrl-download/current-rds

Security > Features: Allow group leaders to add binders in the Conditional Coding pane

To allow group leaders to add binders in the Conditional Coding pane, you must set the Case Setup - Binders and Case Setup - Properties features to Allow on the Security > Features page.

Security > Features: Set security for the Documents Added section on the Case Home page

You can set security for the Documents Added section on the Case Home page. You can choose to display or hide the Documents Added section by enabling or disabling the Case Home - Documents added feature for groups on the Security > Features page, as shown in the following figure.

Note: This feature is set to Deny by default for all newly added groups. When a group is cloned, access to the Documents Added feature is carried over from the group it was cloned from.

Security > Features page

When this feature is set to Deny for a group, the users in that group do not see the Documents Added section on the Case Home page, and the Results History section appears in that location, as shown in the following figure.

Case Site Map page Results History section

When this feature is set to Allow for a group, the users in that group see the Documents Added section on the Case Home page, as shown in the following figure.

Case Site Map page Documents Added section

Cases and Servers: Database and Analysis servers prepopulated for Organizations when adding or cloning a case

When you add a new case, the Database and Analysis servers for that Organization are prepopulated on the Servers page in the Add case window, as shown in the following figure.

Add case > Servers page

When you clone a case, the Database and Analysis servers for that Organization are prepopulated on the Servers page in the Clone case window, as shown in the following figure.

Clone case window showing pre-populated fields

Cases and Servers: Clone a case from one Organization to another Organization

When you clone a case, you can now select a different Organization than the Organization that is currently associated with the case that you are cloning, as shown in the following figure.

Clone case > Case Details page

Cases and Servers > Clone Case: Audit for coding history is enabled by default for new cases

If the coding history audit feature is enabled for a portal, when you clone a case and leave the Clear data option unselected, as shown in the following figure, auditing is now automatically enabled.

The benefit of this is that you do not have to request for the coding history audit feature to be enabled by a system administrator after you create a case.

Clone case > Case Details page showing Clear data field

After you clone a case, a new elastic index is created for the new case, and audit is enabled for coding history.

User Administration > Account Settings: Increase the password history maximum setting to 24

On the Portal Home > User Administration > Account Settings page, in the Password History box, administrators can enter the number of times users must create a unique password before it can be reused. In previous versions, administrators could select 1-20 unique password entries. Now, administrators can select 1-24.

Cases and Servers: Enable Linux\Docker Ingestions option relocated to the portal level

The Enable Linux\Docker Ingestions option has been removed from Case Options and relocated to Portal Options. On the Portal Home > Settings > Portal Options page, if you select the Enable Linux\Docker Ingestions check box, all cases in the portal will use this setting.

Note: Cases that were configured in previous versions will respect the prior setting. To change the case setting for an existing case, you must use a SQL query.

Connect API Explorer: OneGraph GraphiQL Explorer API query builder

The Connect API Explorer now contains the OneGraph GraphiQL Explorer plug-in. This plug-in is a query builder that assists users, both new and advanced, in quickly and easily generating queries and mutations with a graphical representation of the data fields and objects and helps avoid the frustration of incorrect syntax.

The Connect API Explorer window now contains four panes, as shown in the following figure, and described in the following table.

Connect API Explorer window now showing four panes
  • 1  Explorer pane: New query builder for automated assistance in constructing queries and mutations.
  • Note: To close the Explorer pane, click the X button. To reopen this pane, click the Show explorer button in the Editor pane.

  • 2  Editor pane: Area for constructing, formatting, and running queries and mutations.
  • 3  Results pane: Contains query and mutation results.
  • 4  Documentation Explorer pane: Documentation details for all query and mutation endpoints and their associated arguments and fields.

Each time you enter the Connect API Explorer, the Explorer pane will begin with a default query under the Me argument related to data associated with you, the user.

Use the following procedure to manipulate any query or mutation.

Note: This example creates a basic query filtering on all active cases and sorts them by case name in ascending order.

  1. To create a new query or mutation, in the Add New field, at the bottom of the Explorer pane, select Query or Mutation from the list, and then click the + sign, as shown in the following figure.
  2. Explorer pane Add New button

    The new blank query or mutation will appear in the Explorer and Editor panes with a default name.

  3. To copy an existing query or mutation, to the right of the Name field, hover over and click the Copy button, as shown in the following figure.
  4. Explorer pane Copy button

    A duplicate copy will appear under the existing queries and mutations in the Explorer and Editor panes.

    Note: You can manipulate multiple queries and mutations simultaneously.

  5. Enter a unique Name.
  6. The change appears in the Explorer and Editor panes.

    Note: It is best to give your query or mutation a unique name to help identify their function.

  7. In the Explorer pane, expand the cases list by clicking the expand arrow, as shown in the following figure.
  8. Explorer pane showing expanded field option

    The cases argument is added to the Editor pane with the proper syntax.

    Note: Filter fields appear in purple and are used for filtering the returned data by a specified value you enter. Fields that appear in blue are used for returning any data value within that field.

    Important: If you close an expanded list in the Explorer pane, and already have several fields and filters selected, closing the list will delete the selections from the query or mutation. However, those selections are cached, and by expanding the list again, the selected fields and filter data will reappear.

  9. Select the check boxes for the id and name fields shown in blue text, shown in the following figure in step 7.
  10. The fields appear in the Editor pane in the proper location and surrounded by the correct syntax.

    Note: If you manually enter these fields in the Editor pane, the check boxes are automatically selected in the Explorer pane.

  11. Select the check box for the active field shown in purple text, shown in the following figure in step 7, and then select true.
  12. Note: When filtering with multiple values, such as multiple IDs, the builder does not support arrays. You must enter the multiple filtering values manually in the Editor pane.

  13. Expand the sort field shown in purple text, and then do the following.
    • Select the check box for the dir field, and then select Asc.
    • Select the check box for the field* field, and then select name.
    • Important: The asterisk (*) following a field name indicates a required field. If selected, this field must contain a data value to filter on.

    The query now contains all of the selected fields and filter options, as shown in the following figure.

    Explorer and Editor panes showing example query
  14. To delete the query or mutation and start over, hover over the name in the Explorer pane, and then click the X button, as shown in the following figure.
  15. Explorer panes Delete button

    The query or mutation is deleted from both the Explorer and Editor panes.

  16. To run a query or mutation, in the Editor pane, click the Execute query button.
  17. Note: If you have multiple queries and mutations, a list will appear where you can select one for execution. However, all queries and mutations must be valid to run that selection successfully.

    The results will appear in the Results pane.

SaaS / Hosted Monthly Release Notes - August 2020 (10.4.001 - 10.4.004)

List pane: Download a report to an .xlsx format and add a report title

In the List pane, you can now download a report to an .xslx format and give the report a title, as shown in the following figure. Previously, you could download the report only to a .csv format.

Download dialog box

Enhancements to Workspace panes

This release includes the following enhancements to all workspace panes, as shown in the following figure:

Change-Maximize-Close pane enhancements

Change a pane

To change a pane, on the pane menu, select a different pane from the list, as shown in the following figure.

Note: Changing a pane changes your current workspace configuration.

Change pane enhancement

If you select a pane that is already included in your current workspace configuration, the current pane is exchanged with the pane you selected.

For example, if your workspace configuration includes a Browse pane, a List pane, and a Conditional Coding pane, if you change the List pane to a Conditional Coding pane, the List pane appears where the Conditional Coding pane used to be, as shown in the following figures.

Before

Change pane before example

After

Change pane after example

Maximize a pane

All workspace panes now include a new option to maximize the pane, as shown in the following figure.

Maximize pane selection

When you select the Maximize option, the application maximizes the pane and hides all of the other panes in the workspace configuration.

To restore the hidden panes, click the Restore all hidden panes button on the toolbar of the pane, as shown in the following figure.

Maximize pane button

Close a pane

All workspace panes now include a new option to close the pane, as shown in the following figure.

Note: Closing a pane changes your current workspace configuration.

Close pane selection

When you select the Close option, the application removes the pane from the current workspace as well as from the pre-set workspace configurations.

To add the pane that you closed back to a workspace, on the workspaces menu, shown in the following figure, edit the workspace.

Return a closed pane example

Tools > Imaging: Auto-detect color and render to JPG option added to Imaging > Properties window

When submitting documents for imaging, you can now select an option to automatically detect color and render to JPG. The Auto-detect color and render to JPG check box is located in the Imaging window on the Properties page, as shown in the following figure.

Note: This option is available only if the TIFF option is selected from the Image type list.

The default value for the option is based on the Imaging settings found in Manage Documents > Imaging - Automated > Settings.

Imaging Properties page

Case Setup > Binders: New workflow to add a binder

On the Case Setup > Binders page, the workflow to add a binder has been streamlined. When you add a binder, you can now set the properties and the security in a wizard-like fashion. Previously, you had to add a new binder, and then access the new binder to set the security.

Note: If you need to edit an existing binder or a newly created binder, you must do that on the Case Setup > Binders > Properties and Security pages for a binder.

Use the following procedure to add a new binder and set the security for the binder.

  1. On the Case Setup > Binders page, on the toolbar, click Add.
  2. In the Add binders window, on the Properties page, set the properties for the binder, and then click Next, as shown in the following figure.
  3. Add binders Properties page
  4. On the Security page, set the security for the binder, and then click Save, as shown in the following figure.
  5. Add binders Security page

    The new binder appears on the Case Setup > Binders page.

Manage Documents > Imaging - Automated: Update default brightness setting to 15

In previous versions, when a file contained text with a background that was similar in color, converting the file to a black and white image could result in text and background that were the same color. We have updated the brightness setting to increase the likelihood that the text and background will be distinguishable in the resulting images.

In the Manage Documents > Imaging - Automated > Settings window, on the PDF page, the default brightness setting for new cases is now 15, as shown in the following figure. For existing cases, if the setting was previously 85, the value has been changed to 15. If the setting was previously anything other than 85, the value has not been changed.

Settings PDF page

Manage Documents > Ingestions: Upgrade to the Nuix Engine 8.4.7

Ingestions now uses the Nuix Workstation 8.4.7 processing engine.

SaaS / Hosted Monthly Release Notes - July 2020 (10.3.009 - 10.4.000)

Coding History Search: New operator to search for previously coded values

A new operator named previous value ever was is now available for advanced searches on the Search page, as shown in the following figure.

Search page showing new operator

Note: The previous value ever was operator is available to users who are in a group with permissions to access the Coding History pane.

The following field types support coding history searches using the previous value ever was operator:

Note: Memo field types are not supported.

  • Pick list
  • Date
  • Number
  • Yes\no
  • Text
  • Binder - Shared
  • Issue
  • Production
  • Population
  • Sample
  • Highlight
  • Redaction
  • People - correspondence type
  • Organizations - correspondence type

When using this operator, you can search for previously coded values, which are the values captured by the Coding History feature and found in the Previous value column in the Coding History pane, as shown in the following figure.

Coding History pane showing Previous value column

Use the following procedure to search for previously coded values.

  1. Navigate to the Search page.
  2. In the Select a field box, select the field for your search criteria.
  3. In the Select an operator box, select previous value ever was.
  4. In the Select a value box, select or enter the value.
  5. Note: Not all values for your selected field may be available in the Select a value list. Values are not available for previous value ever was searches until they have been stored in coding history (for at least one audit record).

    When searching for a text field value using the previous value ever was operator, the text field value must be an exact match.

  6. Optionally, to include Coded by or coded on date parameters in your search criteria, click the Add additional criteria button.
  7. Note: Coded by and coded on date parameters will be evaluated against the user and date corresponding to the original coding action for the value.

  8. To run the search, click the Search button.

Coding history report on the Tools menu

The Tools menu on the Documents page now includes a Coding history report option that allows you to download a .csv report with the history for a field for all documents selected in the List pane.

Note: To see this option, your administrator must grant you access to the Coding - Coding History feature on the Security>Features page.

Use the following procedure to generate a coding history report.

  1. In the List pane, select one or more documents.
  2. On the Tools menu, select the Coding history report option.
  3. In the Download coding history report dialog box, shown in the following figure, from the Field list, select a field, and then click OK.
  4. Note: The available fields depend on the permissions granted by your administrator.

    Download coding history report dialog box

    A processing window appears, as shown in the following figure.

    Note: Do not close this window or exit the case until the report downloads.

    Downloading coding history report completion message
  5. After the .csv report downloads, open or save the file.

Updates to the Renumbering feature

The following updates have been made to the Renumbering feature, which is available on the Tools menu:

  • When endorsing headers, more space is now provided between the endorsement and the edge of the page. This reduces the potential for the endorsement to be cut off when printing documents to paper.
  • The following updates have been made to the Document ID page in the Renumbering window, as shown in the following figure:
    • Suffix delimiter: This character is used before the page number during endorsement. The default character is a hyphen.
    • Override validation: If you select this option, the application assigns Document ID values starting with the selected value, even if there is an existing Document ID with a higher number.
    • Note: This option is not selected by default. Selecting this option could result in a job failure if a Document ID already exists. Selecting this option could also cause the application to assign page numbers that already exist on other documents. If you select this option, the application does not validate whether there is a Document ID in the expected range for the settings.

      Renumbering - Document ID page
  • On the Endorsement page in the Renumbering window, if you select the Document ID plus page number endorsement option, as shown in the following figure, the Start numbering on page 2 check box appears. If you select this check box, the first page of a document includes only the Document ID, but not the page number. The page numbering starts on the second page of the document.
  • Renumbering - Endorsement page

Manage Documents>Exports: Ability to apply headers

Administrators now have the option to apply headers to base images in Custom and MDB Classic export types. In previous releases, only footer settings were available.

You can access header options on the Headers\footers page in the Export window, as shown in the following figure. The options available for footer values are also available for header values. You can select any combination of headers and footers.

Headers\footers page in the Export window

Note: The width, height, and font size are the same for both headers and footers. As with footers, the Header height setting allows you to add space to the top of the image when endorsing headers such that the header text does not overlap with image text.

Manage Documents>Productions: New productions numbering options

The Attributes page of the Productions feature now includes new options for setting the numbering convention for production documents and files, as shown in the following figure.

Attributes page of the Productions feature

The following options are available under Numbering on the Attributes page of a production:

  • Standard: This option offers a new, simplified way to set the Production Document Label and Production Page Label. You can enter information directly into the Prefix, Start number, and Padding boxes. Under Number by, select either Page or Document. If you choose to number by document, you can enter a value for page numbering padding and choose a delimiter to use between the document and page number, if required.
  • The following list provides examples of page and document numbering.

    • Doc 1 - page 1
      Number by page: ABC-00000001
      Number by document: ABC-00000001-00001
    • Doc 1 - page 2
      Number by page: ABC-00000002
      Number by document: ABC-00000001-00002
    • Doc 2 - page 1
      Number by page: ABC-00000003
      Number by document: ABC-00000002-00001
    • Doc 2 - page 2
      Number by page: ABC-00000004
      Number by document: ABC-00000002-00002
    • Doc 2 - page 3
      Number by page: ABC-00000005
      Number by document: ABC-00000002-00003
    • Doc 3 - page 1
      Number by page: ABC-00000006
      Number by document: ABC-00000003-00001
  • Custom: This option is the same as in previous versions. It allows administrators to enhance customization by using the variable builder to define values.
  • For productions that were locked or were created but not locked prior to this update, the selections you made for Production Document Label and Production Page Label appear in the Custom numbering section of the Attributes page.

Note: The Production Document Label determines the Rendition Document ID as well as the names of any native and content files. The Production Page Label determines the name of image files. The Production Page Label is also referred to as the Bates number. To set the Bates number as a footer, you must select the Production Page Label option, regardless of how you set up numbering on the Attributes page. Load file template field references to begin and end Bates and any other numbering values will not change.

Manage Documents>Updates to the Renumbering feature

The following updates have been made to the Renumbering feature:

  • The Suffix delimiter that you set on the Document ID page in the Renumbering window appears on the Manage Documents>Renumbering>Properties page in the Settings>Document ID section.
  • On the Endorsement page in the Renumbering window, if you selected the Document ID plus page number endorsement option and selected the Start numbering on page 2 check box, the setting appears on the Manage Documents>Renumbering>Properties page, in the Settings>Endorsements section.

Introducing the case archiving feature

Case archiving allows you to archive an entire case. Case archiving is available to system and portal administrators. You may want to archive a case if you no longer need the database to be readily available in Nuix Discover, but you want the option of restoring it in the future should the need arise.

When you archive a case, it is stored in a folder on the archive repository that is assigned to the case. The folder will include backup files of all three of the case databases, zip archives containing all files from the repositories assigned to the case, and a backup of the coding history index (if the case has audit enabled for coding history). After you archive a case, you can download the case files, recommission the case, or permanently delete the case.

Note: Portal and system administrators can do everything described in this section.

Archive a case

You can archive an entire case using the Decommission option, which is available on the More menu on the Cases page.

Use the following procedure to decommission and archive a case.

  1. On the Cases page, select the case you wish to archive.
  2. On the More menu, select Decommission, as shown in the following figure.
  3. Decommission option on the More menu

    The Decommission case window appears, as shown in the following figure.

  4. The Decommission case dialog box has been changed to a wizard-style window with two pages: Options and Summary. The Options page now includes a choice for Archive (selected by default) or Permanently delete, which was previously the only option available when decommissioning a case. Select Archive, and then click Next.
  5. Options page on the Decommission case dialog box
  6. The Summary page, shown in the following figure, displays the destination folder where the archived case will be stored, the total size of the case to be archived (as captured by the latest case metrics job), and a listing of the database and analysis servers, Elasticsearch index name, and the repositories that are assigned to the case. To archive the case, click OK.
  7. Summary page on the Decommission case dialog box

    Note: If files were archived while the case was live, the folders containing those file archives will remain adjacent to the new folder that is created for the case archive. The previously archived files will not be “re-archived” to the case archive destination folder.

    If the case does not have an archive repository currently assigned, the Destination field shown in the following figure will display a list of the available archive repositories. Select an archive repository to assign as the destination for the archived case.

    Summary page on the Decommission case dialog box showing Destination options

    Note: When organizations security is enabled for the portal, the archive repository that is assigned to the case must also be assigned to the case’s organization to allow for the case to be archived.

  8. After you click OK, a Case Decommission job will run in RPF and will archive the case. The worker processing window will open and display the progress of the job stages, as shown in the following figure.
  9. Note: You do not need to keep the worker processing window open while the job is running. You can also monitor the job progress in the Progress column for the case row on the Cases and Servers>Cases page, or by viewing the job on the Processing>Jobs page.

    Case Decommission processing progress dialog box

    Note: When the job begins, the case will be taken offline and users will no longer be able to access the case. Any scheduled RPF jobs for the case will be removed.

  10. If the job fails at any point, the case will appear with a Failed status on the Cases and Servers>Cases page. You can use the Resubmit option to attempt to resume the job. This will restart the job on the stage where it left off. To resubmit the case for decommission, select the case, and on the More menu, click Resubmit, as shown in the following figure.
  11. Cases and Servers - Cases page - Resubmit option

After a case is successfully archived, it will appear on the Cases page with an Archived status, as shown in the following figure.

Cases and Servers - Cases page showing Archived status

About archived case files

When you archive a case, Nuix Discover saves a variety of case files. An example of the types of files that are stored for an archived case is shown in the following figure.

The types of files for your archived case include:

  • .bak files for all three of the case SQL databases.
  • Zip archives containing all files from the repositories assigned to the case.
  • Note: Zip file names include the top-level folder name from the repository. An empty .zip file will be created to represent a folder that does not contain any files in the case subfolder. Files are batched into .zip archives that are approximately 2 GB in size. Depending on the total size of files contained in a repository folder, this could result in multiple .zip archives for a top-level folder. In that case, each .zip archive will be named uniquely with a numeric suffix.

  • A .zip archive containing the coding history Elasticsearch index.
  • .csv files that contain a file inventory of each top-level folder from each repository. These inventory files are used for the validation stages of the decommission and recommission jobs.
  • File Manager window showing .csv files within the archive

When you archive a case, you also have three new options on the More menu.

The following options are available for an archived case on the More menu on the Cases page, as shown in the following figure:

  • Download files: This will download a copy of all files for the archived case.
  • Recommission case: This will restore the case and all files back to their original locations.
  • Delete: This will permanently delete the archived case with no backup.
  • Cases page More menu options

Download case files from an archived case

You can download case files from an archived case and save a copy of those files locally using the Download files option on the More menu on the Cases page.

Use the following procedure to download case files from an archived case.

  1. On the Cases page, select the archived case.
  2. On the More menu, select Download files, as shown in the following figure.
  3. Cases page More menu option selection of Download files

    The Download files dialog box appears, as shown in the following figure.

  4. In the Download files dialog box, you will see the total size of the files for the archived case that will be downloaded. Click OK.
  5. Download files dialog box

    The worker processing window appears, as shown in the following figure.

  6. The worker processing window displays the status for the files being downloaded. Keep this window open, as all files will be downloaded through this window.
  7. Note: Depending on your browser settings, you may be prompted to allow for multiple files to be downloaded.

    Download files progress dialog box

Delete an archived case

After you decommission and archive a case, you can delete it permanently using the Delete option on the More menu on the Cases page.

Use the following procedure to delete an archived case.

  1. On the Cases page, select the archived case.
  2. On the More menu, select Delete, as shown in the following figure.
  3. Cases page More menu option selection of Delete

    The Delete archived case dialog box appears, as shown in the following figure.

  4. In the Delete archived case dialog box, select the Delete this case and all associated files check box to enable the OK button, and then click OK to permanently delete the archived case with no backup.
  5. Delete archive case dialog box
  6. The Decommissioned Case Deletion job will run in RPF and will permanently delete the archived case. The worker processing window opens and displays the progress of the job stages, as shown in the following figure.
  7. Note: You do not have to keep the worker processing window open while the job is running. You can also monitor the job progress in the Progress column for the case row on the Cases and Servers>Cases page, or by viewing the job on the Processing>Jobs page.

    Decommissions Case Deletion job progress dialog box
  8. If the job fails at any point, the case will appear with a Failed status on the Cases and Servers>Cases page. You can use the Resubmit option to attempt to resume the job. This will restart the job on the stage where it left off. To resubmit a case to be deleted, select the case, and from the More menu, click Resubmit.

After an archived case is successfully deleted, it will be logged to the Cases and Servers>Deleted Cases page.

Recommission a case

You can recommission an archived case by using the Recommission case option on the More menu on the Cases page.

Use the following procedure to recommission an archived case.

  1. On the Cases page, select the archived case.
  2. On the More menu, select Recommission case, as shown in the following figure.
  3. Cases page More menu option selection of Recommission case

    The Recommission case dialog box appears, as shown in the following figure.

  4. The Recommission case dialog box displays the same repositories that were assigned to the case at the time it was archived. To recommission the case, click OK.
  5. Recommission case dialog box

    Note: The original servers and repositories that were assigned to the case at the time it was archived are selected by default. The selected Image, Index file, and File transfer repositories will be the destinations for restoring the files. The selected Archive repository is where the recommission job will look for the archived case files to be restored.

    Note: If an original repository is no longer available in the portal, a warning icon will appear next to that item, as shown in the following figure, and the field will display a list of the available repositories. Select a new repository to assign as the repository type to restore the files to.

    Recommission case dialog box Image field
  6. A Case Recommission job will run in RPF and will restore the case. The worker processing window will open and display the progress of the job stages, as shown in the following figure. You do not have to keep the worker processing window open while the job is running.
  7. Note: You can also monitor the job progress in the Progress column for the case row on the Cases and Servers>Cases page, or by viewing the job on the Processing>Jobs page.

    Recommission case job progress dialog box
  8. If the job fails at any point, the case will appear with a Failed status on the Cases and Servers>Cases page. You can use the Resubmit option to attempt to resume the job. This will restart the job on the stage where it left off. To resubmit a case to be recommissioned, select the case, and on the More menu, click Resubmit.

After a case is successfully recommissioned, it will appear on the Cases page with a Valid status, as shown in the following figure.

Cases and Servers - Cases page

Note: The recommission job will attempt to reassign the same users to the case who were assigned at the time the case was archived, assuming those users are still available in the portal.

Report on decommissioned cases

You can see archived cases on the Reports>Hosted Details page by using the Status column filter to show or hide cases with an Archived status, as shown in the following figure.

Reports - Hosted Details page

Note: Case metrics are refreshed at the end of the case decommission job so that after a case is successfully archived the total size of the archived case will be represented in the Archive data (GB) column on the Hosted Details page.

Portal Management>Settings: Portal Options: New setting to limit the size of an audio file in the View pane

A new option named View pane maximum audio file size is now available on the Portal Management>Settings>Portal Options page, as shown in the following figure. Use this option to set the maximum file size in bytes when streaming audio files in the View pane. This new option, which can be set to a maximum value of 31457280 bytes, addresses IIS performance issues for .wav files.

Portal Management - Settings - Portal Options page

Connect API Explorer: Identify archived cases using the decommissionStatus field

In the Connect API Explorer, the caseDecommissionStatusEnumType filter now includes the status Archived as a value by using the decommissionStatus field.

Sample query:

query {
  cases (decommissionStatus: Archived) {
    name
    caseDecommissionedBy
    caseDecommissionedDate
    decommissionStatus
  }
}

Sample query results:

{
  “data”: {
    “cases”: [
      {
        “name”: “Acme”,
        “caseDecommissionedBy”: “Doe, John”,
        “caseDecommissionedDate”: “2020-06-15T18:35:55.743Z”,
        “decommissionStatus”: “Archived”
      }
    ]
  }
}

Connect API Explorer: Search coding history values using the PreviousValueEverWas operator

The operator PreviousValueEverWas is now available in the API for searching on values in coding history.

Sample mutation:

mutation {
  searchRun (caseId: 2, input: {
    include: MatchingItems,
    renditions: false,
    singleQuery: {
      field: “Document ID”,
      operator: PreviousValueEverWas,
      value: “A”
    }
  }) {
    id
    label
    count
    dateRun
    entityId
    items {
      id
      itemId
    }
  }
}

Sample mutation results:

{
  “data”: {
    “searchRun”: {
      “id”: 742,
      “label”: “--/ “Document ID/” previous value ever was /“A/””,
      “count”: 0,
      “dateRun”: “2020-06-19T14:18:53.027Z”,
      “entityId”: 1,
      “items”: []
    }
  }
}

Login Service version 2.3.15 now includes an installer

This installer is intended for deployment on Windows servers. New versions of Nuix Discover will continue to be compatible with Login Service version 2.2.21, so you can upgrade at your convenience. The Login Service can be installed using the Nuix Discover Deployer version 2.5.94 and higher.

SaaS / Hosted Monthly Release Notes - June 2020 (10.3.005 - 10.3.008)

Analysis > Predictive Coding Templates: Select how date data is treated

We have added an option to Predictive Coding Templates that allows administrators to select how date type field data should be treated in the model.

To access the option, go to Analysis > Predictive Coding Templates and select a template. On the Fields page, click in the Date Value column, and then select a value for how date information should be treated in the template.

Predictive Coding Template - Fields page

The options are as follows:

  • Text: Date information is treated as a text string.
  • Day, month, and year: Date information is modeled without time. This option is the default.
  • Month: Date information is treated as a number with January = 1, February = 2, and so on.
  • Day: Date information is treated as a number.
  • Day of the week: Date information is treated as a number with Sunday = 1, Monday = 2, and so on.
  • Year: Date information is treated as a number.

Note: The application treats any date fields selected in templates created before this change as Text. If the template is used in any models, the date value cannot be changed. The choice of which Date Value option to use depends on the case data and what aspect of the date information has an impact on the model. For example, documents with dates clustered around the middle of January 2005 may be meaningful. Select the Day, month, and year value to model date information in that way. In a different example, which day of the week a date falls on (Monday, Tuesday, and so on) has some relevance. Use the Day of the week value to model date information in that way.

Manage Documents > Ingestions: Upgrade to the Nuix Engine 8.4.5

Ingestions now uses the Nuix Workstation 8.4.5 processing engine. The engine upgrade resolves the out-of-memory failures when processing some forensic images.

Manage Documents > Productions: Apply headers

Administrators now have the option to apply headers to production images. In previous releases, only footer settings were available.

You can access header options on the Endorsements page for a production. Click in any of the boxes for Left, Middle, or Right header to launch the variable builder.

Endorsements page

You can select any combination of headers and footers. Note that the width, height, and font size are the same for both headers and footers. As with footers, the Header height setting allows you to add space to the top of the image when endorsing headers such that the header text does not overlap with image text.

Manage Documents > Renumbering: Add option to number by document

When renumbering documents, administrators can now choose to increment page numbers by document or page. In the previous release, you could increment numbering by page only.

  • On the Document ID page, in the Format list, administrators can now select either Prefix, Box, Folder, Page - increment by page or Prefix, Box, Folder, Page - increment by document.
  • On the Endorsement page, for each header and footer option, administrators can now select Document ID plus page number.

Portal Management > Reports: New Max data (GB) column in Hosted Details report

The Hosted Details report includes a new column named Max data (GB), shown in the following figure.

This column displays the maximum active hosted data size for a case within a specified date range and captures the following data: sum value of base documents, production renditions, databases, the Elasticsearch index, the content index, and Predict data. This column also includes a calendar icon. Hover over the calendar icon to display the date of the maximum value.

Reports - Hosted Details page

If you download a report, it will now include the following two columns and values:

  • Max data (GB): The maximum active hosted data size for a case.
  • Max data (date): The date the maximum active hosted data size was captured.

Portal Management > Cases and Servers: Delete case record from the portal database for deleted cases

After a case is deleted, as a system administrator, you can delete the case record for the deleted case from the portal database. You can also then create a new case using the same case name.

Use the following procedure to delete the case record for a deleted case.

  1. On the Portal Management > Cases and Servers > Deleted Cases page, select the check box next to a case.
  2. On the toolbar, click Delete record.
  3. In the Delete record dialog box, shown in the following figure, select the Delete case record and all metrics check box.
  4. Note: Once you select this check box and click OK in the following step, the case record and all metrics are permanently deleted from the portal database.

  5. Click OK.
  6. Delete record dialog box

After you delete the record, the deleted case no longer appears on the Deleted Cases page or the Portal Management > Reports page.

Portal Management > Settings > Log Options: Multiple S3 bucket entries supported for the Telemetry archive configuration

The Telemetry archive configuration field on the Portal Management > Settings > Log Options page now has a new “S3Buckets” setting that supports multiple entries for the key, secret, region, and bucket values.

When telemetry is configured to store the logs in the database, and the configuration string includes multiple S3 buckets, the telemetry data is pushed to all S3 buckets.

The following example shows how to format the JSON configuration string with multiple S3 buckets.

{
“Checkpoint”: 0,
“CheckpointRPF”: 0,
“S3Buckets”: [
{ “Key”: “******”, “Secret”: “******”, “Region”: “us-east-1”, “Bucket”: “s3-bucket-1” }
,
{ “Key”: “******”, “Secret”: “******”, “Region”: “us-east-1”, “Bucket”: “s3-bucket-2” }
],
“CleanupMaxDays”: 3,
“ScheduleId”: 22,
“IntervalInMinutes”: 30,
“NRecentRecordsToReturn”: 10000
}

Connect API Explorer: maxActiveHostedSize and dateOfMaxActiveHostedSize case statistics

There are two new case statistics available through the Connect API Explorer that will return the maximum value of the aggregateActiveHostedSize and the date of that value within a specified date range.

Note: The aggregateActiveHostedSize statistic is the sum of sizeOfBaseDocumentsHostedDetails, sizeOfRenditionsHostedDetails, aggregateDatabases, sizeOfElasticSearchIndex, dtIndexSize, and sizeOfFolderData_Predict.

  • maxActiveHostedSize: Returns the maximum value of aggregateActiveHostedSize within a specified date range. This value calculates from the first minute of the startDate (12:00:00am) to the last minute of the endDate (11:59:59pm) in Coordinated Universal Time (UTC).
    • When only providing the endDate for the date range, the returned value is the highest value of the aggregateActiveHostedSize calculating from the beginning of the case to the last minute of the specified endDate.
    • When there is no startDate or endDate provided, the returned value is the highest of the aggregateActiveHostedSize over the entire life of the case, from the beginning of the case through the current day.
  • dateOfMaxActiveHostedSize: Returns the date of the maxActiveHostedSize within a specified date range.
    • When only providing the endDate for the date range, the returned value is the date of the maxActiveHostedSize calculating from the beginning of the case to the last minute of the specified endDate.
    • When there is no startDate or endDate provided, the returned value is the date of the maxActiveHostedSize over the entire life of the case, from the beginning of the case through the current day.

Sample query:

query {
  cases {
    name
    statistics(startDate: “2020-04-01”, endDate: “2020-04-30”) {
      maxActiveHostedSize
      dateOfMaxActiveHostedSize
    }
  }
}

SaaS / Hosted Monthly Release Notes - May 2020 (10.3.001 - 10.3.004)

Renumbering: Change the Document IDs and leveling of documents

You can now use the Renumbering tool in Nuix Discover to change the Document ID format of documents. Once you have specified a Document ID format, the application images the selected documents and converts them to a PDF format, then applies the specified numbering rules, relevels the documents to match the new Document IDs, applies endorsements to the PDF image, and replaces the PDF image with the endorsed version. You can view the endorsed PDF images in the Image viewer in Nuix Discover.

Renumber documents

You can renumber imported documents using the Renumbering option on the Tools menu, shown in the following figure.

Caution: Do not run multiple simultaneous Renumbering jobs with the same Document ID prefix in a case.

Select one or more documents to enable this tool.

Renumbering document selection list

On the Exclusions page, shown in the following figure, you can determine the following information:

  • Types of files to include and exclude in your renumbering.
  • If the native file should still appear in the Image viewer in Nuix Discover.
  • How the application will handle documents that fail to image to PDF.
Renumbering > Exclusions page

On the Slipsheets page, shown in the following figure, you can select which files to insert slipsheets for, and use the variable builder to determine what text appears on the slipsheets.

Renumbering > Slipsheets page

On the Document ID page, shown in the following figure, you can determine the following information:

  • The format for how the files will be renumbered. You can select a format that includes a prefix, box, folder, page, and delimiter, or you can select a format that includes only a prefix and padding.
  • If document families must stay together in a folder after renumbering.
  • If levels should be updated to correspond to the new numbering. This option is only available if you select the Prefix, Box, Folder, or Page format.
Renumbering Document ID page

On the Endorsement page, shown in the following figure, you can determine what information goes in the header and footer of renamed documents.

Renumbering Endorsement page

Translate: Propagate translated text to duplicate documents

When you submit a document for translation, the translated text is propagated across all duplicates of the document, so that you do not have to translate each duplicate document individually.

Note: Documents with branded redactions are not translated.

Also, the following applies to the translated duplicate documents:

  • The Translation Language system field is coded with the same target language as the translated document.
  • The Translation Status system field is coded with the same value as the translated document.

Renumbering: Enable the renumbering feature

On the Security > Features page, administrators can enable the renumbering feature using the Processing - Renumbering option.

Renumbering: Enable renumbering system fields

On the Case Setup > System Fields page, administrators can make renumbering-related system fields available to users. If the renumbering system fields are enabled, users can search for the fields and display the fields as columns in the List pane.

The following renumbering system fields are available:

  • Renumbering Status
  • Renumbering Previous Document ID
  • Renumbering ID

Renumbering: View renumbering job properties

On the Manage Documents > Renumbering page, administrators can view the properties and progress of renumbering jobs. Click a renumbering job in the list to view the properties or errors for the job.

Note: Administrators can allow Group Members and Group Leaders to access the Manage Documents > Renumbering page. On the Security > Administration page, in the Leaders or Members columns, set the Manage Documents – Renumbering Management function to Allow, and then click Save.

Exports: Option to include blank text files

For custom export types (base or renditions), a new option is available in the Export window to include a blank .txt file for all documents in the export that are missing a .txt file. For base documents, the option is available on the File types page in the Settings window (available when you click the Settings button, or gear).

Option for base document export:

Export window Endorseable Image files options

For rendition documents, the option is available on the File types page.

Option for document export:

Export (Renditions) File types page

If you select this option, along with the option to export content files, the application exports a blank .txt file for documents without an existing .txt file or associated extracted text. For base documents, the application names the .txt file according to the document ID. For rendition documents, the application names the .txt file according to the production document label for renditions. The blank .txt files are referenced in any load files that have a field for the text file name.

Note: When exporting base documents, if the application excludes any .txt files from an export because of annotations, a blank .txt file is not exported for those documents. The option to omit text files if a document is annotated is on the Annotations page in the Settings window (available when you click the Settings button, or gear).

To help administrators easily identify documents for which blank .txt files were exported, the following message appears on the Warnings page of the export job: “A blank content file (.txt) was exported because no content/.txt file was found for a document.”

Imaging: Add time zone setting for email file conversion

Administrators can now select a time zone for rendering native email files into images. The Time zone option is available in the Manage Documents > Imaging-Automated > Settings window on the Email and Website page. Administrators can select Use ingestions default or a specific time zone. If the administrator selects Use ingestions default, the application uses the time zone set in the default settings for Ingestions.

Imports: Prevent the creation of a new field with the same name as a system field

In the Import settings window, on the Field Map page, if a user creates a new field with the same name as an existing system field but of a different type, the application does not allow the user to continue. The field is outlined in red, and the following message appears: "New field cannot match an existing system field's name."

Processing > Index Status: Only document entities are included in the index status counts

On the Portal Management > Processing > Index Status page, shown in the following figure, only document entity items are included in the indexing counts in the Documents columns (Total, Indexed, Waiting, Excluded, Failed). Non-document entity items are not captured.

Portal Management > Processing > Index Status page

Organizations: Schedule daily case metrics jobs

System administrators can now schedule daily case metrics jobs for organizations and all cases in those organizations.

Note: This feature is not available to portal administrators.

Use the following procedure to schedule a daily case metrics job for an organization.

  1. On the Portal Management > Organizations page, on the toolbar, click the Case metrics button.

    The Case metrics settings dialog box appears.

  2. In the Case metrics settings dialog box, shown in the following figure, in the Time list, select a time.

    Note: The time appears in the user’s local time.

  3. Select one or more organizations.

    Note: To select all organizations, select the blue checkmark, shown in the following figure.

  4. Click Save.
    Case metrics settings dialog box

    The jobs are scheduled to run daily, at the time you selected. The newly scheduled jobs are added to all existing cases for the selected organization or organizations. For cases that are added to an organization after the job has been scheduled, the settings for the organization apply.

    Note: These settings do not override previously scheduled jobs.

Use the following procedure to cancel a daily case metrics job.

  1. Open the Case metrics settings dialog box.
  2. Clear the check box for the selected organization or organizations.
  3. Click Save.

After you schedule a daily case metrics job, in the table on the Portal Management > Organizations page, an icon in the second column indicates if a daily case metrics job is scheduled for an organization, as shown in the following figure.

Note: This column is visible only to system administrators.

Portal Management > Organizations page

Once the daily case metrics job is complete, the values in the following columns are updated on the Portal Management > Reports > Hosted Details page:

  • Base documents (GB)
  • Production renditions (GB)
  • Databases (GB)
  • Elasticsearch index (GB)
  • Content index (GB)
  • Predict (GB)

The values in the following columns are not updated as part of a daily case metrics job. Rather, the values in these columns reflect the values from the last Gather case metrics job that was run:

  • Orphan (GB)
  • File transfer data (GB)
  • Archive data (GB)
  • Missing (GB)

To update the values for these columns, you must run a full Gather case metrics job on the Portal Management > Processing > Jobs page.

Connect API Explorer: Assign users to case groups using the userGroupAssign mutation

The Connect API Explorer userGroupAssign mutation allows you to easily assign users to case groups for easy management of case access. This mutation allows you to perform multiple assignments simultaneously by pairing a single userId to a groupId, or multiple userIds to a groupId. Only the userId field allows this many-to-one assignment format. All other fields can only assign in a one-to-one format.

When assigning a user to a group and the user has an existing assignment to that group, the notChangedCount will increase by the appropriate number.

Required fields:

  • userId
  • caseId
  • groupId

Sample mutation:

mutation {
  userGroupAssign(input: [
    { userId: [7,9,10,11], groupId: 13, caseId: 8 },
    { userId: 8, groupId: 13, caseId: 4 }
  ]) {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Connect API Explorer: Update organization settings using the organizationUpdate mutation

The Connect API Explorer organizationUpdate mutation gives system and portal administrators the ability to update organization settings to help manage the organizations within the application.

Required fields:

  • organizationId: Integer, identifies the organization in the portal.

Optional fields:

  • name: String, organization name in the portal.
  • accountNumber: String, account number of the organization being modified.
  • caseId: Integer, identifies the default template case for the organization in the portal.

Sample mutation:

mutation {
  organizationUpdate(input: [
    {organizationId: 4, name: “ABC Corp“, accountNumber: 87597117},
    {organizationId: 6, name: “XYZ Corp“, caseId: 10}
  ])
    {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Connect API Explorer: Unassign users from case groups using the userGroupUnassign mutation

The Connect API Explorer userGroupUnassign mutation allows the ability to unassign a user from a case group to more thoroughly manage case access. Portal Administrators, who are assigned to a case, can unassign Portal Users and other Portal Administrators from the groups in that case.

Required fields:

  • userId: Integer, identifies the user in the portal.
  • caseId: Integer, identifies the case in the portal.
  • groupId: Integer, identifies the user group in the case.

Sample mutation:

mutation {
  userGroupUnassign(input: [
    {userId: [7,9,10,11], groupId: 13, caseId: 8},
    {userId: 8, groupId: 13, caseId: 4}
  ])
  {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

SaaS / Hosted Monthly Release Notes - April 2020 (10.2.009 - 10.3.000)

Introducing the Memo Editor pane

Nuix Discover now has a new Memo Editor pane, as shown in the following figure. This new pane is available for both documents and entities. It contains the existing Memo Editor formatting capabilities, as well as a new and quicker way of creating and removing links, and a new feature for downloading memos in Hypertext Markup Language (HTML) format.

Memo Editor pane

Note: The Memo Editor pane does not replace the existing editor capability within memo fields.

The following list provides an overview of the features available in the Memo Editor pane:

  • Memo field selection: To switch between the active memo fields, click the drop-down list on the toolbar and select a field. You can select the Comments, Timelines Description, [Meta] Chat HTML, and Document Description fields, as well as many others.

    Note: From the memo fields drop-down list, the Memo Editor pane allows you to access only the one-to-one memo fields.

  • Hyperlinks: Creating hyperlinks to documents, binders, transcripts, or other data takes fewer mouse clicks using the Memo Editor pane. Hyperlinking is also available for both documents and entities. In previous releases, you could not hyperlink to entities.
    • When you enter text to create a link and either double-click or highlight the text, an inline menu appears that contains the Document link, Object link, Transcript link, Web link and Remove link options, as shown in the following figure.
      Memo Editor inline menu

      After selecting a link option, a dialog box appears that allows you to search for and to select the link data.

      Note: The inline menu for linking replaces the Link toolbar button in the existing memo capability.

    • To view link contents, each link contains a tooltip that appears when you point to an existing link, as shown in the following figure.
      Link contents tooltip
    • Linked content opens when you hold down the Ctrl key on the keyboard and click the mouse.
    • To remove a link, double-click the link and select Remove link.

      Note: You cannot edit the text in existing links. You must first remove the link, then correct spelling errors or other mistakes made in the link text.

  • Auto-search linking: The Mentions feature allows you to do a quick search for document links.
    • When you type the hash (#) sign, followed by six or more characters of a Document ID, an inline list appears with matching search results, as shown in the following figure.
      Memo Editor inline list for entering document links

      Select an item from this list to automatically create a link to the selected document and insert the link into the memo.

      Tip: You cannot create a link back to an active document.

  • Downloading: The Download button allows you to export memos to HTML, as shown in the following figure.
    Memo Editor export sameple of the memo

    The top portion of the HTML file shows general information such as the case, user, date downloaded, and other information. Memo text follows.

    • If the memo contains links, you can view the link contents in the same manner as in the Memo Editor pane. However, because transcript links are embedded data and do not have an associated URL, they do not open from the downloaded HTML file. They open only from the Memo Editor pane.

      Note: If you have not previously logged into Nuix Discover, the login page appears before opening the linked document.

Search page option added to the Case Home menu

You can now access the Search page from the Case Home menu, as shown in the following figure.

Case Home Search page

Default start page for a group

Your administrator can now define the Nuix Discover page that appears for your group after you log in to the application. For example, if your administrator sets the start page for your group to be the Documents page, that page appears after you log in, and Workspace A appears.

View pane: MHT documents converted to PDF in the Native view in the View pane

The application now converts .mht documents to a PDF format when you access them in the Native view in the View pane, as shown in the following figure.

Native view in the View pane

Security > Features: Memo Editor pane configuration

To make the Memo Editor pane available to users, on the Case Home > Security > Features page, an administrator must set the Document – Memo editor feature to Allow for a group. By default, this feature is set to Deny.

Security > Groups: Set the default start page for a group

You can now set a default start page for a group. One of the benefits of this new feature is that you can, for example, route users directly to the Documents page so that they can start reviewing documents. Workspace A appears by default on the Documents page.

Use the following procedure to set the start page for an existing group.

  1. On the Security > Groups page, in the Name column, click the link for a group.
  2. On the Properties page, in the Start page list, shown in the following figure, select one of the following start pages: Documents, Search, Transcripts, Production Pages, Security, Case Setup, Manage Document, Review Setup, Analysis.

    Note: The Case Home page is the default start page.

    Properties page Start page pick list options
  3. Click Save.

    The next time a member of the group logs in to the application, the designated start page appears. For example, if you set the Documents page as the start page, the Documents page appears by default.

Use the following procedure to change the start page for an existing group.

  1. On the Security > Groups page, on the toolbar, click Add.
  2. In the Create group dialog box, shown in the following figure, do the following:
    • In the Name box, provide a name.
    • In the Start page list, select a page.
      Create group dialog box
  3. Click Save.

Portal Management > User Administration: Require SAML users to re-enter credentials after logging out

System administrators can now require users who use a Security Assertion Markup Language (SAML) provider for authentication to re-enter their credentials after logging out of Nuix Discover.

To add this requirement, go to the Portal Home > User Administration > Identity Provider Settings page and click on the name of the configuration. On the Properties page, in the Configuration section, enter the following line:

“saml_force_reauth”: “true”

Portal Management > Processing: Download a log for a Supervisor

You can now download a log for a supervisor. The log includes error and info messages.

To download a log to a .csv format, on the Logs page for a Supervisor, click the Download logs button, shown in the following figure.

Download logs button

Portal Management > Settings: Text extraction: Update batching logic in text extraction job

In previous versions, the application processed text extraction jobs in batches using the number of files per batch that was specified in the Extract text job batch size case setting. (To access this setting, go the Portal Management > Cases and Servers > Cases page and click on the name of a case.)

To efficiently accommodate larger files, portal administrators can now set batch thresholds by file size using the Extract text job max batch file size portal setting, shown in the following figure.

To access this setting, go to the Portal Management > Settings > Portal Options page. The application determines the text extraction job batch size using whichever is smaller in file size: the number of files specified in the case setting or the maximum file size per batch specified in the portal setting.

Portal Management - Settings - Portal Options page showing information tooltip

Import API: Delete files from the S3 bucket upon completion of an import job

If the import job setting is to copy files from S3, once the files are copied, the application deletes the files from the S3 bucket. The application deletes the files for only those import jobs that completed successfully. The application does not delete files in failed import jobs.

SaaS / Hosted Monthly Release Notes - March 2020 (10.2.005 - 10.2.008)

Translate: New and updated source languages

The Translate feature now includes additional source language options, for example, Irish and Punjabi, when translating with Microsoft.

Some of the source language options for Google have been renamed. For example, Portuguese has been renamed to Portuguese (Portugal, Brazil).

These new or updated source language options are available in the Translate workspace pane and the Tools > Translate dialog box.

Coding History for fields updated by import jobs

The Coding History feature now captures audit records for field values that are updated by import jobs for existing document records.

The Coding History pane will include the following information:

  • The updated field value.
  • The user who created the import job as well as the date and time of the import job.
  • The previously coded value that was changed.
  • The user who applied the coding as well as the date and time of the previous coding.

Note: Your administrator must grant you read access to these fields, so that the fields appear in the Coding History pane.

Imports: Delete data from S3 bucket after completing import jobs

If files in an import job are copied from S3, the application deletes the files that were in the S3 bucket once the import job is successfully completed.

Productions: New Quality Control check for annotations that are not applied to the production

An Annotations exist that are not selected to be applied quality control check has been added to the Quality Control page for productions, as shown in the following figure. This check is enabled when at least one production rule other than Custom placeholder is selected on the Production rules page.

The Annotations exist that are not selected to be applied check identifies documents that have annotations applied to them that are not applied in the production.

If the application identifies any affected documents, a message that indicates the number of documents appears in the Result column on the Quality Control page for the production. Click the message to view the affected documents on the Documents page.

Documents page

Organizations: Set default file repositories

System administrators can now set default file repositories for an organization on the organization’s Properties page, as shown in the following figure.

Properties page

Note: The lists do not populate by default. The options in the lists include the file repositories that appear on the File Repositories page for an organization.

The options in this list include:

  • Image: Image or Index repositories
  • Index file: Image or Index repositories
  • File transfer: Image or Index repositories
  • Archive: Archive repositories
  • External: External repositories

The following three new columns now appear on the File Repositories page for an organization, as shown in the following figure.

File Repositories page
  • Default repository for:
    • If a file repository is the default repository, the values for indexes or images appear in this column.
    • Note: If a file repository is not linked to an organization, the default repository value does not appear on the Properties page for the organization.

  • Archive: If the file repository is the default file repository, a dot appears in the Archive column.
  • External: If the file repository is an external file repository, a dot appears in the External column.

Organizations: Set default servers

System administrators can now set default servers for an organization on the Properties page, as shown in the following figure.

Note: The lists do not populate by default. The options in these lists include the servers that appear on the Servers page for an organization.

Servers page
  • Database server: Database servers that you have permission to access.
  • Analysis server: Analysis servers that you have permission to access.

A new Default column appears on the Servers page for an organization, as shown in the following figure.

If a server is a default server, a dot appears in the Default column.

Note: If no servers are linked to the organization, this information does not appear on the Properties page for an organization.

Properties page Defaule column

Processing > Supervisors: Logs page for RPF supervisors

A new Logs page is available in the navigation pane on the supervisor Properties page.

To access this page, from the Portal Home page, go to Portal Management > Processing > Supervisors and select a supervisor in the list. The Logs page displays log information about the supervisor, which can help you identify error messages that may not otherwise appear in the interface.

Connect API Explorer: Query assignment data for report generation

The Connect API Explorer allows you to gather assignment data to generate reports that can show process workflows, phases, and user assignments.

The following lists the available fields for an assignment object query:

  • id
  • status: Object that extracts the following values:
    • Unassigned
    • Active
    • Suspended
    • Cleared
    • Deleted
    • Revoked
  • workflow: Object to extract the following field data:
    • description
    • id
    • name
    • phases
  • phases: Object to extract the following field data:
    • documentsPerAssignment
    • id
    • locked
    • name
    • parentId
    • parentPhaseName
    • quickCode
    • validationCriteriaName
  • lot: Object to extract the following field data:
    • id
    • name
  • name
  • user
  • assignedDate
  • clearedDate
  • createdDate
  • clear
  • total

Sample query:

query {
  cases (id: 5) {
    reviewSetup {
      workflows (id: 7) {
        phases (id: 10) {
          id
        }
      }
      assignments (id: 8) {
        id
      }
    }
  }
}

Connect API Explorer: userUpdate mutation for administration tasks

The Connect API Explorer userUpdate mutation allows administrators to perform updates to multiple user accounts simultaneously. When building this mutation, you must include the userId field to identify the user accounts.

Optional fields:

  • firstName
  • lastName
  • email
  • companyId
  • identityProviderId
  • portalCategory
  • disabled
  • requirePasswordChange: Previously named forceReset
  • licenses
  • password
  • addToActiveDirectory
  • forceResetChallengeQuestions

Important: When passing a field value that is blank, the mutation will remove the field. For example, the mutation will remove the disabled field if you enter disabled: “”. When entering new values for either the firstName or lastName, the mutation updates the entire name.

Sample mutation:

mutation {
  userUpdate(input: [
    {userId: 200, firstName: “Fred”, lastName: “Doo”},
    {userId: 1, firstName: “Velma”},
    {userId: 1, lastName: “Doo”}
  ]) {
    users {
      id
      fullName
    }
  }
}

Connect API Explorer: Clone cases using caseClone mutation

The caseClone mutation allows you to quickly create new cases without having to use the Nuix Discover UI. The following describes the mutation acceptance criteria.

Required fields:

  • caseName
  • organizationId: Used to identify an organization’s default template used for cloning.

Optional fields:

  • sourceCaseId: Data based on a user’s organization. If the sourceCaseId is missing and there is a selected default template, the mutation uses the organization’s default template case. If the sourceCaseId is missing and there is no default template selected, the application returns the following message: A sourceCaseId must be included in this mutation when an organization does not have a default template case.
  • Description
  • scheduleMetricsJob = true (default): If true, schedule is set to Monthly on day 31 at 11:00 PM.

The following lists the non-configurable fields that inherit the organization’s default or have a hard-coded default:

  • active = true (default)
  • clearData = true (default)
  • databaseServerId
  • imageRepositoryId
  • indexRepositoryId
  • fileTransferRepositoryId
  • analysisServerId
  • archiveRepositoryId
  • externalRepositoryId

The following lists examples of some of the available result fields for use in the caseClone mutation:

  • processingStatus: Object that extracts the following case processing status:
    • Failure
    • Pending
    • Queued
    • Succeeded
    • SucceededWithWarnings
  • processingType: Object that extracts the following case processing type:
    • Clone
    • Connect
    • Create
    • Decommission
    • DeleteDecommissionCase
    • Edit
    • Recommission

Note: This mutation does not support the process of setting the case metrics schedule to (daily (time)), (Weekly (week day, time)), (monthly(day, time)).

Sample mutation query with defaults:

mutation clone {
  caseClone (input: {
    organizationId: 1,
    sourceCaseId: 2,
    caseName: “My new clone”
  }) {
    case {
      id
    }
  }
}

Sample mutation query with options:

mutation clone {
  caseClone (input: {
    organizationId: 1,
    sourceCaseId: 2,
    caseName: “My new clone”,
    description: “This is my cloned case”,
    scheduleMetricsJob: true
  }) {
    case {
      id
    }
  }
}

Connect API Explorer: Remove assigned users from cases using the userCaseUnassign mutation

The Connect API Explorer userCaseUnassign mutation allows you to remove assigned users from cases for easy management of case access. This mutation allows you to remove multiple assignments simultaneously by pairing a single userId to a caseId, or multiple ids to a caseId. Only the userId field allows this many-to-one removal format. All other fields can only remove in a one-to-one format.

When assigning a user to an organization, if the user has an existing assignment to that organization, the notChangedCount field will increase by the appropriate number.

Required fields:

  • userId
  • caseId

Sample mutation:

mutation {
  userCaseUnassign(input: [
    {userId: [7,9,10,15], caseId: 120},
    {userId: 11, caseId: 121},
    {userId: 8, caseId: 120}
  ]) {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Connect API Explorer: Assign users to organizations using the userOrganizationAssign mutation

The Connect API Explorer userOrganizationAssign mutation allows you to assign users to organizations to help manage user assignments. This mutation allows you to perform multiple assignments simultaneously by pairing a single userId to an organizationId, or multiple ids to an organizationId. Only the userId field allows this many-to-one assignment format. All other fields can only assign in a one-to-one format.

When assigning a user to an organization, if the user has an existing assignment to that organization, the notChangedCount field will increase by the appropriate number.

Required fields:

  • userId
  • organizationId

Sample mutation:

mutation {
  userOrganizationAssign(input: [
    {userId: [7,9,10,15], organizationId: 4},
    {userId: 7, organizationId: 10},
    {userId: 8, organizationId: 4}
  ]) {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Sample response:

{
  data: {
    userOrganizationAssign { totalCount: 6, successCount: 4, errorCount: 1, notChangedCount: 1 },
  },
  errors: [{ message: “Failed to assign the following users to organization 4: 8 }]
}

Connect API Explorer: Assign users to cases using the userCaseAssign mutation

The Connect API Explorer userCaseAssign mutation allows you to easily assign users to cases for easy management of case access. This mutation allows you to perform multiple assignments simultaneously by pairing a single userId to a caseId, or multiple ids to a caseId. Only the userId field allows this many-to-one assignment format. All other fields can only assign in a one-to-one format.

New assignments automatically set the Access Restrictions to None as the default. Currently, the mutation does not have the ability to change this setting to another option. You must modify these settings manually through the UI.

When assigning a user to a case, if the user has an existing assignment to that case, leaving the caseGroupId field blank will not change the existing caseGroupId data for that user. If a user was previously assigned to a group in a case, and that user is removed from that case, when they are re-added to the case without specifying a group, they will be placed back into the group to which they previously belonged.

When assigning a user to an organization, if the user has an existing assignment to that organization, the notChangedCount field will increase by the appropriate number.

Note: Portal administrators will not have the ability to assign a user to a case that is outside their own organization.

Required fields:

  • userId
  • caseId
  • caseUserCategory

Optional fields:

  • caseGroupId

Sample mutation:

mutation {
  userCaseAssign(input: [
    {userId: [7,9,10,15], caseId: 120, caseUserCategory: Administrator, caseGroupId: 34},
    {userId: [8], caseId: 120, caseUserCategory: GroupMember, caseGroupId: 34}
]) {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Connect API Explorer: Query users and their groups within cases

The Connect API Explorer allows you to query information on users and their groups within cases to help manage users and groups across review platforms. You can filter and sort the group data by name, id or userCount for NumericComparison. You can also separate the query results by page by using the standard_scroll_parameter (for example, scroll: \{start: 1, limit: 100}).

Note: To return the users of a specific group, add the user’s node under groups.

The following lists the available fields for querying user and group data:

  • groups: Object to extract the following field data:
    • id
    • name
    • userCount
    • timelineDate
    • quickCode
    • startPage
    • users

Sample query:

query cases {
  cases(id:5){
    name
    groups (id: 17 name: “group name” sort: [{ field: Name, dir: Asc }]) {
      id
      name
      userCount
      users {
        id
        name
      }
    }
  }
}

Connect API Explorer: Cross organization cloning using caseClone mutation

The mutation caseClone now allows the cloning of organizations without using the UI Extensions. The following is the acceptance criteria when using this process.

Required Fields:

  • caseName: Required data.
  • organizationId: Required data.
  • souceCaseId: Optional data with defaults based on user’s organization.
    • When not included, the mutation will use the organization’s default case template.
    • When not included and there is no default case template, the mutation uses the portal default case template.
    • When not included and there is no default case template or a portal case template, the application returns the following message: A sourceCaseId must be included in this mutation when the portal and organization do not have a default template case.
  • description: Optional data.
  • scheduleMetricsJob = true (default): Optional data. If true, schedule is set to Monthly on day 31 at 11:00 PM.
    • The mutation does not support setting the case metrics schedule as (daily (time)), (Weekly (week day, time)), (monthly(day, time)).

The following are non-configurable fields and inherit the organization defaults or have a hard-coded default:

  • active = true (default)
  • clearData = true (default)
  • databaseServerId
  • imageRepositoryId
  • indexRepositoryId
  • fileTransferRepositoryId
  • analysisServerId
  • archiveRepositoryId
  • externalRepositoryId

The following is an example of how to use these defaults and options.

Sample mutation with defaults:

mutation clone {
  caseClone(input: {
    sourceCaseId: 1,
    caseName: “My new cloned case”
  }) {
    case {
      id
    }
  }
}

Sample mutation with options:

mutation clone {
  caseClone(input: {
    organizationId: 11,
    sourceCaseId: 12,
    caseName: “My new cloned case”,
    description: “This case is described”,
    scheduleMetricsJob: true
  }) {
    case {
      id
    }
  }
}

SaaS / Hosted Monthly Release Notes - February 2020 (10.2.001 - 10.2.004)

Exports: New image formatting options

When exporting images in a custom export, you now have the option to convert images to searchable PDFs. This option is available on the Image settings page of the Export window.

Export - Image settings page showing Image format for PDFs

In the Image format list, if you select Convert to searchable PDFs, the application converts any non-PDF endorsable image files into searchable PDFs. For existing PDF image files, the application embeds text in the PDF file.

Note: If you select an option for image formatting that converts an image type, only the exported image file is affected. No files on the Nuix Discover fileshare are altered.

In the Image format list, if you select either Convert to searchable PDFs or Embed OCR text in existing PDFs, additional options are available. These options include PDF resolution, Performance, Auto-rotate, Despeckle, Deskew, and Languages. These options existed in previous releases for embedding OCR text in existing PDFs. However, the list of language options has been expanded to match the list of language options that is available in the OCR tool on the Documents page. On the Image settings page, you can click the Settings button (or gear) and select languages in the Settings window. The default language is English.

If you select either the Convert to searchable PDFs or Embed OCR text in existing PDFs options, you also have the option to select the Unless annotations or footers are applied, do not run OCR on PDFs if the documents are already coded as searchable check box. This check box is selected by default. When selected, for any existing PDF files, the application checks the Document OCR Status field. If that field is set to Completed – Embedded text in the PDF or Completed with warnings – Embedded text in the PDF and no annotations or footers are applied on any page of the document, then the application does not attempt to make that PDF file searchable.

Note: The application updates the Document OCR Status field for base or rendition documents if they are made searchable using the OCR tool on the Documents page. The application also updates this field through the production print process on rendition documents, if the option to embed text in existing PDFs is selected. If you make PDFs searchable using the OCR tool or the production print process, the language options may not be the same as the options selected during export.

Export - Image settings page Recognized language options

For efficiency, if the Unless annotations or footers are applied, do not run OCR on PDFs if the documents are already coded as searchable check box is not selected, the application attempts to make searchable only those pages that need to be.

  • The application attempts to make each page searchable that has annotations or footers.
  • If no annotations or footers exist on a page, the application checks for any text on the page. If text exists, the application uses the original page. Otherwise, the application attempts to make the page searchable.
  • Note: Language selections for exports may be different than the languages selected when making the original page searchable.

Productions: New PDF Settings page

We have added a new settings page for productions named PDF settings. This page contains settings that previously appeared on the Endorsements settings page when the Enable PDF annotations option was set for a case.

Note: When the Enable PDF annotations option is not set for the case at the time that a production is created, the PDF Settings page does not appear for that production.

Language options have been expanded on the new PDF Settings page. When embedding OCR text in PDF images during the production print process, you can select from the same list of languages to use for text recognition that appears in the OCR tool on the Documents page. You can also select more than one language.

PDF Settings page

If the Embed OCR text in existing PDF images option is selected on the page, the application updates the Document OCR Status field (and if needed, the Document OCR Error Details field) for the rendition document to reflect the OCR status of the PDF image of the rendition.

Connect API Explorer: Query extensions in the API

There is a new query in the Nuix Discover Connect API Explorer for retrieving a list of extensions.

This query retrieves the following extension data:

  • Id: Integer.
  • Name: String.
  • Location: Enumerator.
  • Configuration: String.
  • Description: String.
  • URL: String.

Sample query:

{
  extensions {
    id
    name
    location
    configuration
    url
    description
    createdDate
    createdByUser {
      id
      fullName
    }
  }
}

SaaS / Hosted Monthly Release Notes - March 2020 (10.2.005 - 10.2.008)

Translate: New and updated source languages

The Translate feature now includes additional source language options, for example, Irish and Punjabi, when translating with Microsoft.

Some of the source language options for Google have been renamed. For example, Portuguese has been renamed to Portuguese (Portugal, Brazil).

These new or updated source language options are available in the Translate workspace pane and the Tools > Translate dialog box.

Coding History for fields updated by import jobs

The Coding History feature now captures audit records for field values that are updated by import jobs for existing document records.

The Coding History pane will include the following information:

  • The updated field value.
  • The user who created the import job as well as the date and time of the import job.
  • The previously coded value that was changed.
  • The user who applied the coding as well as the date and time of the previous coding.

Note: Your administrator must grant you read access to these fields, so that the fields appear in the Coding History pane.

Imports: Delete data from S3 bucket after completing import jobs

If files in an import job are copied from S3, the application deletes the files that were in the S3 bucket once the import job is successfully completed.

Productions: New Quality Control check for annotations that are not applied to the production

An Annotations exist that are not selected to be applied quality control check has been added to the Quality Control page for productions, as shown in the following figure. This check is enabled when at least one production rule other than Custom placeholder is selected on the Production rules page.

The Annotations exist that are not selected to be applied check identifies documents that have annotations applied to them that are not applied in the production.

If the application identifies any affected documents, a message that indicates the number of documents appears in the Result column on the Quality Control page for the production. Click the message to view the affected documents on the Documents page.

Documents page

Organizations: Set default file repositories

System administrators can now set default file repositories for an organization on the organization’s Properties page, as shown in the following figure.

Properties page

Note: The lists do not populate by default. The options in the lists include the file repositories that appear on the File Repositories page for an organization.

The options in this list include:

  • Image: Image or Index repositories
  • Index file: Image or Index repositories
  • File transfer: Image or Index repositories
  • Archive: Archive repositories
  • External: External repositories

The following three new columns now appear on the File Repositories page for an organization, as shown in the following figure.

File Repositories page
  • Default repository for:
    • If a file repository is the default repository, the values for indexes or images appear in this column.
    • Note: If a file repository is not linked to an organization, the default repository value does not appear on the Properties page for the organization.

  • Archive: If the file repository is the default file repository, a dot appears in the Archive column.
  • External: If the file repository is an external file repository, a dot appears in the External column.

Organizations: Set default servers

System administrators can now set default servers for an organization on the Properties page, as shown in the following figure.

Note: The lists do not populate by default. The options in these lists include the servers that appear on the Servers page for an organization.

Servers page
  • Database server: Database servers that you have permission to access.
  • Analysis server: Analysis servers that you have permission to access.

A new Default column appears on the Servers page for an organization, as shown in the following figure.

If a server is a default server, a dot appears in the Default column.

Note: If no servers are linked to the organization, this information does not appear on the Properties page for an organization.

Properties page Defaule column

Processing > Supervisors: Logs page for RPF supervisors

A new Logs page is available in the navigation pane on the supervisor Properties page.

To access this page, from the Portal Home page, go to Portal Management > Processing > Supervisors and select a supervisor in the list. The Logs page displays log information about the supervisor, which can help you identify error messages that may not otherwise appear in the interface.

Connect API Explorer: Query assignment data for report generation

The Connect API Explorer allows you to gather assignment data to generate reports that can show process workflows, phases, and user assignments.

The following lists the available fields for an assignment object query:

  • id
  • status: Object that extracts the following values:
    • Unassigned
    • Active
    • Suspended
    • Cleared
    • Deleted
    • Revoked
  • workflow: Object to extract the following field data:
    • description
    • id
    • name
    • phases
  • phases: Object to extract the following field data:
    • documentsPerAssignment
    • id
    • locked
    • name
    • parentId
    • parentPhaseName
    • quickCode
    • validationCriteriaName
  • lot: Object to extract the following field data:
    • id
    • name
  • name
  • user
  • assignedDate
  • clearedDate
  • createdDate
  • clear
  • total

Sample query:

query {
  cases (id: 5) {
    reviewSetup {
      workflows (id: 7) {
        phases (id: 10) {
          id
        }
      }
      assignments (id: 8) {
        id
      }
    }
  }
}

Connect API Explorer: userUpdate mutation for administration tasks

The Connect API Explorer userUpdate mutation allows administrators to perform updates to multiple user accounts simultaneously. When building this mutation, you must include the userId field to identify the user accounts.

Optional fields:

  • firstName
  • lastName
  • email
  • companyId
  • identityProviderId
  • portalCategory
  • disabled
  • requirePasswordChange: Previously named forceReset
  • licenses
  • password
  • addToActiveDirectory
  • forceResetChallengeQuestions

Important: When passing a field value that is blank, the mutation will remove the field. For example, the mutation will remove the disabled field if you enter disabled: “”. When entering new values for either the firstName or lastName, the mutation updates the entire name.

Sample mutation:

mutation {
  userUpdate(input: [
    {userId: 200, firstName: “Fred”, lastName: “Doo”},
    {userId: 1, firstName: “Velma”},
    {userId: 1, lastName: “Doo”}
  ]) {
    users {
      id
      fullName
    }
  }
}

Connect API Explorer: Clone cases using caseClone mutation

The caseClone mutation allows you to quickly create new cases without having to use the Nuix Discover UI. The following describes the mutation acceptance criteria.

Required fields:

  • caseName
  • organizationId: Used to identify an organization’s default template used for cloning.

Optional fields:

  • sourceCaseId: Data based on a user’s organization. If the sourceCaseId is missing and there is a selected default template, the mutation uses the organization’s default template case. If the sourceCaseId is missing and there is no default template selected, the application returns the following message: A sourceCaseId must be included in this mutation when an organization does not have a default template case.
  • Description
  • scheduleMetricsJob = true (default): If true, schedule is set to Monthly on day 31 at 11:00 PM.

The following lists the non-configurable fields that inherit the organization’s default or have a hard-coded default:

  • active = true (default)
  • clearData = true (default)
  • databaseServerId
  • imageRepositoryId
  • indexRepositoryId
  • fileTransferRepositoryId
  • analysisServerId
  • archiveRepositoryId
  • externalRepositoryId

The following lists examples of some of the available result fields for use in the caseClone mutation:

  • processingStatus: Object that extracts the following case processing status:
    • Failure
    • Pending
    • Queued
    • Succeeded
    • SucceededWithWarnings
  • processingType: Object that extracts the following case processing type:
    • Clone
    • Connect
    • Create
    • Decommission
    • DeleteDecommissionCase
    • Edit
    • Recommission

Note: This mutation does not support the process of setting the case metrics schedule to (daily (time)), (Weekly (week day, time)), (monthly(day, time)).

Sample mutation query with defaults:

mutation clone {
  caseClone (input: {
    organizationId: 1,
    sourceCaseId: 2,
    caseName: “My new clone”
  }) {
    case {
      id
    }
  }
}

Sample mutation query with options:

mutation clone {
  caseClone (input: {
    organizationId: 1,
    sourceCaseId: 2,
    caseName: “My new clone”,
    description: “This is my cloned case”,
    scheduleMetricsJob: true
  }) {
    case {
      id
    }
  }
}

Connect API Explorer: Remove assigned users from cases using the userCaseUnassign mutation

The Connect API Explorer userCaseUnassign mutation allows you to remove assigned users from cases for easy management of case access. This mutation allows you to remove multiple assignments simultaneously by pairing a single userId to a caseId, or multiple ids to a caseId. Only the userId field allows this many-to-one removal format. All other fields can only remove in a one-to-one format.

When assigning a user to an organization, if the user has an existing assignment to that organization, the notChangedCount field will increase by the appropriate number.

Required fields:

  • userId
  • caseId

Sample mutation:

mutation {
  userCaseUnassign(input: [
    {userId: [7,9,10,15], caseId: 120},
    {userId: 11, caseId: 121},
    {userId: 8, caseId: 120}
  ]) {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Connect API Explorer: Assign users to organizations using the userOrganizationAssign mutation

The Connect API Explorer userOrganizationAssign mutation allows you to assign users to organizations to help manage user assignments. This mutation allows you to perform multiple assignments simultaneously by pairing a single userId to an organizationId, or multiple ids to an organizationId. Only the userId field allows this many-to-one assignment format. All other fields can only assign in a one-to-one format.

When assigning a user to an organization, if the user has an existing assignment to that organization, the notChangedCount field will increase by the appropriate number.

Required fields:

  • userId
  • organizationId

Sample mutation:

mutation {
  userOrganizationAssign(input: [
    {userId: [7,9,10,15], organizationId: 4},
    {userId: 7, organizationId: 10},
    {userId: 8, organizationId: 4}
  ]) {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Sample response:

{
  data: {
    userOrganizationAssign { totalCount: 6, successCount: 4, errorCount: 1, notChangedCount: 1 },
  },
  errors: [{ message: “Failed to assign the following users to organization 4: 8 }]
}

Connect API Explorer: Assign users to cases using the userCaseAssign mutation

The Connect API Explorer userCaseAssign mutation allows you to easily assign users to cases for easy management of case access. This mutation allows you to perform multiple assignments simultaneously by pairing a single userId to a caseId, or multiple ids to a caseId. Only the userId field allows this many-to-one assignment format. All other fields can only assign in a one-to-one format.

New assignments automatically set the Access Restrictions to None as the default. Currently, the mutation does not have the ability to change this setting to another option. You must modify these settings manually through the UI.

When assigning a user to a case, if the user has an existing assignment to that case, leaving the caseGroupId field blank will not change the existing caseGroupId data for that user. If a user was previously assigned to a group in a case, and that user is removed from that case, when they are re-added to the case without specifying a group, they will be placed back into the group to which they previously belonged.

When assigning a user to an organization, if the user has an existing assignment to that organization, the notChangedCount field will increase by the appropriate number.

Note: Portal administrators will not have the ability to assign a user to a case that is outside their own organization.

Required fields:

  • userId
  • caseId
  • caseUserCategory

Optional fields:

  • caseGroupId

Sample mutation:

mutation {
  userCaseAssign(input: [
    {userId: [7,9,10,15], caseId: 120, caseUserCategory: Administrator, caseGroupId: 34},
    {userId: [8], caseId: 120, caseUserCategory: GroupMember, caseGroupId: 34}
]) {
    totalCount
    successCount
    errorCount
    notChangedCount
  }
}

Connect API Explorer: Query users and their groups within cases

The Connect API Explorer allows you to query information on users and their groups within cases to help manage users and groups across review platforms. You can filter and sort the group data by name, id or userCount for NumericComparison. You can also separate the query results by page by using the standard_scroll_parameter (for example, scroll: \{start: 1, limit: 100}).

Note: To return the users of a specific group, add the user’s node under groups.

The following lists the available fields for querying user and group data:

  • groups: Object to extract the following field data:
    • id
    • name
    • userCount
    • timelineDate
    • quickCode
    • startPage
    • users

Sample query:

query cases {
  cases(id:5){
    name
    groups (id: 17 name: “group name” sort: [{ field: Name, dir: Asc }]) {
      id
      name
      userCount
      users {
        id
        name
      }
    }
  }
}

Connect API Explorer: Cross organization cloning using caseClone mutation

The mutation caseClone now allows the cloning of organizations without using the UI Extensions. The following is the acceptance criteria when using this process.

Required Fields:

  • caseName: Required data.
  • organizationId: Required data.
  • souceCaseId: Optional data with defaults based on user’s organization.
    • When not included, the mutation will use the organization’s default case template.
    • When not included and there is no default case template, the mutation uses the portal default case template.
    • When not included and there is no default case template or a portal case template, the application returns the following message: A sourceCaseId must be included in this mutation when the portal and organization do not have a default template case.
  • description: Optional data.
  • scheduleMetricsJob = true (default): Optional data. If true, schedule is set to Monthly on day 31 at 11:00 PM.
    • The mutation does not support setting the case metrics schedule as (daily (time)), (Weekly (week day, time)), (monthly(day, time)).

The following are non-configurable fields and inherit the organization defaults or have a hard-coded default:

  • active = true (default)
  • clearData = true (default)
  • databaseServerId
  • imageRepositoryId
  • indexRepositoryId
  • fileTransferRepositoryId
  • analysisServerId
  • archiveRepositoryId
  • externalRepositoryId

The following is an example of how to use these defaults and options.

Sample mutation with defaults:

mutation clone {
  caseClone(input: {
    sourceCaseId: 1,
    caseName: “My new cloned case”
  }) {
    case {
      id
    }
  }
}

Sample mutation with options:

mutation clone {
  caseClone(input: {
    organizationId: 11,
    sourceCaseId: 12,
    caseName: “My new cloned case”,
    description: “This case is described”,
    scheduleMetricsJob: true
  }) {
    case {
      id
    }
  }
}