Creating Structured Layouts

Creating Structured Layouts

Use structured layouts to process documents where key fields appear in consistent positions. This layout type helps Hyperscience quickly and accurately locate and extract data from standardized documents, such as W-8 or HCFA forms.

A Structured Layout can contain one or more layout variations. Variations allow you to support multiple versions of the same Document while maintaining a shared set of fields and extraction settings. Use the Layout Editor to define fields, configure extraction settings, and manage layout variations.

In this article, you'll learn how to:

Create a Structured layout

Follow the steps below to create a structured layout:

  1. Go to Library > Layouts.
  2. Click Add Layout.
  3. Click Structured Layout, and then click Next.
  4. Upload one or more PDF, TIFF, JPG, or PNG files by doing one of the following:
    • Drag and drop the file into the upload modal.
    • Click Choose File to upload a file from your machine.
      • Uploading a multi-page PDF or TIFF file creates a single layout variation from the file.
      • When uploading multiple JPG or PNG files, page order matches the upload order.
      • A separate layout is created for each PDF or TIFF file that you upload.
  5. Click Next.
  6. Enter a name in the Layout Name field.
  7. Under Language, select the language users are expected to use when entering information in documents matching this layout.
  8. Click Create.
  9. After creating the Structured layout, click its name to open the Layout details page.

Access the Layout Editor

You can specify the information that should be extracted from submitted pages that match the layout by defining the field metadata in the Layout Editor.

To access the Layout Editor:

  1. Go to Library > Layouts, and click on the name of the layout you want to edit.
  2. Click on Layout Variations, and click on the name of the variation.

When in the Layout Editor, you’ll be making changes to the working version of the layout. To commit your changes—or to save without committing your changes—follow the steps in Saving and exiting below.

Using the Layout Editor

The layout’s title appears across the top of the page. The button to commit changes appears in the upper-right corner of the page. To learn more about committing changes, see the Saving and exiting section later in this article.

The Layout Editor for Structured layouts is split into three panels: page thumbnails, the main page view, and the field list.

Page viewer

To change between pages in the layout or layout variation, click on the page thumbnails on the left-most panel, or use the paging controls above the table of extracted fields and layout identifiers. Changing pages will automatically save your progress.

Field list

The right panel displays both Layout Identifiers and Fields together, across all pages. To learn more about Layout Identifiers, see Layout Identifiers.

When you create a Structured layout, the system attempts to identify its fields and adds them to the fields list. You can edit the bounding boxes and any settings for these fields.

Any fields added by you or the system are added to the layout’s shared field list. If you create variations of the layout, the fields in the shared field list will be available in those variations. In the Layout Editor, the shared field list is split into two lists:

To learn more about working with active and inactive fields, see Editing a Structured Layout Variation.

Defining fields

On a layout for a Structured document, fields have two elements:

To define a field, click and drag on the page image to create a bounding box. If the field already appears in the field list, click on its name before drawing its bounding box.

Defining field metadata

After drawing the bounding box, define the field metadata in the field list on the right. The following pieces of metadata can be defined for each field on a Structured layout:

For each field, a field name and data type must be defined. If either is missing, an error message saying "Missing Field Information" will be shown, and the field will be highlighted in red in the layout editor.

Additional Settings

There are additional settings and features you can enable to improve machine performance:

Editing multiple fields

You can select multiple fields from the field list and change the following parameters:

To select multiple, non-contiguous items use CMD + Click and to select contiguous items use ShiftClick.

Saving and exiting

All layout working versions auto-save, so there is no need to manually save changes that have been made.

The way a page is arranged in a document. In Hyperscience, layouts guide how data is extracted from different types of documents, like forms, invoices, and purchase orders. There are three types of layouts: Structured, Semi-structured, and Additional, depending on how consistent the content and its arrangement are across pages.

In Hyperscience, a Structured layout is used to process documents where key fields appear in consistent positions. This layout type helps the system quickly and accurately find and extract data from standardized documents like W-8 or HCFA forms in the US.

A group of one or more pages processed as a single unit in Hyperscience. Documents are categorized as Structured, Semi-structured, or Additional based on how consistent their layouts are and how fields can be extracted from their pages.