Manage portal options
To use some application features, you must provide values for portal options. Use this topic to help you understand the areas affected by setting and changing portal options, and any default values provided.
Only system administrators can change these values.
The application portal options are settings that administrators can change to alter the behavior or appearance of the entire portal and, in some situations, all of the cases in the portal. Only system administrators can access and edit portal options.
To manage portal options:
On the Portal Home page, under Portal Management, click Settings.
On the Portal Options page, edit options as need. Hover over the tooltip for a description of each option.
To save the changes, click Save.
Note: The options described in this topic are grouped by category. The options in the application appear in alphabetical order.
Configuration options
Update the options described in the following table to set or change the way that the application operates in your environment.
Some of these options may not be visible on the Portal options page.
|
Option |
Description |
Default |
Affected areas |
|
Audio transcription service configuration |
Provide the information for the audio transcription service. Note: This functionality is enabled through third-party API integration with IBM. For information about licensing and how to sign up for this service, see the following link: https://www.ibm.com/watson/services/speech-to-text. |
No default |
Audio feature |
| AWS automation role name | The name of the role to use for managing AWS resources. | No default | |
| AWS file transfer configuration (S3) | A JSON string containing the configuration settings (AccessKeyId, SecretAccessKey, Region, Bucket, Prefix, TemporaryCredentialsRoleName) to connect to AWS and create a temporary S3 file transfer location and credentials. | No default | |
|
URL to access the Connect API. |
No default |
Connect API |
|
|
Content search service URL |
Set this to the URL where the application can access the content search service. |
No default |
Content search, indexing |
| Days to display deleted cases in portal reports | The number of days to display information about deleted cases on the Portal Management > Reports pages. | 60 days | Portal Management > Reports |
| Enable activity history audit for portal management activities |
If selected, the application audits user activities in the Portal Management area. Warning: Once you enable this option, you cannot disable it. |
Cleared | Audit |
| Enable activity history audit in new cases |
If selected, the application enables the user activity history audit feature for new cases. Note: This feature requires the user audit log service and the Elasticsearch to be deployed in the portal environment. |
Cleared | Audit |
| Enable Linux/Docker Ingestions | If selected, Ingestions uses Linux/Docker for the processing step. | Cleared | Ingestions |
| Enable Linux/Docker Ingestions Autoscale EC2 Instances (SaaS only) |
If selected, the Coordinator automatically provisions a Linux Ingestions worker when you submit an Ingestions job. See Enable Linux/Docker Ingestions and Ingestion AWS Lambda Function Name. Note: This option applies only if you use the Linux/Docker Ingestions feature in SaaS. If you select this option, verify that the Enable Linux/Docker Ingestions check box is selected. |
Cleared | Linux/Docker Ingestions |
|
Enable organizations security |
If selected, the application enables security for the Organizations feature in the application, with the following effects: Portal administrators who are members of a provider organization can access the Organizations feature. Portal administrators can manage only the cases and users associated with their organization. Users can be assigned to only the cases associated with their organization. Important: Once you enable the option, the option is no longer visible on this page. If you enable the option in error, contact Nuix Support for instructions on how to disable the option. |
Cleared |
Portal Management > Organizations |
|
Enable PDF redaction functionality for cases in this portal. You must also select this portal option to use the Enable PDF annotations case option. When enabled in both the portal and the case, users can: Add redactions, highlights, and notes to PDFs. Include PDF files as images in a production. These files can be endorsed. Control the resolution of PDF page rendering when endorsing PDFs in a production. Use page level granularity, which means users can work on individual pages of PDF documents. |
Cleared |
Productions, Pages view |
|
| Enable PDF direct view | Enable the display of PDFs via a user’s web browser when choosing the near-native view. | Cleared | Productions, Pages View |
| Enable server certificate validation |
If you select this option, the following services will not operate until they have a valid SSL certificate: Login Aspera Search Hit Highlight Office Online Server Note: If you select this option and a service does not operate due to an invalid SSL certificate, you are prompted to contact your administrator, and the application writes an error to the error log. |
Cleared | Various services |
|
Hit highlight service URL |
To improve performance, hit highlighting can be configured as a separate service. The system administrator needs to install the hit highlight service and provide the URL to use. |
No default |
View pane |
| Ingestion AWS Lambda Function Name (SaaS only) |
Enter the name of the AWS Lambda function used to provision Linux Ingestions workers. If you select this option, verify that the Enable Linux/Docker Ingestions check box is selected. See Enable Linux/Docker Ingestions and Enable Linux/Docker Ingestions Autoscale EC2 Instances. Note: This option applies only if you use the Linux/Docker Ingestions feature in SaaS. If you select this option, verify that the Enable Linux/Docker Ingestions check box is selected. |
Cleared | Linux/Docker Ingestions |
| Ingestion Docker Image Version | The version of the Docker container for Linux Ingestions. | No default | Linux/Docker Ingestions |
|
Ingestion Licensing Server |
The ingestion licensing server used by all cases in the portal. A valid IP address for this option indicates that ingestions are enabled for all cases in the portal. The ingestion server can share the name and location with the application analysis server. |
No default |
Ingestions |
| Maximum concurrent sessions | The maximum number of licenses a Portal User can be assigned. Portal Administrators and System Administrators are always limited to one license. | Licenses | |
|
Maximum security question attempts |
The maximum number of failed challenge question attempts before the application locks a user account. |
5 |
Application login |
|
Native Viewer WOPI URL |
URL to the application-specific implementation of the Web Application Open Platform Interface (WOPI). Set this URL to RingtailURL/Document, where RingtailURL is the URL of your application environment. |
No default |
View pane |
|
Office Online enable Edit mode |
If enabled, allows users to access the Microsoft Office Online features that are available with an Office Online Editing license. For example, edit mode allows reviewers to see formulas and display hidden worksheets, rows, and columns in Microsoft Excel and to display comments in Microsoft Word. Your organization must have an Office Online Volume License with Microsoft to enable this feature. |
Cleared |
View pane |
|
Office Online URL |
If using an Office Online Server (OOS) with your native file viewer, the URL path to your OOS installation. For example, http://oos. |
No default |
View pane |
|
URL for Mobile Binders Web service |
This is the Web Service URL and not the URL used to access mobile binders on the iPad with the Mobile Binders app. The URL must be in the format of either https://servername/RingtailWebservices/ or http://servername/RingtailWebservices |
No default |
Mobile Binders app |
| User audit archive configuration | A JSON string containing the configuration settings (ElasticsearchSnapshotRepositoryLocation, TimeoutInMinutesForSnapshotCreation, PollingIntervalInSeconds) for archiving and restoring user audit data. If connecting to the AWS Elasticsearch service, include the following S3Config settings in the JSON string: "S3Config": {"Bucket":"","Region":"","RoleArn":"","Key":"","Token":""} | No default | Audit |
| User audit log download repository | Enter the name of the internal File Repository where audit log files are staged for download. This should be a dedicated repository for audit download use only and should not be assigned to any organization or cases. | No default | Audit |
| User audit log service Elasticsearch API key | The user audit log service supports using an Elasticsearch API key and ID for authenticating to a secured Elasticsearch cluster. To connect to a secured Elasticsearch cluster, enter the Elasticsearch API key and API ID as a JSON string into this setting. In the User audit log service Elasticsearch API key box, provide a JSON string {"ElasticsearchApiKey":"*******","**ElasticsearchApiId":"*******"} containing the Elasticsearch API key and API ID to use for authentication. | No default | User audit log service |
|
User audit log service URL |
The URL for the machine that the user audit log service is installed on. Type the URL that contains the host name of the audit log service machine and the port, 10003. Note that after the user audit log service is installed and the URL is configured, new cases automatically have coding history enabled. All coding decisions made by reviewers are logged. |
No default |
Coding history |
System values
By default, the settings for the portal options described in the following table are optimized and should not need to be changed. Nuix Support can advise if you need to set or change these values.
Some of these options may not be visible on the Portal options page.
|
Option |
Description |
Default |
|
Content search dtSearch timeout |
The maximum duration of the search server's content search request, in seconds. |
600 seconds |
|
Content search request timeout |
The maximum duration of the search client's HTTP (Web) request, in seconds. |
600 seconds |
| Extract text job max batch file size | The maximum batch file size in bytes for text extraction jobs. The application determines the text extraction job batch size using whichever is smaller in file size: the number of files specified in the Extract text job batch size case option on the Portal Management > Cases and Servers > [Case] > Case Options page or the file size specified in this portal option. | 2147483647 |
|
Import staging option |
Allows you to choose whether to keep import staging tables for troubleshooting. Options are: Never: Never keep the staging tables Always: Always keep the staging tables Failure: Keep the staging tables when the import fails. |
Failure |
|
Maximum file size to index default |
The maximum file size for content files to be indexed. File sizes above this limit result in a file indexing status of “Excluded by Size.” This value cannot be set greater than 2147483647. |
104,857,600 bytes |
|
Maximum memory to use in MB |
The maximum amount of memory that dtSearch can use during indexing, in MB. |
1,024 MB |
|
Re-enable Migrate Portal Data button |
Enables the Migrate Portal Data button if the button is not visible on the Portal Home page. |
Cleared |
|
RPF Supervisor temporary folder |
Path to base folder for the RPF Supervisor to use for temporary data. If no value is specified for this option, the default value is %SystemRoot%\Temp (for example, C:\WINDOWS\Temp). |
Blank (uses C:\WINDOWS\Temp) |
|
STF content search dtSearch timeout |
Maximum duration, for the content search server time-out for Search Term Family processing, in seconds. |
1,800 seconds |
|
STF content search request timeout |
Maximum duration for the content search server request time-out for Search Term Family processing, in seconds. |
1,800 seconds |
|
View pane file extension filter |
Filter out files with these extensions and do not display the files in the View pane. Use the vertical bar character (|) to delimit values. |
bat|exe|dll|vbs|com|asp|pif|zip|scr|hlp|nsf|pst|ost |
| View pane maximum audio file size | Set this value to limit the size (in bytes) of audio files to stream in the View pane. This option addresses Internet Information Services (IIS) performance issues for .wav files. | 3147280 bytes |
|
View pane maximum file size |
Do not show files over this size in bytes to users in the View pane. Users see an error message if they try to view a larger file. |
104857600 bytes |
|
View pane maximum media file size |
Set this value to limit the size of media files to stream in the View pane. |
51200000 bytes |
|
View pane media thread count |
Set this value to limit the number of allowed threads to address server processing consumption by the FFmpeg when streaming media files. |
1 |
Developer settings
Application developers use the following options for product testing and troubleshooting. If either of these options are visible on the Portal Options page for your cases, do not change their values.
Cubes administration module upgraded
Keyword highlighting enhanced performance