Layouts help the system identify and extract data from your submissions. To use the layout functionality, you need to build and deploy a layout, following the steps below:
Determine the layout type
Build a layout
Define fields
Define fields for Structured layouts
Define fields for Semi-structured layouts
Define field metadata
Add a release
Assign a release to a flow
Step 1: Determine the layout type
Before creating the layout, you must determine the layout type. The layout type you choose depends on the type of documents you will be processing through the system. Hyperscience supports three types of layouts:
Structured - layouts for documents where the data types and the fields’ locations are consistent.
Semi-structured - layouts for documents where the data types are consistent but the fields’ locations are inconsistent.
Additional - layouts for documents that should be classified but do not have any fields for extraction.
To learn more about the layout types and their differences, see Understanding Document Types and Determining Layout Type.
Step 2: Build a layout
Once you’ve determined the layout type, you can start building the layout:
Go to Library > Layouts.
Click Add Layout.
Select a layout type.
If you choose Structured Layout, you will be asked to upload your structured form.
Enter a name for your layout in the Layout Name field.
Under Language, click on the drop-down list, and click on the language you expect people to use when entering information in this layout’s documents.
Click Create.
Definе fields
To start defining fields, you need to access the Layout Editor:
Go to Library > Layouts, and click on the name of the layout you want to edit.
Click on Layout Variations, and click on the name of the variation.
The procedure of defining fields in a layout is different, depending on the layout type.
Note that Additional layouts do not have any fields, as no extraction is performed on pages matching to Additional layouts.
Definе fields for Structured layouts
A field on a Structured layout has two elements: a bounding box and metadata. To define a field, click and drag on the page image to create a bounding box.
Definе fields for Semi-structured layouts
A field on a Semi-structured layout has only metadata. To define a field, click Add Field.
Define field metadata
The metadata helps the machine read and process the field’s value. The field metadata is different for each layout type. To learn more about the different metadata options, see Creating Structured Layouts, Creating Semi-structured Layouts, and Choosing a Data Type.
Step 3: Add a release
Releases contain different layouts that documents will be matched to. To add your layout to a new release, you need to:
Go to Library > Releases, and click Add Release.
Enter a name for your release.
Find the layout you want to include and select the checkbox next to its name.
Do one of the following:
To create your release and lock it, click Create.
To create your release as a draft, click the X in the upper-right corner of the screen. You can edit your release by going to Library > Releases and clicking on Edit. When you’re ready and you want to lock your release, click Create.
To learn more about releases, see What is a Release? and Adding a New Release.
Step 4: Assign a release to a flow
To make a release live, you need to either:
Assign the release to a live flow, or
Assign the release to a flow and deploy the flow.
If a release has already been assigned to a flow and you assign a new release to the same flow, the new release will replace the previous one.
To assign a release to a flow, follow the steps below: Assigning a release to a flow
Go to Library > Releases.
Find the release that you would like to assign to a flow, and click on its name. Note that you can only assign locked and live releases to flows.
Click the Assign to Flow button that is located in the upper-right corner of the page.
Select the flow or flows you would like to assign the release to.
Click Assign to Flow.
To learn more about assigning a release to a flow, see Assigning a Release to a Flow.
If you are assigning the release to a flow that is not deployed, follow the steps below to deploy the flow. If you are assigning the release to a deployed flow, you can skip the steps below.
Deploying a flow
To deploy a flow:
On the Flows page, find the flow you want to deploy, and click on the flow's menu (
).Click Deploy Flow.
Click Continue in the dialog that appears.
To learn more about deploying flows, see Managing Flows.