Managing Flows

The sections below describe how you can manage flows in your instance of Hyperscience. Note that you may need Hyperscience’s assistance to complete some of these tasks.

Create flows

You can only create a new flow in your instance by duplicating an existing one. If you would like to create a completely new flow, submit a request to your Hyperscience representative.

Edit flows

You can edit some parts of your flows on your own, but you will need assistance or guidance from Hyperscience to edit others.

Delete flows

You cannot permanently delete flows without assistance from Hyperscience. You can, however, archive any flows that you no longer need. To learn more, see Archive a flow.

Deploy a flow

To process submissions through a flow, the flow must have a Live status. To change a flow’s status to Live, you need to:

1. Assign a release to the flow. To learn more about assigning a release to a flow, see Assigning a Release to a Flow.

2. Deploy the flow.

To deploy a flow:

1. On the Flows page, find the flow you want to deploy, and click on the flow's menu ( ).

2. Click Deploy Flow.

3. Click Continue in the dialog that appears.

The flow's status changes from Disabled to Live, and it will begin processing submissions in a few minutes.

Note that you can deploy multiple flows. Thus, you can have multiple live releases at the same time.

Disable a flow

If you want to stop submissions from being created against a flow, you can disable it until you're ready to create submissions through it again. Any submissions that are currently in progress in the flow will continue to be processed.

To disable a flow:

1. On the Flows page, find the flow you want to disable, and click on the flow's menu (  ).

2. Click Disable Flow.

3. Click Disable in the dialog that appears.

The flow's status changes from "Live" to "Disabled," and it will not process submissions until you deploy it again.

Export a flow

If you need to move a flow to another environment or send it to Hyperscience for editing in your current instance, you can export it to a ZIP file.

To export a flow:

1. On the Flows page, find the flow you want to export, and click on the flow's menu (  ).

2. Click Export Flow.

The flow is downloaded to your machine with the name "Flow - [Flow name] - [Flow UUID] - [YYYYMMDD_HHMM].zip," where:

• "[Flow name]" is the name of the exported flow, 

• “[Flow UUID]” is its UUID, and 

• "[YYYYMMDD_HHMM]" is the date and time of the export in GMT.

The ZIP file includes the flow’s JSON file and manifest.json, which contains metadata about the export. If the flow has Custom Code Blocks, their Python files are also included in the ZIP file.

Exported flows do not contain client secrets entered in Input Blocks or Output Blocks.

Import a flow

By importing a flow, you can update a current flow or add a new flow to your instance.

Import an updated version of a flow

1. On the Flows page, click Import Flow.

2. Do one of the following:

   • Drag and drop the flow's ZIP or JSON file into the dialog box.

   • Click Choose File to find and open the file on your machine.

3. Click Import.

4. Click Continue to confirm that you want to overwrite an existing flow.

   The system shows the differences between the flow’s current files and the files being imported.

5. (Optional) Review each changed file by clicking its name in the left-hand sidebar.

   • Files whose code has been updated have counts next to their names that indicate how many lines have been added or deleted in the imported version.

   • If the imported version contains a file that is not present in the current flow, "New" appears next to its name.

   • If the imported version does not contain a file that is present in the current flow, "Deleted" appears next to its name.

   • If an imported version of a file has a different name than the current file, the name of the current file is crossed out, and the name of the imported file is shown next to it.

   • If a file has a caution sign next to its name (  ), at least one of the current and imported files is not UTF-8 encoded, and you cannot compare the differences between the two. You can still import the updated version of the file.

     

6. Do one of the following:

   • Click Commit Changes to finish importing the new version of the flow.

   • Click Download Current Flow to download the current flow, which creates a backup copy of the flow on your machine.

     • If you want to commit the changes after making a backup, you can click Commit Changes.

   • Click Cancel to exit the import process.

Import a new flow to your instance

1. On the Flows page, click Import Flow.

2. Do one of the following:

   • Drag and drop the flow's JSON file into the dialog box.

   • Click Choose File to find the file on your machine.

   • Click Import.

If the system doesn’t find any problems with the file, the imported flow is added to the Flows table. 

If problems are detected, the system shows an error message for each issue that needs to be fixed. Click Try again to upload an updated file. You can also click Copy All Errors to download the error messages for future troubleshooting.

Import Custom Code Block files from an earlier version of Hyperscience

If you imported a flow from v32 or earlier that contains Custom Code Blocks, you need to manually download the Python files from the original flow’s Custom Code Blocks and upload them to the Custom Code Blocks in the imported flow. 

1. In your previous version of Hyperscience, go to the Flows page, and click on the name of the flow you imported to your new instance.

2. Click on the Custom Code Block, and then click on its menu (  ).

3. Click Download File.

   The system downloads the block’s Python file to your machine.

4. Repeat steps 2 and 3 for each Custom Code Block in the flow.

5. In your v35 instance, go to the Flows page, and click on the name of the imported file.

6. Click on the Custom Code Block, and then click Import File.

7. Do one of the following:

   • Find the Custom Code Block’s file on your machine, and drag and drop it into the dialog box.

   • Click Choose File, and find and open the file on your machine.

8. Click Import.

9. Repeat steps 6-8 for each Custom Code Block in the flow.

Duplicate a flow

If you want to create a flow very similar to one of your current flows, you may find it helpful to duplicate the flow that most closely matches the one you'd like to create. You may also want to duplicate a flow to create a "testing" version of the duplicated flow. 

To duplicate a flow:

1. On the Flows page, find the flow you want to duplicate, and click on the flow's menu (  ).

2. Click Duplicate Flow.

The duplicated flow appears in the Flows table with the name "[Duplicated flow] (Copy)," where "[Duplicated flow]" is the name of the duplicated flow.

Archive a flow

If you don't need a flow anymore, you can archive it so that it does not appear on the Flows page.

You cannot archive a live flow. If you need to archive a flow, disable it first.

To archive a flow:

1. On the Flows page, find the flow you want to archive, and click on the flow's menu (  ).

2. Click Archive Flow.

3. In the dialog that appears, click Archive. 

The flow is removed from the Flows table.

Unarchive a flow

If you need to deploy an archived flow, you can do so by following the steps below:

1. Go to the Flows page, and select the Show Archived Flows option.

   Any flows archived in your instance are added to the list of flows.

2. In the table, find the name of the flow you want to unarchive, and click on its menu (  ).

3. Click Restore Flow.

4. In the dialog box that appears, click Restore.

   The flow is restored with a status of Disabled. To deploy it, follow the steps in Deploy a flow.