Administer UI extensions
The user interface extensions (UI extensions) feature allows application administrators and service providers to extend the functionality of the application by embedding third-party web applications directly into the application interface. A third-party web application that loads within the application is called a UI extension.
About UI extensions
The UI extensions that you integrate with the application depend on the needs of your users. For example, you can add extensions that address client-specific custom workflows, or that connect functionality in the application with functionality in other applications, or that generate revenue for your firm by providing value-added services for your clients.
You can add UI extensions to the Portal Home page, as new pages on the Case Home page, as workspace panes on the Documents page, and as workspace tools on the Tools menu on the Documents page.
You can add UI extensions to the Portal Home page, as new pages on the Case Home page, and as workspace panes on the Documents page.
Some example extensions include:
On the Portal Home page:
A reporting or billing tool
A search engine
On the Case Home page:
An automated job scheduling and notification tool for case administrators
An analysis tool to perform usage and status reporting
A custom application that synchronizes document sets with third-party software
As workspace panes on the Documents page:
A machine language translation tool for reviewing documents in foreign languages
Audio and video review tools for multimedia documents
Native redaction tools
Review tools for custom format documents, such as chat room messages, technical drawings, or system logs
A custom application that sends documents to other systems for external processing
As workspace tools on the Tools menu on the Documents page:
A custom tool that combines multiple steps into one process. For example, a tool that would allow you to take Predictive Coding score ranges and tag them with different review priority levels. Users could then search for documents by the review priority and tag those documents with the correct priority level.
A UI extension to an external website, for example, a website for a calculator tool.
Note: Some websites, for example, CNN, block UI extensions from being added to the Tools menu.
Optionally, extensions can include custom fields and case statistics. For example, you can use custom statistics to track client billing data. The developer who builds an extension defines the custom fields and case statistics that are available for the extension.
Note: To display up-to-date values for a UI extension's custom fields and case statistics, you must run a case metrics job or an indexing and enrichment job with the "gather case metrics" option selected. For information about how to run a job, see Jobs.
Developers can refer to the UI Extension SDK (software development kit) for steps to build and configure an extension. For information about the UI Extension SDK, see UI Extension SDK.
Add a UI extension to the application
To add a UI extension to the application, perform the following high-level steps:
A developer builds the web application that you want to integrate with the application as a UI extension. For information about how a developer can build an extension, see UI Extension SDK.
Install the web application as a UI extension in the application. For information, see Install a UI extension.
Enable the extension for organizations. For information, see Enable a UI extension for an organization.
Enable the extension for cases. For information, see Enable a UI extension for a case.
Set security for the extension based on user groups. For information, see Set group security for a UI extension.
Before you start
Before you add a UI extension to the application, gather the following information:
If the developer who created the extension also created a manifest file, you need the following information:
The manifest file for the extension. A manifest file is a file that you upload to the application to define the extension's settings.
Configuration details that the application passes to the extension, such as license keys or setup information. The manifest file specifies configuration details at the extension level. At the organization level and case level, you can specify configuration details manually. Typically, the developer who creates the extension decides what configurations are required, if any.
If the developer who created the extension did not create a manifest file, you need the following information:
The URL of the web application that you are adding as an extension. If the application uses the HTTPS protocol, the extension must also use HTTPS.
Configuration details that the application passes to the extension, such as license keys or setup information. Configuration details can be specified at the extension level, the organization level, and the case level. Typically, the developer who creates the extension decides what configurations are required, if any.
The authentication secret for the extension, if required by the developer who created the extension. An authentication secret is used by your web application to confirm the authenticity of a request that comes from the extension. To create an authentication secret, you can do either of the following:
The developer who created the extension provides you with an authentication secret for the extension. You add the authentication secret to the application when you install the extension in the application.
The application generates a random string of characters to use as an authentication secret when you install the extension in the application. You provide the authentication secret to the developer who created the extension. The developer then adds the secret to the web application that you are adding as an extension.
Install a UI extension in the application
System administrators can install UI extensions in a portal for any organization or user, and portal administrators can install extensions for the organizations and users that they manage.
If the developer who created the extension provided you with a manifest file for the extension, you can install the extension by uploading the manifest file. Otherwise, you must manually install the extension. For more information, see Before you start.
Install a UI extension using a manifest file
To install a UI extension by uploading a manifest file:
On the Portal Home page, under Portal Management, click UI Extensions.
Click Add.
In the Settings editor area, select Advanced.
Click Browse, and then select the manifest file to upload.
Click Next.
Review the settings for the extension, and then click Save.
Enable the extension for organizations in the portal. For information, see Enable a UI extension for an organization.
Install a UI extension manually
To manually install a UI extension:
On the Portal Home page, under Portal Management, click UI Extensions.
Click Add.
In the Settings editor area, select Basic.
Type a Name for the UI extension.
In the Location list, select the location in the application where you want the extension to appear:
Workspace pane: The extension appears as a workspace pane on the Documents page.
Case home page: The extension appears as an additional page in the navigation pane on the Case Home page.
Portal home page: The extension appears on the Portal Home page.
Workspace tools: Used to add a custom UI extension to the Tools menu on the Documents page.
If you select Workspace tools in the Location list, under Default window size, you can set the following:
Width: The minimum value for the width is 200 pixels and the maximum value is 1280 pixels.
Height: The minimum value for the height is 150 pixels and the maximum value is 768 pixels.
Require document selection: If the tool involves working with documents, select this option to require document selection before using the tool.
Display the OK and Cancel buttons: This check box is selected by default. Clear the check box if you do not need to include OK and Cancel buttons in the window, for example, when adding a calculator tool.
If a configuration is required for the extension at the extension level, in the Configuration box, enter the configuration details. For more information about configurations, see Before you start.
Type an optional Description of the extension. The description appears on the UI Extensions page.
In the URL box, enter the URL of the web application that you are adding as an extension.
In the Authentication secret box, do either of the following, as described in Before you start:
If the developer who created the extension provided an authentication secret, enter the authentication secret in the box.
If you want the application to generate an authentication secret, click the Generate a random authentication secret button. Provide the authentication secret to the developer who created the extension.
Click Next.
Review the settings for the extension, and then click Save.
Enable the extension for organizations in the portal. For information, see Enable a UI extension for an organization.
Enable a UI extension for an organization
System administrators can enable UI extensions for the organizations in a portal.
To enable a UI extension for organizations:
To access the UI extensions that are installed in the application, on the Portal Home page, under Portal Management, click UI Extensions.
Click the name of an extension. For portal administrators, when organization security is enabled, the list of available items depends on membership in a provider or client organization. To understand how organizations are managed in Nuix Discover, see Organizations. For a summary of how organization security affects portal access for each user category, see Portal security table.
In the navigation pane, click Organizations.
Depending on which organizations you want to enable the extension for, do the following:
To enable the extension for a single organization, hover over the row for the organization, and then click Allow.
To enable the extension for all organizations, click the Allow button in the heading row.
If a configuration is required for the extension at the organization level, in the Configuration column, click a row. Enter the configuration details, and then click outside the box. For more information about configurations, see Before you start.
Enable the extension for cases. For information, see Enable a UI extension for a case.
Enable a portal UI extensions for users
To enable a portal UI extension for users:
On the Portal Home page, under Portal Management, click UI Extensions.
Click the name of a portal UI extension.
Note: Portal UI extensions have brown icons.
In the navigation pane, click Users.
On the Users page, enable the UI extension for one or more users.
The next time that a user refreshes the Portal Home page, the portal UI extension appears on the Portal Home page under Portal Extensions.
Enable a UI extension for a case
After a UI extension is enabled for an organization, system administrators and portal administrators can enable the extension for the cases that are assigned to the organization.
To enable a UI extension for cases:
To access the UI extensions that are installed in the application, on the Portal Home page, under Portal Management, click UI Extensions.
Click the name of an extension. For portal administrators, when organization security is enabled, the list of available items depends on membership in a provider or client organization. To understand how organizations are managed in Nuix Discover, see Organizations. For a summary of how organization security affects portal access for each user category, see Portal security table.
In the navigation pane, click Cases.
Depending on which cases you want to enable the extension for, do the following:
To enable the extension for a single case, hover over the row for the case, and then click Allow.
To enable the extension for all cases, click the Allow button in the heading row.
If a configuration is required for the extension at the case level, in the Configuration column, click a row. Enter the configuration details, and then click outside the box. For more information about configurations, see Before you start.
To allow groups to access the extension, set group security for the extension. For information, see Set group security for a UI extension.
Set group security for a UI extension
To allow the groups in a case to access a UI extension, administrators must grant access to the following security option:
UI Extension - UI Extension Name
For information about how to set group security for UI extensions, see Work with security for features.
Edit the properties of a UI extension
You can edit the properties of a UI extension, such as the name, the URL, the configuration details, or the authentication secret.
To edit the properties of a UI extension:
To access the UI extensions that are installed in the application, on the Portal Home page, under Portal Management, click UI Extensions.
Note: For portal administrators, when organization security is enabled, the list of available items depends on membership in a provider or client organization. To understand how organizations are managed in Nuix Discover, see Organizations. For a summary of how organization security affects portal access for each user category, see Portal security table.
Click the name of an extension.
On the Properties page, do any of the following:
To edit the name, URL, or other properties, type a value in the box. Click Save.
To update the extension's settings by uploading a new manifest file, click Advanced Settings, and then select the Advanced option. Click Browse, and then select the manifest file to upload. Click Next, and then click Save.
On the Organizations page, do any of the following:
To enable or disable the extension for organizations in the portal, click Allow or Deny.
To edit the configuration for the extension at the organization level, enable the extension for the organization. In the Configuration column, click a row. Enter the configuration details, and then click outside the box.
On the Cases page, do any of the following:
To enable or disable the extension for cases, click Allow or Deny.
To edit the configuration for the extension at the case level, enable the extension for the case. In the Configuration column, click a row. Enter the configuration details, and then click outside the box.
Delete a UI extension
System administrators can delete UI extensions.
To delete a UI extension from the application:
To access the UI extensions that are installed in the application, on the Portal Home page, under Portal Management, click UI Extensions.
Select the check box next to the extensions that you want to delete.
Click Delete, and then click OK.