Work with Flow Studio V2

Flow Studio allows you to drag and drop end-to-end automation Flows. With more than 300 point-and-click functions, Flow Studio brings together workflow combinations, data preparations, data analytics, and machine learning to build automations with a wide range of complexity.

Overview

A completed automation process in Hero_Flow is called a Flow. Flows are built within Flow Studio. A completed Flow contains Inputs(s) specifying what data to bring into Hero_Flow, functions to build your automation, and Output(s) to write the data back out of Hero_Flow. When a Flow has been completed, you can schedule the Flow to begin running.

Open Flow Studio

Open Flow Studio by:

Using the Element Browser

The element browser is a menu that stores each type of element (Inputs, Outputs, functions) available to use in a Flow.

The elements are separated by type:

  • Inputs
  • Aggregations
  • Creators
  • Filters
  • Flattens
  • Formulas
  • Lookups
  • Procedures
  • Outputs

Each element type can be expanded/minimized by clicking the drop-down icon.

Each element can be dragged and dropped onto the Flow Studio canvas.

Search for elements using the search bar at the top of the element browser.

Add text features to annotate your Flow:

  • Comment - Drag and drop the "Comment" element to add an editable speech bubble to the Flow Studio canvas.
  • Headline - Drag and drop the "Headline" element to add large editable text to the Flow Studio canvas.
  • Text - Drag and drop the "Text" element to add small editable text to the Flow Studio canvas.

Parts of an Element

Element Title Bar

  • Double-click on the element icon in the top right of the box to:
    • Add notes to an Input.
    • Configure a function or an Output.
  • Double-click on the element's name to rename the element.
  • Click the page/magnifying glass icon to open the preview data at the bottom of the screen.
  • Click the up/down caret icon to expand or collapse the element's information section.

Element Information

Inputs

Input elements display:

  • The Connection name used for the Input data.
  • The source of the data.
  • Field names that are outgoing from the element further into the Flow. 

Double-click within the Input element's information section to add notes to the Input element.

Functions

Function elements display:

  • Field names coming from previous elements in the Flow.
  • New field names that are outgoing from the element further into the Flow. 

Double-click within the function element's information section to configure the function.

Outputs

Output elements display:

  • Field names that coming from previous elements in the Flow.
  • New field names that are outgoing from the element further into the Flow. 

Double-click within the Output element's information section to configure the Output's field mapping.

Add Inputs

The first step in building your Flow in the Flow Studio is adding an Input which allows you to bring selected data into Hero_Flow.

  1. Add an Input in Flow Studio by opening the Input menu in the element browser.

  2. Select the Input from the list and drag it onto the Flow Studio canvas.

An Input has now been added to the Flow.

Drag and drop a CSV or binary file Input

Along with creating and using a standard Input, users also have the ability to drag and drop a .csv or binary file onto the Flow Studio canvas.

The data is uploaded to Hero_Flow's Tuple store and can be found in the Inputs after uploading has been completed.

Add multiple Inputs

Additional Inputs can be add to a Flow.

  1. To add additional Inputs, drag and drop additional Inputs from the Input list onto the canvas.

Delete an Input

An Input in Flow Studio deleted from the Flow process.

To delete an Input:

  1. Right-click on the Input name and select DELETE.

  • An Input cannot be deleted if there are branched functions or Outputs currently attached in the process.
  • An Input with only a straight process of functions without an Output can be deleted. The deleted Input also deletes the attached functions.
  • After selecting DELETE, an applicable Input is deleted from the Flow without an additional confirmation prompt.

Add Functions

Functions are used to implement the automation's logic and become active when they are connected within the Flow.

  1. To add functions in the Flow, select a function from the Element Browser and drag and drop it onto the canvas.

  2. Click and drag the cable plug (a dot on the side of element boxes) from the Input to the function.
    Configure the function and click OK.

A function has now been added to the Flow.

Add multiple functions

Add multiple functions to the Flow in a straight or branched process using the add function method above.

Edit or delete a function

The settings of a function in Flow Studio can be edited or deleted from the Flow process.

To edit a function:

  1. Right-click on the function and select EDIT.

  2. Adjust the function specific settings.

  3. Click OK.

Functions and Outputs attached to the edited function use the same data fields as the original function's settings. If data field names have changed, the updated process might not be functional.

An error message is displayed: Some functions are invalid.

To delete a function:

  1. Right-click on the function name and select DELETE.


  • A function cannot be deleted if there are branched functions in a forward position in the process.
  • After selecting DELETE, an applicable function is deleted from the Flow without an additional confirmation prompt.

Copy and paste functions

Functions on the canvas of the Flow Studio can be copied and pasted.

The copy and paste functionally in the Flow Studio works the same as the systems copy and paste functionally.

Keyboard shortcutAction
Ctrl/Cmd + ccopy
Ctrl/Cmd + ppaste

After a function has been copied and pasted, that function can be used within the Flow.

List of functions

See the full list of Flow Studio functions.

Add Outputs

The final step in building your Flow in the Flow Studio is adding an Output which allows for writing selected data out from Hero_Flow.

  1. Add an Output in Flow Studio by opening the Output menu in the element browser.
    Select the Output from the list and drag it onto the Flow Studio canvas. 

  2. Click and drag a cable plug (a dot on the side of an element box) from a function to the Output.
    Map the Flow fields with matching fields in the Output and click OK.

    An Output has now been added to your Flow.

    If the Input field in a Flow has a tuple data type, Outputs have the ability to use a value from that tuple’s nested tuple values.

Add multiple Outputs

Additional Outputs can be added to a Flow.

  1. Add additional Outputs in Flow Studio by opening the Output menu in the Element Browser.
    Select an additional Output from the list and drag it onto the Flow Studio canvas.

  2. Click and drag a cable plug (a dot on the side of an element box) to the Output.
    Map the Flow fields with matching fields in the Output and click OK.

Edit, change, or delete an Output

An Output in Flow Studio can be edited, changed, or deleted from the Flow process.

To edit an Output:

  1. Right-click on the Output name and select EDIT.

  2. Adjust the Output specific settings.
  3. Click OK.

To delete an Output:

  1. Right-click on the Output name and select DELETE.

After selecting DELETE, an Output is deleted from the Flow without an additional confirmation prompt.

Merge Flow Branches

Join Flow branches in Flow Studio into a single branch Merge allows similar data from different data sources to be leveraged in the same Automation Flow.

To merge Inputs:

  1. Drag and drop and additional Input(s) onto the canvas.

  2. Drag and drop a cable from the unattached Input into function element already attached to an Input.

  3. The merge configuration box is displayed.
    • Click Add output field.
      Enter a name for the data output field.
    • Select input fields to merge.
    • Additional output fields can be created. 

    To save time, the input field names can be automatically set as the output field names by clicking Use as output under the desired Input.


  4. A Merge icon appears on the canvas that connects each Input.

Merging Inputs only append tuples, it does not combine tuples.

Add Comments to Flow Elements

Notes can be added to Flow elements (Inputs, functions, and Outputs).

To add a note to a Flow element:

  1. Right click the element in the Flow and select Edit.
  2. Enter text into the Note field.

Notes can be viewed in a Flow by clicking on the "Note" drop-down box at the bottom of the element.

Preview Data

View a preview of the data anywhere within the Flow.

To preview data:

  1. Click the preview data icon located at the top of each element to view the data.
  2. The preview data is located at the bottom of the screen.

After the preview data has been displayed, click the expand/minimize icon on the preview data box to:

  • minimize the preview data when expanded.
  • expand the preview data when minimized.

Save and Close a Flow

To save a Flow:

  • Click Save on the toolbar at the top of screen.

To close a Flow:

  • Click Close at the top right corner of the screen.


  • If a Flow is closed with unsaved changes, a dialog box is displayed with the following options:
    • Click Back to editor to cancel closing the Flow and remain in the Flow Studio.
    • Click Discard and exit to close the Flow and delete any unsaved changes.
    • Click Save and exit to save the current progress in the Flow and leave the Flow Studio.



Recover unsaved Flow changes

If the Flow Studio was left before selecting to save or discard changes, the previous changes can be recovered.

To recover unsaved changes:

  • Open a Flow. If the Flow has unsaved changes:
    • Click Yes to revert back to the Flow's previous progress.
    • Click No to discard previous unsaved changes. 

The option to restore unsaved changes is not available if any node in an unsaved Flow was removed from Hero_Flow.

Example:

  1. A user creates a Flow with an Input, functions, and an Output.
  2. The user leaves the Flow unsaved.
  3. The user opens the Output dashboard in Hero_Flow and deletes the Output used in the Flow example.
  4. When reopening the unsaved Flow, there is no option to recover unsaved changes.

This is to protect the Flow from possible corruption. 

Run a Flow

When a Flow is complete and ready to be run, there are two methods to start the Flow running.

Run a Flow immediately from Flow Studio

When the Flow has been completed and should run immediately:

  • Click Run Now in the toolbar. 
    • The Flow is saved with this action.

After clicking Run Now, Hero_Flow closes the Flow Studio and displays the Flows dashboard.

Run a Flow at a scheduled time

When a Flow has been completed, it can be scheduled to run at a specific and/or reoccurring times:

  • Save the Flow by clicking Save in the toolbar.
  • On the Flow Dashboard, locate the Flow and click the gear icon for menu options.
  • Click Schedule

Making edits to a Flow that has been scheduled

After editing and saving a Flow that had already been scheduled, it is necessary to stop that Flow before the new edits become active. After stopping the Flow, it can be rescheduled and the changes made to the Flow are applied.

Flow Studio Toolbar

The Flow Studio toolbar is located at the top of the page.

OptionDescription

Save

Select to save your the work on your Flow. 
UndoSelect to undo the previous action made in Flow Studio. This command is only applicable for actions made in the current session of the Flow. 
RedoSelect to redo the previous action made in Flow Studio. This command is only applicable for actions made in the current session of the Flow. 
Reset ViewSelect to restore the original view of the Flow Studio.
Run NowSelect to run the Flow immediately.

Simple Flow Example

Here is an example of a simple flow.

The first white element is an Input that brings in data fields into Hero_Flow from your data's location.

The blue element is a type of function that performs an action or calculation on your specified data.

The last white element is an Output where the adjusted data is written back out of Hero_Flow to an outside data location.