Releases

Releases

What is a Release?

A release is a package of one or more committed layout variation versions. This collection of layouts or layout variations should reflect the various document types that the machine should expect. To actually use the layouts that you have created to process documents, you need to deploy a flow that contains a release.

Navigating the Release Library

The Release Library provides information on all the releases in the system. You can access it by going to Library > Releases in the application. At the top of the page, you can see details about the current live release. The full list of releases is available for your review, including their statuses.

Adding a New Release

Releases are sets of layouts or layout variations that your submissions will be matched to. You can have multiple live releases at a time. You can add a new release to your instance in one of two ways: Create a completely new release or clone an existing one.

Assigning a Release to a Flow

To use the layouts that you have created to process documents, you need to deploy a flow that contains a release. You can assign each release to a flow. Deploying a flow makes the flow’s release live. Thus, you can deploy multiple flows and have different releases active simultaneously.

Editing a Release

The Release Editor screen allows users to make changes to the contents of a draft release. To access the Release Editor: Navigate to Library > Releases. Click on the name of the release draft that you would like to edit. On the release details page, you'll find the editing options.

Archiving and Restoring Releases

To prevent your Release Library from becoming cluttered, consider archiving old or unused releases. Unlike deletion, archiving is a non-permanent action. Once an archived release is restored from the archive, it can be used without restriction. This helps maintain an organized library while keeping important releases accessible.

Exporting a Release

If you create a release in one instance of Hyperscience and would like to use it in another, you can export the release by downloading it to your machine. Then, you can import, or upload, that release to the other instance of Hyperscience. The detailed process for exporting and importing is documented for your reference.