Cases

A Case groups related files, documents, or pages under one unique Case ID. Case collation is the process of creating or updating this group.

A Case is useful when multiple submissions belong to the same business item, such as a loan application or an insurance claim. It gives you one place to follow processing, review the collected documents and data, and find work that still needs attention.

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.

How cases are created

The Machine Collation Block creates or updates cases. It receives case information and groups the specified files, documents, or pages under the correct Case ID.

Source	What happens
Submission upload or API request	Add the uploaded files to an existing case, or create a new case. In the standard Document Processing Subflow, the Submission Bootstrap Block passes this case information to the Machine Collation Block. Machine Collation then creates or updates the case. For a new case, enter a unique Case ID or leave the field empty. If you leave it empty, Hyperscience generates an ID that starts with HS-.
Custom grouping logic	An upstream block, such as a Custom Code Block or Python Block, can prepare the case information when you need custom grouping rules. The Machine Collation Block still creates or updates the case. If a Custom Supervision template uses the Add to case component, place the Machine Collation Block after the Custom Supervision Block. Pass the case information from Custom Supervision to Machine Collation. The task records the user’s choice, and Machine Collation adds the selected content to the case. For block inputs and settings, see Flow Blocks.

Source

What happens

Submission upload or API request

Add the uploaded files to an existing case, or create a new case.

In the standard Document Processing Subflow, the Submission Bootstrap Block passes this case information to the Machine Collation Block.
Machine Collation then creates or updates the case. For a new case, enter a unique Case ID or leave the field empty.
- If you leave it empty, Hyperscience generates an ID that starts with HS-.

Custom grouping logic

An upstream block, such as a Custom Code Block or Python Block, can prepare the case information when you need custom grouping rules. The Machine Collation Block still creates or updates the case. If a Custom Supervision template uses the Add to case component, place the Machine Collation Block after the Custom Supervision Block. Pass the case information from Custom Supervision to Machine Collation. The task records the user’s choice, and Machine Collation adds the selected content to the case. For block inputs and settings, see Flow Blocks.

Required permissions

The pages and actions described in this article require the following permissions:

Permission	Allows you to	Assigned by default to
View Cases	Open the Cases page and Case Details pages	System Admin, Business Admin, and Knowledge Worker
Delete Cases	Delete cases, remove documents or pages from a case, and edit case deletion dates	System Admin, Business Admin, and Knowledge Worker
Upload Submissions	Retry halted submissions from a case	System Admin, Business Admin, and Knowledge Worker
View Layouts	Open layout information from the Documents table	System Admin, Business Admin, and Data Clerk Admin
API Access	View the case JSON output	System Admin and Business Admin

You also need the required task permissions and qualifications to perform pending tasks. Learn more in Permission Groups.

Flow-based access
A case can contain content processed by different flows. Your flow access controls which documents, pages, data fields, and tasks you can open. Content that you cannot access appears unavailable.

Cases page

To access the Cases page:

Go to Submissions > Cases. Each row represents one case.

Filter options for managing cases

Find a case

Search or filter the Cases table to narrow the results.

Find cases by	How to search or filter
Case ID or Submission ID	Enter the ID in Search by ID, and press Enter. ID searches return exact matches.
Date created	Select a date range from the date selector next to Filters.
Date last updated	Open Filters, and select a date range under Date last updated.
Scheduled deletion date	Open Filters, and select a date under Scheduled Deletion By.

Filter options for cases, including date range and search by ID functionality.

Understand the Cases table

Column	Description	Available actions
Case ID	The unique ID for the case	Click the ID to open the Case Details page.
Documents	The number of documents in the case	None
Date created	When the case was created	Sort the column by date.
Date last updated	When the case was last changed	Sort the column by date.
Scheduled Deletion	When the case is scheduled for deletion, or Never if no deletion is scheduled	Sort the column by date.
Tasks	Whether the case has pending tasks that you can perform	Select Perform Tasks to start the available work.

To change which columns appear, open the table menu and select Show/Hide Table Columns.

List of cases with details like ID, documents, and dates.

Manage cases

The Actions menu allows you to make changes to the cases you select:

Action	Result
Edit deletion date	Schedule the selected cases for deletion, change their deletion date, or remove the scheduled date.
Delete	Delete the selected cases after you confirm the action.

Cases Action menu - delete or edit deletion dates.

Case Details page

Click a Case ID to open its Case Details page. Use this page to review the case as a whole and then move to the document, page, or data field that needs attention.

Case summary showing document statistics and submission details for review and action.

If the case has incomplete tasks, an alert appears at the top of the page. Click Perform tasks to start work that you are allowed and qualified to perform.

Case summary showing incomplete tasks and options to perform tasks.

Review the Case Summary

The Case Summary shows basic information, notes, and processing totals.

Area	Descirption
Info	The date the case was created, the date it was last updated, and its scheduled deletion. If you have Delete Cases, click Edit Deletion Date to change the schedule.
Notes	Notes saved with the case.
Stats	Counts that summarize the documents, submissions, data fields, halted work, and unmatched pages in the case.

Case summary displaying document statistics and submission details for processing.

Stats

Metric	Description
Complete Documents	Documents that completed processing
Total Documents	All documents in the case
Complete Submissions	Submissions that completed processing
Total Submissions	All submissions in the case
Halted Submissions	Submissions that did not complete because processing halted
Complete Data Fields	Completed fields that are not missing required data and were not skipped during supervision
Required Fields Missing / NIGO Fields	Required fields that are missing, plus fields that a user could not supervise—for example, because the content is blank or illegible
Unmatched pages	Pages that have not been matched to a layout

Open the Case Summary Actions menu to use actions available to you:

Action	Use it to
View JSON output	Review the case output as JSON.
Retry halted submissions	Retry failed flow runs for halted submissions that you can access. This action appears when you have the Upload Submissions permission and at least one halted submission is accessible to you. It does not resubmit a submission or create a new submission. Check the Notification Center for progress.
Delete	Delete the case after you confirm the action. Deleting a case does not delete its submissions, files, documents, or pages. They remain available outside the case.

Case deletion and retention

Case and submission deletion are separate. If you delete a submission that belongs to a case, the case remains. If it has no other content, the case can be empty.

Case retention. The Machine Collation Block can set a case’s scheduled deletion date. The retention_period setting defines how many days to keep the case after the block updates it. The refresh_retention_period setting controls whether the block reapplies that period to existing cases or applies it only to cases without a deletion date. See Machine Collation Block in the Flows SDK.

Review case documents

The Documents section lists the documents in the case. Filter the table by document status, or click View all documents to review them together.

View documents in Cases

Column	Description
Document ID	The document's ID. Click it to open the document.
File Names	The original names of the files uploaded with the submission. Use these names to identify the source files for the document.
Layout Variation	The layout variation matched to the document. If you have View Layouts, select the information icon to view layout details.
Submission ID	The submission that contains the document. Click the ID to open the Submission Output page.
Status	The document's current processing status
Pages	The number of document pages that belong to this case
Date created	When the document was created
Actions	Remove the document from the case or perform an available task. Removing a document from a case does not delete the document from its submission.

Cases Docs overview showing completed statuses and data fields for review.

Review unmatched pages

The Unmatched Pages section lists pages in the case that have not been matched to a layout. Use the table to check the page image, original file name, and status. From Actions, you can remove an unmatched page from the case or perform an available task.

Review case data

The Data section combines the data fields extracted from the case documents. Search for a data field, filter by status, or click a value in Found in to open its document.

Status	Meaning
Complete	The field completed processing without an exception.
Complete With Exceptions	The field completed processing, but it has an exception that does not make the field unusable.
Illegible	The field completed with an illegible-field exception.
Required Field Missing	A field required by the layout is blank.
Non-required Field Missing	An optional field is blank.
Processing	The field is still being processed.
Manual Identification, Manual Transcription, Flexible Extraction, or Custom Supervision	The field is waiting for the named task. If an action is available, select Perform tasks.
Data Deleted	The field data was deleted according to the configured data-retention policy.

Data submission table showing various fields and their completion statuses.