Reveal 2024.11 Release Notes
  • 06 Dec 2024
  • 23 Minutes to read
  • Dark
    Light
  • PDF

Reveal 2024.11 Release Notes

  • Dark
    Light
  • PDF

Article summary

Release Dates: 12/3/2024 - 12/5/2024

Key Feature Highlights

Video Demonstration Walkthrough

Watch our video demonstration to explore highlights and updates, showcasing the most notable features from the 2024.11 release.


*Disclaimer: Please be advised that certain features shown in this video may not be immediately available in the upcoming release.


Hands-On Learning Simulations

Reveal is excited to introduce Simulated Learning Tutorials, designed to help you master the latest features in the 2024.11 release. These interactive tutorials provide a hands-on, step-by-step learning experience to guide you through key functionalities. Click here to start exploring and learn more about what's new in the 2024.11 release!


Overview of Key Features

Review Management Updates

  • Centralized Project Creation:

    • The ability to create new projects and Review cases has been removed from both the Review Manager and Discovery Manager tools. All new projects and Review cases must now be created via the web interface, streamlining workflows and ensuring consistency across the platform.

    • Users attempting to create a project in Review Manager will see a dialog informing them of this change, after which all options in the "New Project" tab will be disabled. Similarly, the option to create new Review cases in Discovery Manager has been removed, leaving users with the ability only to associate or remove existing Review cases.

  • Company Admin Moved: The Company Admin button has been removed from three locations in the user interface: the project selection screen, the navigation sidebar in the home screen grid, and the project administration fly-out menu. These changes will aid in improving the overall navigation for users.

  • Bulk Printing from PDFs: The print workflow now defaults to PDF as the source, replacing the previous image default. Both PDF and image will remain available, but image support will be phased out in future versions. PDFs are recommended for faster bulk printing. While the overall workflow remains largely the same, this change should result in quicker production times, making PDFs the optimal choice for printing.

Increased Visibility for Classifier Scoring

  • The Scoring and Tagging sections on the Supervised Learning page now include detailed status reporting, accessible via the Status label in card or table view and in the Tagging & Scoring Report.

  • A new "Last Round" indicator shows the most recent classification round and provides syncing details between the Review and Elastic databases, including the last time tags and scores were synced, the round the scores were synced from, and when scores were last calculated.

  • These updates offer users a clearer understanding of syncing timelines and classifier performance from the Grid, improving visibility into the classification process.

Ask Citations Feature

  • The Ask Citations feature simplifies response verification by providing document-based citations displayed as organized cards in a vertical list. Users can navigate easily with numbered references and view highlights within citations for added clarity.

  • Initially available in the US and EU, this feature will expand to other regions in future releases, broadening its accessibility.

  • To enhance usability, the Sources section has been refined by removing unnecessary entries, and detailed guidance is available in the Help section.

Processing Enhancements

  • Loading Unprocessed Data: Loading unprocessed data allows users to create processing projects and view project settings and upload history. Related pages in the UI are now accessible, as these features were previously behind a feature flag, but is now available in the 2024.11 release.

  • Aspose Email Processing: The Aspose library changes how email processing, including data extraction and conversion, is handled. New projects will default to Aspose, while older data will continue using the previous engine. This was previously behind a feature flag but is now generally available in the 2024.11 release.

  • Reveal Processing Release Notes: For the full list of SaaS updates and fixes, please refer to the Processing 2024.11 Release Notes published in the knowledge base for Discovery Manager.

Performance Improvements with AI Pipeline

  • New projects created in 2024.11 benefit from significantly reduced AI pipeline build times, enabled by optimized vector creation and default utilization of S3-based storage for persistent data.

  • Multithreading has been implemented for Emotional Intelligence scoring, enabling concurrent data processing for faster execution. For new datasets, configuration flags are automatically enabled to optimize data processing and storage. This improvement ensures a more efficient setup process and enhances overall scoring performance.

Data Loading Enhancements

  • Streamlined Updates: Users can upload files up to 30 GB in size, with support for multiple delimiters including concordance, pipe, and caret, to update existing document fields efficiently.

  • Advanced Processing: Overlay files are pushed to S3 for replacement, documents are reindexed post-update, and AI syncing is triggered for analytics fields or text sets to ensure seamless integration with Review.

  • Copy Project Settings: Users can now copy common project-level configurations—including tags, tag profiles, fields, field profiles, work folders, redaction profiles, highlight lists, hit reports, and saved search folders—directly from the Project Admin area. With added search functionality for project names, this streamlined workflow enhances usability and eliminates the need for load machine access, improving efficiency in project setup and configuration.


Release Details Table

Outlines additional features, updates, and fixes, supplementing the overview above.

Type

Category

Description

New

Document Review

Users now have enhanced control over matching options in single-document and wordlist search highlights, with the ability to choose between whole-word or partial matching. In the Edit Search modals for in-document and wordlist searches (accessible via the pencil icon in the Document Explorer), a new "Whole Word" checkbox has been added under Options.

New

Index Jobs

Previously, Native View Indexing required manual initiation by the Review Manager. Now, Native View Indexing automatically begins for all unindexed or errored documents immediately after AI Synch starts. This ensures that Native View indexing runs in parallel with document ingestion for analysis and overlays, saving time with the processing workflow.

New

Processing User Role

As part of the Discovery Manager to Web initiative, a new user role called Processing User has been introduced. This role is designed for users who will only have access to the Processing tab/features on the platform and will not have access to any review functionality. The Processing User role is essential for managing data processing tasks without granting access to the review features.

New

Project Admin

Users can now easily copy common project-level configuration items, including tags, tag profiles, fields, field profiles, work folders, redaction profiles, highlight lists, and hit reports, directly from the Project Admin area on the web. Previously, this function was only available in the Review Manager desktop tool, but now no load machine access is needed.

New

Reports

A new report feature has been added for administrative users to track documents tagged with specific tag profiles within a given time period. Users can specify a Start Date and End Date, select one or more tag profiles, and generate a report displaying tagged documents. The report includes the following fields: User, Teams, Item ID, Begin Number, Tag Profile, Tag, Choice, Action Type, and Date. Additionally, the report can be exported to Excel or PDF.

New

Transcription

This is a new field called Audio/Video Duration (Seconds) that will contain the length of the media file type. This value for this field is generated when we run the Native View indexing so media files that are processed in the Discovery Manager or imported via a load file into Review should have this field populated as long as the Native View index has been run.

Update

Action Log

The system-level admin action log now records entries whenever a project is activated or deactivated, capturing the user who performed the action and the time of the event.

Update

Ask

The viewport of the Ask window has been increased, leading to a bigger default window when launching Ask.

Update

Ask

Updates have been made to the Ask response pane. When scrolling through the Ask window, citations stay within view. This maximizes the amount of response and citation content that a user can see.

Update

Assignments

A new update ensures that the username of a user who worked on a batch remains visible in the Manage Batches list even after the batch is marked as complete. This enables administrators to identify and export all batches worked on by a specific individual.

Update

Company Admin

The Company Admin button has been removed from three locations in the user interface: the project selection screen, the navigation sidebar in the home screen grid, and the project administration fly-out menu. These changes will aid in improving the overall navigation for users.

Update

Company Admin

To improve workflow efficiency for frequent project creators, a new Create Project button has been added to both the home page project list and the projects page. These additional buttons make the project creation process easier, reducing the need for extra navigation. Now, clicking any of these Create Project buttons will directly open the Create Project modal, allowing users to initiate new projects quickly and with fewer steps.

Update

Company Admin

This update introduces enhanced filtering capabilities for system administrators when viewing system-level setting changes. Administrators can now filter the activity log by specific date/time ranges, activity categories (such as "System Setting Changed" or "User Access Changed"), and usernames. These new filters provide greater flexibility and ease in tracking and reviewing changes made within the MSA, helping administrators to more efficiently monitor system-level activity.

Update

Company Admin

The company admin buttons have been removed from the Reveal UI. Users logged in as instance administrators will no longer see these buttons, improving the user interface for a better experience.

Update

Document Grid

Enhanced Grid View performance by implementing row virtualization, allowing efficient loading of large datasets while displaying only a subset of rows at a time. As you scroll, rows are dynamically drawn for a smoother experience.

Update

Document Review

Users can now adjust the Document Explorer's width, like they can do in other areas of the platform.

Update

Document Review

Users will no longer see the Native HTML and Text Views icon in the classic document viewer. If a user had previously set their default view to the now-hidden Native HTML, they will be automatically redirected to the corresponding Native view. Additionally, any references to the Native/HTML view will be removed from the settings, including in the default view drop-down, the Text View Display Order list, and the Text/HTML option in the Text Set Display.

Update

Document Review

The Default Imaging Template has been updated to ensure that all hidden content and comments are exposed for Word, Excel, PowerPoint, and PDF documents. This update aligns the new PDF Native view with the legacy Native/HTML view, ensuring that hidden elements such as Word's hidden text, Excel's auto-sized rows and columns, and PowerPoint's hidden slides are now displayed by default.

Update

Document Viewer

For the Native and Spreadsheet views, the text set limitation has now been increased from 16MB to 500MB, this can be configured in Review Manager. Users can select one of these text sets, go to the "Modify Text Sets" options, and increase values for the indexing limits.

Update

Index Job

Added an Errors column to the Jobs > Indexes screen, displaying the number of errors associated with each index job.

Update

Index Job

Improved indexing process by enforcing a structured order when indexing multiple views and text sets in a single pass. Metadata is now prioritized first, followed by text-based views (OCR, Extracted, Transcription), and finally native views (PDF, Spreadsheet, Native/HTML). This optimized sequence ensures faster access to the system while waiting for larger views to complete indexing.

Update

Project Creation

When creating a project, users are able to specify the time zone from the dropdown. Updates have been made to ensure the choices are displayed in the format of [offset, location, time zone].

Update

Redaction

The "Exolution Redaction Type" and "Exolution Redaction List" fields are now set as multi-value fields. This allows users to view and filter the values in a list when using the grid or advanced search.

Update

Translation

In the Jobs > Translate page, a field named "Translated Characters" is now shown, which lists the number of characters translated from a job. This information can assist with billing-related processes, as the translated character count may impact billing.

Fix

AI Review Enhancer

The "Ask" window was sometimes trapped under the global search bar, making it impossible to move or resize the window. Now, users will be able to move and resize the window without obstruction from the global search bar.

Fix

AI Review Enhancer

Previously, when there was no valid citation for an Answer component (i.e., no footnote number displayed), the text appeared without any space between sentences, making it appear as a single, unbroken sentence. This issue has now been resolved. When the footnote number is missing, there is at least a space between sentences. Alternatively, an indicator (such as placeholder text or a symbol) has been added to clearly show that no citation is available for the answer.

Fix

AI Review Enhancer

Previously, when attempting to open the Translations job list page for a project, no translation jobs appeared. The jobs table did not finish loading, and the main frame remained blank. Now, the user is able to successfully navigate to the Translate jobs page. The page displays a list of all translation jobs that have been submitted.

Fix

Analytics

A production issue in Analytics logs is causing Out of Memory (OOM) errors during text partitioning, particularly with gibberish or whitespace-heavy documents. The fix involves adjusting tokenization for unknown languages, skipping non-English text when processing only English, and stopping partitioning once the maximum limit is reached.

Fix

Ask

An issue where a user reported experiencing an "infinite spinner" when submitting a specific query in Ask. The logs indicate that the API returns a 400 error immediately, rather than a 500 error, which would typically show an error message to the user. Recent updates have resolved the issue by preventing the submission of multiple queries at once, eliminating the infinite spinner when a 400 error occurs.

Fix

Bulk Update

An issue where during bulk tagging jobs, the timeout for retrieving related documents needs to be increased, and additional indexes to be added to the import_documents table to prevent errors encountered in production.

Fix

Data Visualizations

An issue with widget loading behavior on the Dashboard has been identified, where multiple widgets display a "Loading…" status during pagination. This occurs when one widget is paginated, causing 3-4 other widgets to briefly refresh. While the number of API calls remains correct, the visual effect of loading icons appearing twice is a result of the sequential nature of API calls for the top items and their corresponding values.

Fix

Data Visualizations

The layout of detail pages is being improperly displayed on smaller screen sizes, resulting in cut-off content and poor spacing. This affects multiple pages, including project overviews and user profiles.

Fix

Data Visualizations

It involves a inconsistency between the project count displayed on the Company Overview page and the actual list of projects on the Projects page. Specifically, deleted projects were incorrectly counted on the Company Overview page, leading to inconsistency in the project data presented to users.

Fix

Data Visualizations

An issue where long values in a custom list field were truncated in the grid view, highlighting the need for improvements in data management across multiple projects.

Fix

Document Review

Previously, AV Transcriptions were loading with an error message: "Error Loading Document" in the DAT environments. Now,the issue has been resolved and AV transcriptions load without issues

Fix

Document Review

Previously, form value data, which is part of the original documents, was incorrectly appearing as annotations in the document viewer. Users could modify these values (like removing or changing styles), but these changes would not be saved and would revert once the page was reloaded. Now, the form value data from the original documents no longer appears as annotations in the document viewer. All form values and data have been flattened, ensuring that users can no longer interact with or modify these values.

Fix

Document Review

Previously, the verbiage for the Bulk Printing options was unclear for end users. The labels for single and multiple document PDF exports were not descriptive enough, leading to confusion about what each option would do. Now, the labels for the Bulk Printing options have been updated to be more informative and clear.

Fix

Document Review

An error was identified when users selected "Confidence Level" after choosing "Random" in the Assign dropdown within the Grid view. This action previously triggered an error, interrupting the assignment process. Selecting "Confidence Level" within the Grid view’s Assign menu no longer results in an error. The process now completes successfully, allowing users to set confidence levels without interruption.

Fix

Document Review

An issue where AV transcription jobs would successfully process and index but fail to update load file paths in IMPORT_DOCUMENTS or save transcription text sets for viewing in the new document viewer. Although transcription and indexing processes completed, users can not view the transcription text in the new viewer because only paths for video and transcription were returned by the backend, with no transcription content displayed.

Fix

Document Review

An issue where the default view for audio or video files would inconsistently change between the first and subsequent documents has been resolved. Initially, the AV (audio/video) view opened by default, but navigating to the next document caused the system to attempt loading a Native PDF view, which does not exist for AV files. Verified on the QA environment and no longer this issue is reproducible. The AV view remains consistent when navigating between AV documents.

Fix

Document Review

An issue where the download button was absent in the React AV player's toolbar, preventing users from downloading AV files directly from the player interface has been addressed. For transcribed files, the download list now includes both the original native file (Opus format) and the converted WebM file.

Fix

Document Review

An issue in the assignment module where assignment batches were visible to teams other than the one they were assigned to has been addressed. When an assignment is allocated to a specific team, only that team should see it in the "Manage Batch" window. Visibility settings have been adjusted so that only the assigned team has access to their specific batches. Other teams cannot see batches that are not assigned to them.

Fix

Document Review

Previously, only the creator of a text annotation could modify its content or size, while other users could only change the styling. This has been updated so that all users with the “Annotate” permission can now fully edit text annotations, including modifying text and adjusting size, regardless of the original creator.

Fix

Document Review

Updated the Redact Search Results window to default to "All pages" in the Pages selection, streamlining the redaction process based on user feedback.

Fix

Document Review

An issue of displaying a preview when selecting the Imports and Document Folder Field is not functioning correctly. The preview only appears under specific circumstances (when "Delete all existing folders" is checked), indicating a problem in the logic or implementation of the preview feature.

Fix

Document Review

The issue where users were unable to create a template from the assignment job grid has been resolved. Previously, clicking the "+" sign would redirect users to the user selection page, preventing template submission. This functionality is now working correctly, allowing users to create and submit templates from the assignment jobs modal.

Fix

Document Review

The sortable list feature is experiencing a bug where selected items lose their selection state after being moved, which affects user interaction and usability. Users expect to see their recently moved items remain selected for easier adjustments.

Fix

Document Review

The tooltip for the “style annotation” button in the toolbar is missing and should be updated to read "Style Annotation" to ensure consistency with the in-context button.

Fix

Document Review

The tooltip on the annotation tool incorrectly states "Highlighter" instead of "Annotate," which should be updated for consistency with other action-based labels like Redact, Select, and Print.

Fix

Document Review

When the viewer is loaded, the initial zoom level displayed is incorrect. The viewer starts at 100%, but it should reflect a zoom level of 210%, which is the expected default when the document is set to "Zoom to Fit." Toggling the document explorer updates the zoom level accurately, but the initial display in the dropdown does not align with the actual view, leading to confusion for users.

Fix

Document Review

An issue where documents are failing to promote to Review after being exported via the Review (Append) export process. This is causing a halt in the workflow, preventing the documents from being available for review or for any subsequent post-promotion steps. The failure to promote is disrupting the document processing cycle.

Fix

Document Review

Resolved an issue where toggling the "Ignore Required Tags" checkbox in the Coding panel settings modal caused the Review page to freeze in the Classic Document Viewer. Users can now toggle the checkbox and submit changes without issues. When enabled, required tag warnings are bypassed; when disabled, users are alerted to complete required tags.

Fix

Installation & Maintenance

This update addresses a regression between Brainspace versions 2024.9 and 2024.11 regarding the handling of API responses during application startup. Previously, when the Brainspace application was coming online and datasets were still being added, client requests for dataset information resulted in a 404 error. The application will now correctly return HTTP status code 503 errors from the dataset services (DatasetResource) during the period when dataset services are still being initialized (DatasetManagerImpl).

Fix

Processing Job Status

A fix was implemented to ensure the job status, percent complete, and modified fields are correctly updated for all copy project settings jobs. Jobs now transition through appropriate statuses (Created, InProcess, and Complete or Error) with Percent_Complete set to 100 upon completion, and the Modified_by_user and Modified_Date fields properly populated.

Fix

Processing OCR

A fix was applied to resolve the intermittent failure of OCR jobs, ensuring jobs now progress as expected. This issue was mitigated by addressing potential conflicts when canceling a prior OCR job and immediately starting a new one.

Fix

Production & Export

An issue when users select “Single Page” as the export type for a PDF production job, the process takes an extremely long time to complete, especially for documents with a large number of pages.This is due to tasks sent to the imaging service not being chunked according to the system setting "TaskQueueImagingPageBatchSize", which is causing large documents to significantly slow down the export job.

Fix

Production & Export

Previously, production jobs using existing numbers encountered a NULL exception error when attempting to assign numbers to original images that did not have a previous number assigned in the image_annotations table. This occurred if the images were loaded without numbers or were not included in a production that assigned numbers. Now, the stored procedure has been updated to properly handle NULL values, ensuring that production jobs can complete successfully even when original images lack prior numbering.

Fix

Production & Export

The error "Sequence contains no matching element" appeared in Brainspace's integrated metadata indexing, specifically with extremely large projects exceeding 1 million documents. This issue was identified in non-standard test datasets, outside of the typical scope of our current testing due to its limited occurrence and the specific nature of the customer environment.

Fix

Project Admin

This bug fix resolves an issue where fields become disabled after using the "Clear All" action in the file upload process, preventing users from manually mapping fields. The fields will no longer be disabled after clicking "Clear All." Users will retain the ability to manually map fields from the dropdown even after clearing the existing mappings.

Fix

Project Admin

The Auto Detect, Pipe, and Caret options are hidden and that the Concordance delimiter is set as the default. This update simplifies the delimiter options by temporarily hiding these delimiter choices to simplify the user interface. The changes are implemented to simplify the scope and focus on the primary use cases, with the intention to reintroduce the hidden delimiter options at a later date.

Fix

Project Admin

During the upload progress, previously uploaded files appear along with the new file after saving the modal, which can caused confusion. Now, only the files being uploaded will be shown in the "upload in progress" status.

Fix

Project Admin

An issue where users were not receiving an error message when the BEGDOC or other required data categories were missing during field mapping validation. Now, when Begin Number (BEGDOC) or other required fields are not mapped, a clear error message will appear in the Preview Modal. The message will indicate that the Begin Number was not assigned in this field mapping and specify that it is a required field.

Fix

Project Admin

Previosuly, when users attempted to upload a load file, the upload job was not being saved after they click Submit. This issue occurred despite clearing the cache. Now, it has been resolved and the upload job is successfully saved upon clicking the Submit button as excepted.

Fix

Project Admin

An issue, involving a document loader load file job failing without an error entry in the database. This meaning, that while the upload job shows as "Error" in the UI, no error record is being added to the DOCUMENT LOADER JOB. The issue has been resolved, as the file was successfully uploaded and processed after the delimiters that were missing got added.

Fix

Project Admin

When a batch was marked as complete, the username of the user who performed the action was not displayed in the User column within the Assignments Modal. Now, the username remains visible in the User field after the batch is checked in and marked as complete.

Fix

Project Admin

Previously, the document/{itemid}/files endpoint for audio-visual (AV) files only returned a single text set. This limitation meant that if there were additional text sets such as transcriptions or translated text, they were not visible or accessible through the endpoint. Now, the endpoint has been updated to return multiple text sets for AV files.

Fix

Project Admin

Previously, when a user set a field as "Updatable" from the "Manage Fields" section in Project Admin, the corresponding field profile could not be deleted. Attempting to delete the field profile would result in an error message: "Failed to Delete the Field Profile." This issue has been resolved. Field profiles can now be successfully deleted, even after fields have been marked as "Updatable."

Fix

Project Admin

A bug was identified when attempting to change permissions for both a main folder and its sub-folder simultaneously. While the permissions for the main folder are successfully updated, the changes do not propagate to the sub-folder, which retains its previous permissions. The issue has been resolved to ensure that selecting the "Apply Permissions to Sub-Folders" checkbox will successfully apply the new permissions to both the main folder and all sub-folders.

Fix

Project Admin

Previously, when creating a Field Profile and modifying a field to have a custom display name, the profile becomes undeletable. Now, admin is able to delete a Field Profile even if it has custom field display names

Fix

Project Admin

When a user attempts to create a new project using the "Create Project" feature within the Company Admin → Companies → Projects page, they encounter a generic error message if they try to use a project name that already exists. This error message fails to provide specific information about the issue, leaving the user unclear on how to proceed.

Fix

Project Admin

Previously, when converting non-HTML documents to native view during indexing with Aspose, any external links within the document (e.g., linked images) caused delays due to Aspose attempting to load these links. This was particularly problematic for broken or non-existent network paths, leading to unnecessary network latency. Now, external link loading is disabled for non-HTML documents during native view PDF generation. This prevents Aspose from attempting to retrieve externally linked resources, resulting in faster and more reliable indexing and conversion processes.

Fix

Search and Filter

Previously, folder counts were not properly updating when applying a keyword search and tag filter. Now, this issue has been resolved and counts properly match the contents displayed in the grid search when applying both keyword search and tag filter.

Fix

Search and Filter

The issue is that the regex expressions for US phone numbers were not functioning correctly when added to a wordlist, resulting in console errors and no hits. The resolution of this issue signifies a correction to existing functionality when US phone numbers added to a wordlist.

Fix

Search and Filter

A date range search on documents was failing to include child documents when applying the Families expander, resulting in incomplete search results. This issue has been resolved, ensuring that all relevant documents, including child documents, are returned in both singular and grouped queries.

Fix

Search and Filter

When a user closes the advanced search by clicking the advanced search button, an unnecessary prompt appears asking to discard changes, even if no changes were made. This behavior is inconsistent since clicking outside the advanced search does not trigger the prompt.

Fix

Supervised Learning

Previously, when a user clicks on the "Edit Classifier" icon, the screen continues to load indefinitely without displaying the expected editing interface. Now, it has been resolved the user is directed to the editing interface without any loading issues.

Fix

Supervised Learning

Previously, a "Missing Translation" error was displayed within the classifier card and details page before the classifier reached the "Ready" status. This issue has been resolved. Now, the error no longer displays within the classifier card or details page.

Fix

Supervised Learning

Previously, when attempting to edit the classifier settings, the UI redirects to an incorrect path, preventing successful modification. Now, upon editing the classifier, the URL reflect the correct classifier ID to edit settings.

Fix

Transcription

Previously, clicking a timestamp in the transcript did not cause the audio to jump to the corresponding time and the highlighted text in the transcript did not update in sync with the audio playback. Now, it has been resolved and the audio playhead now moves correctly when clicking on a timestamp. Also, the transcript's highlighted section updates dynamically in sync with the audio playback.

Fix

Transcription

The Hungarian language option is supposed to be available for document transcription per documentation, but it is currently not accessible in the Transcribe Documents modal. An update has been and now it should be displayed.


ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence