Skip to main content

Flow View

The

Flow View
page provides access to running flows and viewing run history. This page can be accessed by clicking on a flow on the
Home
page.

Running flows​

To run a flow, drop a file into the upload box and click the

Run
button on the left side of the run box.

Flow View page

Flow status indicators​

Flow status indicator

Flow-level status​

The Run History table contains the following status information on historical runs:

  • File: Input files and input parameters associated with flow run
  • Run Tag: Run tags associated with flow run. An example run tag would be a Benchling custom entity ID used to reference a table within Benchling.
  • Status: Run status for a flow run instance. Possible status values are:
    • Running: Job is in the process of running
    • Success: All nodes have run successfully
    • Failed: At least one node has failed to run successfully

Node-level status​

Node status indicator

Clicking on the plus sign found on the left hand side of each Run History table record expands the view to display node-level status.

Some common values for colors that you will see are:

  • #B22222 Red: failure after retries exhausted
  • #01FF70 Light green: currently running
  • #2ECC40 Dark green: successful run
  • #A9A9A9 Gray: queued; awaiting system resource to commence
  • #FFFF00 Yellow: failure to run on at least 1 try; awaiting retry
  • #9932CC Dark Orchid: skipped prior to completion; this color may indicate a system resource limitation
  • #FFA500 Orange: dependency for node has failed, preventing this node from being run

Logs associated with each flow step can be accessed by clicking on the corresponding colored box.

Error Attribution​

Developers on the platform are able to throw specify an error type and message associated with a failed node, as shown in the example code below, which would live within a node. The type is displayed on the status tag of the Run History table.

from ganymede_sdk.flow_runtime import GanymedeException

# available exception types are: Validation, Connection, Function
raise GanymedeException(message=”Peaks not detected in results”, exception_type=”Function”)

Categories of errors are:

  • Validation: Schema validation errors; an example use case would be a Pandas DataFrame failing to validate against a Pandera schema.
  • Connection: Errors related to connecting to external services. Check for errors related to authentication, service availability, and how the service is being accessed.
  • Function: Errors related to function logic; an example use case would be a failed function call to a Python package.