Print this page
In this topic
Ringtail portal and case options are settings that administrators can access and change to alter the behavior of the portal or individual cases. For some of the settings, you must provide values to use Ringtail features. Use this topic to help you understand the effects of setting and changing portal and case options.
Note: The options described in this topic are grouped by category. The options in Ringtail appear in alphabetical order.
Only system administrators can access and change portal options. Portal options affect all cases in the portal or the portal itself. Some of the options described below may not be visible on the Portal options page.
To access portal options, from the Portal Home page, click Settings > Portal Options.
Update the options described in the following table to set or change the way that Ringtail operates in your environment.
Option |
Description |
Default |
Affected areas |
Content search service URL |
Set this to the URL where Ringtail can access the content search service. |
No default |
Content search, indexing |
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 organizations security |
Selecting this option enables security for the Organizations feature in Ringtail, 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 Ringtail Support for instructions on how to disable the option. |
Cleared |
Portal Management > Organizations |
Hit highlight service URL |
To improve performance, hit highlighting can now 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 Licensing Server |
The ingestion licensing server used by all cases in the portal. The ingestion server can share the name and location with the Ringtail analysis server. |
No default |
Ingestions |
Maximum security question attempts |
The maximum number of failed challenge question attempts before Ringtail locks a user account. |
5 |
Ringtail login |
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 |
Native Viewer WOPI URL |
URL to the Ringtail-specific implementation of the Web Application Open Platform Interface (WOPI). Set this URL to RingtailURL/Document, where RingtailURL is the URL of your Ringtail environment. |
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 Ringtail Mobile Binders app. The URL must be in the format of either https://servername/RingtailWebservices/ or http://servername/RingtailWebservices. |
No default |
Mobile Binders app |
What's New in Ringtail blurb |
Additional text to appear in the “What’s new in Ringtail” section on the Case and Portal home pages. You can add extra text to this section, which then appears under the "See the recent changes" link. |
No default |
Portal Home page |
What's New in Ringtail display |
If you select this option, the "What's new in Ringtail" section and the "See the recent changes" link appear on both the Case and Portal home pages. By default, the link takes you to a web page that provides an overview of the features for each release. |
Selected |
Portal Home page |
What's New in Ringtail URL |
Link to a web page describing new Ringtail features. |
Links by default to the version notes page on www.ftitechnology.com |
Portal Home page |
By default, the settings for the portal options described in the following table are optimized and should not need to be changed. Ringtail Support can advise if you need to set or change these values.
Option |
Description |
Default |
Agent 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 |
Agent 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. |
104,857,600 bytes |
Content search dtSearch timeout |
The maximum duration in seconds of the search server's content search request. |
600 seconds |
Content search request timeout |
The maximum duration in seconds of the search client's HTTP (Web) request. |
600 seconds |
Excluded extensions for text extraction |
For dtSearch test extraction, use this option to exclude file types that are not supported or can cause jobs to fail. |
tif, tiff |
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, in MB, that dtSearch can use during indexing. |
1024 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, in seconds, for the content search server time-out for Search Term Family processing. |
1800 seconds |
STF_content search request timeout |
Maximum duration, in seconds, for the content search server request time-out for Search Term Family processing. |
1800 seconds |
Ringtail 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
Portal administrators and portal users can access the options for the cases for which they are case administrators. Case options affect the case for which they are set. Some of the options described in the following sections may not be visible on the Case Options page.
To access the case options for a particular case, from the Portal Home page, click Cases and Servers > Cases > case name > Case Options.
Update the options described in the following table to set or change the way that Ringtail operates in your environment.
Option |
Description |
Default |
Affected areas |
Browse pane concepts document count limit |
Case administrators can use this value to limit the result set size in the Browse pane for Concepts and Selected Concepts. Limiting the result set size helps prevent concepts in the Browse pane from timing out. If a user opens a result set with more documents than the default, counts will not appear, and Ringtail displays a message indicating to reduce the number of results to view the counts. |
25,000 |
Browse pane |
Browse pane result set count threshold |
If your result set is greater than this value, the Browse pane displays ellipses instead of the item count. Note that increasing this value reduces the performance of the Browse feature and can cause timeouts and a heavy database load. |
70,000 |
Documents > List |
The maximum number of issues that can be added to a Code pane template. Use 0 to allow an unlimited number of issues to be added to the templates. See also Issue pane issue limit in this table. |
1,000 |
Documents > Code > Coding Template Administration |
|
Concept analyze all documents in case |
If enabled, automatically selects all new documents and performs concept analysis during indexing and enrichment. Also changes the appearance of the indexing and enrichment submission dialog by removing the ability to submit documents for concept analysis separately from indexing. Ringtail selects the option by default for new cases, but clears, or disables, the option for existing cases. Note that selection can increase time for indexing and enrichment jobs. |
Cleared for existing cases, selected for new cases |
Map |
Enable domain extraction |
If selected, administrators can browse the email domains and the email addresses of the people associated with each domain on the People and Organizations page in the Case Setup section, and search for documents by email domain using the Organization fields. The extracted domain is the portion of the People value starting at the first “@” character until the next character that is not a letter, number, period, or hyphen; or the next period or hyphen that immediately follows another period or hyphen. A domain must include at least one period and at least one letter. Ringtail removes leading or trailing periods and hyphens. |
Selected |
Coding |
Enable home page Concept Cloud tab for users with access to search concepts |
If selected, the Concept Cloud page on the Case Home page is available for any user with search concepts permission, as set on the Security > Features page. |
Cleared |
Case Home |
Enable Mobile Binders |
If selected, this feature allows administrators to create mobile binders to use with the Ringtail Mobile Binders feature. |
Cleared |
Binders |
Enable PDF redaction functionality for this case. You must also select the Enable PDF annotations portal option. If enabled, users can: ●Add redactions, highlights, and notes to PDFs, and print and export those PDFs. ●Create productions of annotated PDF files. ●Control the resolution of PDF page rendering. ●Use page level granularity, which means users are able to work on individual pages of multi-page single file documents. Important: Once you enable Enable PDF annotations for a case, do not disable it. |
Cleared |
Productions, Pages View |
|
The maximum number of subissues that can be expanded in the issue tree in the Code pane > Issues view. Use 0 to allow users to expand an unlimited number of subissues. See also Coding template issue limit in this table. |
1000 issues 0 = unlimited |
Documents > Code > Issues |
|
OCR documents without content files |
If selected, documents that do not have content files or that are identified as non-searchable PDFs during ingestion are automatically submitted for optical character recognition (OCR) processing during indexing and enrichment. The OCR processing uses the default OCR settings. Note: Documents are scanned for the English language only. |
Cleared |
Index |
Production default native field |
One-to-one field that contains the file extension detail of the file to be considered the native file for productions and in the document native view. |
none |
Productions, Native view |
Production placeholder font size |
Size of the production placeholder font. |
20 |
Productions |
Production placeholder letter type |
Determines printed letter size for placeholders. Ringtail supports U.S. Letter and A4 values. |
US Letter |
Productions |
Results-based document content |
Select to use “pre-fetching” of extracted HTML to accelerate document content viewing. |
Cleared |
Documents > View |
Social Network feature switch |
Encrypted password that turns on the Ringtail Social Network feature, allowing the feature to be demonstrated. |
No default |
Social Network |
Super notes user switch |
When selected, allows group leaders to edit other users’ notes. |
Selected |
Documents > View |
Suppress view of embedded content on MHT |
When viewing Outlook mail messages, embedded content can appear as encoded data. Select this option if you do not want to view this type of content. |
True |
Documents > View |
Timeline document count threshold |
The maximum number of documents in a results set that Ringtail loads in the Timeline pane. |
50,000 documents |
Documents > View > Timeline |
Use Media Player for IE users |
To improve performance when using Internet Explorer, all audio and video files now automatically play in Windows Media Player. To disable this feature for a case, clear the check box. |
Selected |
Documents > View > Image viewer |
Use private notes |
Allow users to make private notes. Notes can be made in PDF and image files. Only administrators can view private notes. |
Selected |
Documents > View > Image viewer |
What’s New in Ringtail display |
Enable the "What's New in Ringtail" section on the Case Site Map page. |
Selected |
Case Home |
By default, the settings for the case options in the following table are optimized for most cases and should not need to be changed. Ringtail Support can advise if you need to set or change these values.
Option |
Description |
Default |
Cache types list |
Enable your browser to cache documents with these extensions for viewing. To not cache any documents, set the value to NONE. |
doc;xls;ppt;pps;rtf;docx;xlsx;pptx;mpa;odt;vsd |
Content HTML cache length |
The size of the cached content to keep for each document. This content is loaded immediately when a user clicks to load a document. Any content beyond the set length will render as the user scrolls through the document. |
60,000 bytes per documents |
Content HTML cache life |
The number of days from when a document is loaded or last viewed that Ringtail keeps the cached HTML rendering of the document. Cached HTML content increases performance when viewing documents. Values of 1,000 or higher keep the content cached indefinitely. |
1,000 for new documents 180 for existing documents |
Content HTML cache limit |
Maximum number of documents in the cache. |
3,000,000 documents |
Content HTML maximum length |
The maximum length of HTML to display when viewing document content. Any HTML beyond the set length does not appear when viewing documents. When the loaded content exceeds this size, the user sees a message asking them to download the document. |
10,000,000 bytes per document |
Content view prefetch |
The number of documents to pre-load in Formatted content and Unformatted content view in the View pane. |
2 documents |
Download formatted content size limit in bytes |
The maximum file size, in bytes, that renders when a document with hit highlighting opens in the View pane. This is the size of the rendered formatted content, not the underlying native file. Sometimes the rendered content is much larger than the native file. If there are no hits to highlight, this limit does not apply. If the rendered content (including hit highlighting) exceeds this limit, a message indicates that the file cannot be opened. |
10485769 bytes (10 MB) |
Enable HTTP compression |
Enable HTTP compression to provide faster transmission times between IIS and client browsers that can accept compressed files. |
Selected |
Enforce SSL security |
When selected, does not allow native files to cache. This feature prevents the native application from creating a temporary file, which may then be accessible to a non-authorized person. File types in the Cache types list appear as HTML rather than opening in their native application. |
Selected |
File size for update batch size |
This value defines the batch size in pages for RPF-driven updates to the file_size field for pages of a document. |
1,000 pages |
File size in bytes limit |
The maximum file size, in bytes, that renders when a document opens in the View pane. When a document exceeds the maximum file size, users can click a button to continue rendering the file. A message indicates that the file can take a while to load. |
3,145,278 bytes |
Imaging document timeout |
The length of time, in seconds, before a document being converted into an image times out |
300 seconds |
Ingestion large file type maximum sizes |
The maximum size of each file type that should be included in an ingestion. Files over the designated size generate a warning when calculating the file size for a folder. You can still submit the files for processing. The format for this setting is: extension,size in GB; Note that each setting is separated by a semicolon. Use an asterisk as the extension to define the maximum size for all extensions not specifically listed. |
*,5;PST,6;RAR,3 |
Load search file size limit |
The maximum size, in KB, of files you can load using the Load search file tool. |
4,096 KB (4 MB) |
Map page default size |
Default number of documents per page to display in the Map pane. |
2,500 document |
Map page maximum size |
Maximum number of documents per page to display in the Map pane. |
10,000 documents |
Predict job batch size |
Determines the number of documents placed in a batch to extract, score, or tokenize for training. |
5,000 |
Stopped concept RPF threshold |
The maximum number of documents to process before recalculating the stopped concepts. The next time an Indexing and enrichment job runs, the job updates the document counts for concepts to respect stopped concepts. This improves results for find similar searches. Going forward, when concepts are stopped, the counts are recalculated. For prevalent concepts, stopping a concept triggers a Concept analysis RPF job to recalculate the counts. The threshold for how prevalent a concept is to trigger a job is controlled by this option. |
2500 |
Threading analysis batch size |
Batch size used for the analysis stage of Thread Analysis jobs. |
10,000 |
Threading extraction batch size |
Batch size used for the body text extraction stage of Thread Analysis jobs. |
1000 |
Timeline default field ID |
The timeline histogram default Date field. Defaults to 102, the Document Date field ID. |
102 |
Use Assigned Family Hash rules |
Important: Although this case option is available, it is disabled by default. In most scenarios, we recommend leaving this case option disabled. Before enabling this option, carefully consider the following changes that will occur. If the case option is enabled, the following applies the first time a hash job is run: ●The Use Assigned Family Hash rules case option is no longer available to update. ●For any documents that received a family hash value from a previous run through the hash process, Ringtail removes any calculated family hash values, ●As a result, the only documents with family hash are those for which a user provided the family hash using Import mapping. These values will remain and be used. ●For all other documents, including those that had values removed, the hash process uses the individual hash value of the top-parent document in the family as the family hash for all documents in the family. |
Cleared |
Ringtail architects use the options in the following table for troubleshooting and debugging issues. Do not change these options unless advised by Ringtail Support.
Option |
Description |
Default |
Analysis server is configured |
This value is set to true if an analysis server has been set up for a case. |
1 (True) if there is an analysis server for the case |
Modify workflow assignments database command timeout |
The database command time-out allowed when adding documents to or removing documents from a workflow, or when rebuilding a phase. |
1,200 seconds |
Predict job classifier logging enabled |
Enables classifier output to be sent to Predict RPF task output. Used for debugging and troubleshooting. |
False |
Predict job keep classifier output |
Preserves classifier output files generated by Predict RPF tasks. Used for debugging to view outputs from predict. |
False |
Threading performance logging enabled |
Set to “True” to enable threading worker performance measurement output to be sent to Threading RPF task output. |
False |
Ringtail developers use the following options for product testing and troubleshooting. If the options are visible on the Case Options page for your cases, do not change their values.
●Cubes administration module upgraded
●Enable view pane
●Enable prototype feature