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

Application-level and flow-level settings

While some blocks have settings that allow you to customize how they work, many blocks are affected by application-level or flow-level settings. To learn more about these settings, see Application Settings Overview and Flow 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. |

Submission Initialization

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

Settings

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

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": "",
  "aws_secret_access_key": ""
}

You can authenticate requests using AWS Signature Version 2 (SigV2). To use AWS Signature Version 2, add the following variable and value to the S3 Submission Retrieval Store field:

"s3_signature_version":"s3"
  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.

OCS Configuration

If you are using an OSC submission file store, enter the configuration details for your file store in this field.

To enter your configuration details:

  1. Click Edit value.
  2. Enter the configuration details in JSON format:
{
  "host_url": "",
  "username": "",
  "password": "",
  "ssl_cert": ""
}

The value of ssl_cert should match the CA bundle filename inside the $HS_PATH/certs directory. To disable certificate validation, set this value to 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.

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. Depending on your flow, keyers may perform Classification Supervision if the system cannot match a submission to a layout with high confidence.

Settings

You can customize the functionality of your Manual Classification Block by adding Task Restrictions.

| 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. This identification process ensures that the system transcribes the correct content in the Transcription steps of the data-extraction process.

Settings

You can customize the functionality of your Manual Identification Block by adding Task Restrictions.

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 the text was 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. Depending on your settings, your keyers may manually transcribe certain pre-selected fields or fields that the machine could not transcribe with high confidence.

Settings

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

Task Restrictions
Supervision

| Name | Required? | Description | | Supervision Transcription masking | No | Prevents users from inputting invalid characters during Supervision Transcription tasks. | | Table output manual review | No | Generates a Table Transcription task if any table cells are identified. | | Create Manual Transcription Task for Tables with Blank Cells | No | Always sends blank cells to Manual Transcription, regardless of machine confidence. |

Flexible Extraction Block

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

Settings

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

Task Restrictions

Supervision

| Name | Required? | Description | | Flexible Extraction Transcription masking | No | Prevents users from inputting invalid characters during Flexible Extraction tasks. |

Collation Block

We’ve created a Collation Block to allow the grouping of files, documents, and pages into cases. To learn more about Case Collation, see Case Collation.

Settings

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

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

Custom Supervision Block

To enable the tailoring of a Supervision task’s interface to a specific business process, we’ve created a Custom Supervision Block.

Settings

| Name | Required? | Description | | Task purpose | Yes | The custom task name given to the Custom Supervision task in the Task Queue. | | Default task restrictions | No | Select the task restrictions that should be applied to tasks created by this block. | | Custom Supervision transcription masking | No | Prevents users from inputting invalid characters during Custom Supervision Transcription tasks. |

Database Blocks

Database Blocks allow you to make queries from Hyperscience to databases, which increases the overall speed of your flows by minimizing the need for manual transcription.

Custom Code Blocks

Custom Code Blocks enable you to transform and validate extracted submission data before Hyperscience sends it to your downstream systems. The table below lists the kinds of post-processing rules you can implement with Custom Code Blocks.

| Rule Type | Description | Examples | | Field normalization / Data transformation | Change the formatting of data for compatibility with downstream systems | | Data validation | Perform an external data lookup or check data within the submission to make sure the data is valid, and flag the submission as NIGO if it is not | | Data augmentation | Add data to a submission's JSON to prevent processing issues or to route data to specific downstream systems |

You cannot add Custom Code Blocks to your flow through the platform. To learn more about Custom Code Blocks, or to add them to your flows, contact your Hyperscience representative.

Named Entity Recognition Block

The Named Entity Recognition Block allows you to:

Custom Entity Detection Block (Beta)

The Custom Entity Detection Block allows you to locate and identify single words and word patterns that can be described with a combination of regular expressions and keywords.

Routing Blocks

Routing Blocks let you send submission data to different destinations based on the criteria you specify.

API Blocks

API Blocks allow you to connect to other data sources in your organization in order to augment or verify extracted data.

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 allow you to send data extracted by Hyperscience to other systems for downstream processing. A full list of the Output Blocks we currently support, along with more details about each, can be found in Output Blocks.

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.