Flow Blocks

Flow Blocks

With the introduction of flows, we have created the following types of blocks to help you customize your flows to meet your teams’ needs. To learn more about any of these blocks, or for assistance in adding them to your flows, contact your Hyperscience representative.

Block types and settings

Input Blocks

Formerly known as “Input Connectors,” Input Blocks allow you to integrate your organization’s data sources into our system. Through these blocks, you can process documents from a variety of sources, such as inboxes, message queues, or folders on the network.

A full list of the Input Blocks we currently support, along with more details about each, can be found in Input Blocks.

Settings

No matter how many Input blocks you choose to enable, information about those blocks is contained in a main Input block for your flow. This block has the settings described below.

Name Required? Description
Allow API submissions No Indicates whether the flow accepts submissions submitted via API.
Allow manual submissions No Indicates whether the flow accepts manually uploaded submissions.

File Filter Block

If your submissions contain files that should not be processed by Hyperscience (e.g., images in email signatures), you can configure the File Filter Block to ensure that only the files that require processing are included in submissions. By preventing unnecessary files from being processed, this block can reduce the need for adjustments in Classification model training and other downstream processes.

You can use the File Filter Block to filter files from submissions that are created through the following methods:

The File Filter Block is included in Document Processing Subflow V42. When adding the File Filter Block to custom flows, it must be placed after the Input Block and before the Submission Initialization Block.

Note the output of the File Filter Block contains the UUID of each file that was filtered out, along with the filters that caused the file to be excluded. If the file was submitted through the Email Listener, the output also contains the name of each file that was excluded by the block.

Settings

You can customize the functionality of your block by editing the settings described below.

Name Required? Description
All Files or Images Only Yes Determines whether the filters in this block are applied to all files in submissions or only to image files (i.e., files whose MIME type is image).
Minimum Image Width (px) No The minimum width in pixels that an image needs to have in order to be allowed by the filter.
This filter applies only to images and has no impact on other files.
Minimum Image Height (px) No The minimum height in pixels that an image needs to have in order to be allowed by the filter.
This filter applies only to images and has no impact on other files.
Minimum File Size (KB) No The minimum size in kilobytes that a file needs to have in order to be allowed by the filter.
File Extension Action Yes Select one of the following options:
- Do not filter files by extension

- Allow only these file extensions

- Deny files with these extensions
File Extensions Yes, if File Extension Action is set to Allow only these file extensions or Deny files with these extensions A list of file extensions that the filter will allow or deny, based on the option selected in File Extension Action.
Other File Extensions Yes, if Other is selected in File Extensions A comma-separated list of file extensions that do not appear in File Extensions.
This field only appears if Other is selected in File Extensions.

Submission Bootstrap

The Submission Bootstrap Block contains settings that connect your flow to your:

Settings

You can customize the functionality of your block by editing the settings described below.

AWS S3

S3 Submission Retrieval Store

If you are using an S3 bucket as your submission retrieval store and you are not authenticating through IAM roles, provide your AWS access key ID and secret access key in the S3 Submission Retrieval Store field.

To enter your credentials:

  1. Click Edit value.
  2. Enter your credentials in JSON format:
{
  "aws_access_key_id": "<your_access_key_id>",
  "aws_secret_access_key": "<your_secret_key>"
}
  1. Click Done.
  2. Click Save in the upper-right corner of the page.
  3. In the dialog box that appears, click Save & Deploy.

For more information about AWS access key IDs and secret access keys, see Amazon's Understanding and getting your AWS credentials.

S3 Submission Retrieval Endpoint URL

If your submission retrieval store is not in the public cloud (i.e., its URL does not point to s3.amazonaws.com — for example, a government cloud or an S3-compatible internal setup), enter its URL in S3 Submission Retrieval Endpoint URL. You do not need to edit your “.env” file to update this URL.

To edit the endpoint URL for your S3 submission retrieval store:

  1. Enter the URL in the S3 Submission Retrieval Endpoint URL field or edit its contents.
  2. Click Save in the upper-right corner of the page.
  3. In the dialog box that appears, click Save & Deploy.

If the bucket you’re using as your submission retrieval store is in a public cloud (as opposed to a government cloud or an S3-compatible internal setup), leave this field blank.

OCS

If you are using an OSC submission retrieval store, enter the configuration details for your file store in these fields.

OCS Configuration

To enter your configuration details:

  1. Click Edit value.
  2. Enter the configuration details in JSON format:
{
  "host_url": "<your_host_url>",
  "username": "<your_username>",
  "password": "<your_password>",
  "ssl_cert": "<CA_bundle_filename_OR_SKIP>"
}
  1. Click Done.
  2. Click Save in the upper-right corner of the page.
  3. In the dialog box that appears, click Save & Deploy.

v42.3

Name Required? Description
OCS Host URL Yes, if using an OCS submission retrieval store The OCS host URL for the submission retrieval store.
OCS Username Yes, if using an OCS submission retrieval store The OCS username for authenticating into the submission retrieval store.
OCS Password Yes, if using an OCS submission retrieval store The OCS password for authenticating into the submission retrieval store.
OCS SSL Certificate Yes, if using an OCS submission retrieval store The value should match the CA bundle filename inside the $HS_PATH/certs directory. To disable certificate validation, set this value to SKIP.

Classification Blocks

We’ve divided our Classification function into two blocks: one for Machine Classification and another for Manual Classification.

Machine Classification

With machine classification, Hyperscience can automatically match your submissions to Structured, Semi-structured, or Additional layouts. Machine classification requires training to recognize the kinds of submissions you process through Hyperscience.

Settings

Name Required? Description
Image Correction No Identifies and corrects the orientation of Semi-structured images by rotating them.
Cannot be enabled if Faster PDF Transcription is enabled.
Faster PDF Transcription No If enabled, the system processes pages in PDF files in their native format, allowing for faster transcription.
Captured Image Enhancement No Improves machine readability of Semi-structured documents captured by mobile devices.

Manual Classification

Manual Classification, or Classification Supervision, allows your keyers to manually match submissions to their layouts.

Settings

Name Required? Description
Default task restrictions No Select the task restrictions that should be applied to tasks created by this block.

Identification Blocks

We’ve created two Identification blocks to cover both our machine Identification and Identification Supervision capabilities.

Machine Identification

With Machine Identification, you can automate the identification of fields and tables in your submissions.

Settings

Other than the settings under “Block Details,” Machine Identification Blocks have no block-specific settings.

Manual Identification

Manual Identification allows your keyers to complete Field ID Supervision or Table ID Supervision tasks, where they draw bounding boxes around the contents of certain fields, table columns, or table rows.

Settings

Transcription Blocks

Just as we did with Classification and Identification, we’ve divided our Transcription capabilities into Machine Transcription and Manual Transcription Blocks.

Machine Transcription

In the Machine Transcription Block of your flow, Hyperscience automatically transcribes the content of your submissions, whether written by hand or typed through a machine.

Settings

Other than the settings under “Block Details,” Machine Transcription Blocks have no block-specific settings.

Manual Transcription

Manual Transcription, or Transcription Supervision, lets your keyers manually enter the text found in fields or tables.

Settings

Flexible Extraction Block

Depending on your flow’s configuration, Flexible Extraction tasks allow your keyers to:

Settings

Collation Block

We’ve created a Collation Block to allow the grouping of files, documents, and pages into cases.

Settings

Name Required? Description
Replace case data from duplicate file names No Replaces case data from repeated file names within the same case.

Complete Blocks

Every flow needs a Complete Block. This block initiates Quality Assurance tasks and changes the submission’s status to “Complete.”

Output Blocks

Output Blocks were called “Output Connectors” in previous versions of Hyperscience. With Output Blocks, you can send data extracted by Hyperscience to other systems for downstream processing.

Settings shared by all block types

All blocks have the following settings under “Block Details”:

Name Required? Description
Display Name Yes The block's name in Flow Studio. You can change the name for each of your flows.
Description No The block's description in Flow Studio. You can change the description for each of your flows.