Case Collation

• Updated on May 14, 2025

• Published on Oct 10, 2024

• 3 minute(s) read

Accessing this feature
Your access to the feature described in this article depends on your license package and pricing plan.
To learn which features are available to your organization and how to add more, contact your Hyperscience representative.

Case Collation allows you to group submitted files, documents, and pages into cases, using a unique identifier called a Case ID. There are two ways to assign a Case ID:

• During submissions upload - You have the option to add a submission to an existing case or create a new case.
  • Add to an existing case - Select an existing case from the drop-down menu.
  • Create a new case - Input your own Case ID or let Hyperscience generate a unique Case ID. Hyperscience-generated Case IDs always start with the prefix HS-.
• With a Custom Code Block - You can associate files, pages, or documents with Case IDs via the “Cases” array in the submission’s JSON object. Note that in order to persist these changes to a database, you must include a Machine Collation block downstream of the Custom Code Block. To learn more about Custom Code Blocks, see Flow Blocks.

Viewing Cases

To view information about all of the cases in Hyperscience, go to the Cases Table by clicking on Submissions > Cases.

Filters

You can narrow down your view by applying date filters. There are two date filters you can apply:

• Filter by creation date - the filter is located between the Filters drop-down menu and the search bar.
• Filter by last updated date - the filter is located in the Filters drop-down menu.

Search

Items shown on the Cases page can be searched by Submission ID, Case ID, and file name. Searches can be performed by typing an ID or a file name in the Search by ID or file name search bar and hitting the Enter or Return key.

Some notes regarding this functionality:

• The search will only return exact matches on ID values; partial matching is not supported.
• The search is case-sensitive.
• The search bar can be cleared by clicking the X on the right side of the bar. Doing so will refresh the current tab to show all tasks.

Cases Table

The following columns appear in the Cases table:

• Case ID - Shows the case’s unique ID.
• Documents - Shows the number of documents within the case.
• Date created - Shows the case’s creation date.
• Date last updated - Shows when the case was last modified.
• Tasks - If the case has pending tasks, there is a Perform Tasks button.

Case Details Page

To access the Case Details page, click on a Case ID in the Cases table. The Case Details page is divided into the following sections:

• Pending tasks - If there are any pending tasks, they will be displayed at the top of the Case Details page. To perform the tasks, click on the Perform Tasks button.
• Case Summary
  • Info - Displays information about when the case was created and when it was last updated.
  • Notes - You can add notes for the case. The notes can then be saved with the case.
  • Stats - the following stats are available for a case:
    • Complete Documents - The number of documents that have already been successfully processed.
    • Complete Data Fields - The number of data fields that have already been successfully processed.
    • Required Fields Missing / NIGO (Not In Good Order) Fields - The number of data fields that have either been:
      • marked as “illegible,” or
      • configured as required in the layout, but are blank in the document.
    • Unmatched Pages - The number of pages that have not been yet matched to a layout.
• Documents - A list of all documents and their respective layout variations.
• Unmatched Pages - A list of all pages that have not been yet matched to a layout.
• Data - A list of all data fields and their values extracted from the documents. Note that each data field has a Status that is determined according to the following rules:

| Field Status | Rules | | Illegible | Fields have a status of Illegible if they have the following field exception:
- Illegible Field | | Required Field Missing | Fields have a status of Required Field Missing if they have the following field exception:
- Required Field Missing | | Completed with Exceptions | Fields have a Completed with Exceptions status if they have completed processing and have one or more of the following exceptions:
- Consensus Field Autotranscribed

- Validation Override

- Normalization Error

- Supervision Always Field Autotranscribed

- Supervision Always Field Autoidentified

- Supervision Required But Disabled

- Character Limit Reached | | Completed | Fields have a Completed status if they have received a value and have no field exceptions. | | Non-Required Field Missing | Fields have a Non-Required Field Missing status if they are blank, have finished processing, and are not marked as required in the Layout. Note that fields that are blank, aren’t required by the Layout, and have a field exception other than Illegible Field will have a status of Completed With Exceptions. | | Manual Identification/Manual Transcription/Manual Classification | Fields requiring Supervision have a status indicating which type of Supervision is needed.