Skip to content

Get information about workflows

Browse workflows and get summary information

The list of all defined workflows, with summary information about each of them, can be found in the Workflows view of the dashboard.

Workflow lists can also be found in other views:

  • To get the list of workflows using a given model, in the Models view of the dashboard select a model with Workflows on or Workflows off greater than zero. In the right panel you will see the list of published ("on") and unpublished ("off") workflows containing a block for the selected model.
  • To get the list of workflows associated with a given runtime, in the Runtimes view of the dashboard select a runtime. In the central part of the page you will see the list of associated published workflows. To also see the workflows that are associated with the runtime, but not published, uncheck Published workflows.

  • To get the list of workflows associated with an API key, in the API keys view select a key. In the central part of the page you will see the list of associated published workflows. To also see the workflows that are associated with the key, but not published, uncheck Published workflows.

    Note

    The same workflow can be listed multiple times, once for each runtime to which it's associated with the selected API key.

For any list:

  • To see the details of the publication status of a workflow, hover over the ring icon1 representing the publication status.

For the lists in the Workflows, Runtimes and API keys views of the dashboard:

  • To toggle the display of only currently published workflows, check or uncheck Published workflows at the top of the list.
  • To change the sorting criteria of the list, select the column headers that have, next to the name, the arrow—visible or shown when hovering over the name—which indicates the sorting direction.
  • To view the name and surname of the author of a workflow, hover over the icon representing the author, to the right of the last publication date.

In the Workflows view alone:

  • See the most recently used workflows in the Quick access strip, where workflow information is displayed in cards.
  • To switch between table view and card view select Show card view and Show table view on the area's toolbar.
  • To change the sorting criteria of the list in card view choose from the drop-down list above the first card.
  • To switch between the list of all workflows and the list of your workflows, select All workflows and Your workflows at the top left of the list.
  • To filter the list based on the name of the workflow, type in the search box at the top of the list and press Enter. Only workflows with matching names will be listed. The match is case insensitive. Select the X icon inside the search box or clear the box and press Enter to remove the filter.

The information shown for each workflow, which varies based on the dashboard view and the list display mode, is:

  • Name
  • Author
  • Status, represented by a colored ring icon1
  • Date, time and author of the last modification
  • Number of blocks
  • Amount of CPU required by the blocks in the diagram
  • Amount of RAM required by the blocks in the diagram
  • Amount of CPU and RAM required by the asynchronous services shared between all blocks (to be considered only in case of publishing in asynchronous mode)
  • Associated runtimes
  • Date and time of the last publication
  • Associated API keys

Some of the information is also displayed in the workflow editor above the workflow diagram.

Info

The m after the number of CPU stands for "milli", that is thousandths of one CPU. For example, 500m means half CPU and 2500m means two CPUs and an half.
Quantities of RAM are expressed in multiple-byte units like mebibytes or gibibytes.

Get status detail

To get detailed information about the workflow status, hover over the colored ring icon1 representing the status, in any of the above views. A pop-up panel with status information appears.
If the workflow is published in more runtimes, it can have different statuses. Runtimes are listed in the pop-up panel, select one to see the details of the status of the workflow in that runtime.

Select Show more and Show less in the upper right corner of the panel to display more or less details.

Workflow diagram

If you want to know how a workflow is designed and have information about its component blocks, open it. The current view will be replaced by the workflow's editor showing the workflow's diagram inside a canvas.

Inside the editor:

  • The toolbar shows summary information about the workflow, like:

    • Name
    • Number of blocks (to the right of the hollow hexagon icon)
    • Amount of CPU required by the blocks in the diagram (to the right of the gauge icon)
    • Amount of RAM required by the blocks in the diagram (to the right of the the chip icon)
    • Amount of CPU and RAM required by the asynchronous services shared between all blocks (to the right of the gears icon, to be considered only in case of publishing in asynchronous mode)
    • Status (the colored ring icon to the right of the Publish or Async button)1

    Warning

    Figures above reflect the last saved version of the workflow, which may differ from the published version. if any.

  • To have information about a block of the diagram, edit it.

  • To have information about shared services used when the workflow is published in asynchronous mode, select Shared services on the toolbar above the canvas on the right.
  • If the important keys of the workflow's input JSON have been previously listed, to see this information select Input format definition on the toolbar above the canvas on the right.

Get API information

To use a published workflow programmatically, a program must request the resources of the workflow's REST API over HTTPS, and therefore the programmer need to know the URLs of those resources, also called API endpoints. The programmer also needs to know the value of at least one API key associated with the published workflow, because it is necessary to include the value of a valid API key in every request to the workflow's API.

To find out the endpoints of the workflow in a given runtime and the API keys to which the workflow is associated:

  1. Open the workflow's workspace.
  2. Select Settings on the toolbar at the top right of the page.

  3. Select the runtime you are interested in from the list on the left: the rest of the dialog shows:

    • Any associated API keys.
    • The analysis endpoint to use if the workflow was published in synchronous mode.
    • The endpoint to use to submit analysis tasks if the workflow was published in asynchronous mode.
    • The endpoint to use to find out the status of the workflow.

    To copy the URL of any of the endpoints above to the clipboard, select Copy URL to clipboard to the right of the endpoint field.

Note that only the name of any API keys are shown, while a programmer needs the value of a key, which cannot be retrieved with the NL FLow Web application after the creation—or regeneration—of the key itself. The value of the API key bust be noted down when created or regenerated to use it in programs.

Get the workflow's ID

To find out the ID of a workflow:

  1. Open it.
  2. In the editor, select Settings from the toolbar at the top right of the page.

You can find the ID in the General tab in the Workflow ID field.

  • To copy the ID of the workflow to the clipboard, select Copy id to clipboard to the right of the field.

Publication settings

If you want to know the parameters with which an asynchronous workflow was published, repeat the step-by-step publication procedure, taking note of the values of the parameters, canceling the procedure before launching the actual re-publication.

  1. When a workflow is published, a ring icon is shown for every different status, with a number corresponding to the number of runtimes where the workflow is published and is in that status.

    So,for example, if a workflow is published in two runtimes and in both of them has the "green" status, only one green icon with number 2 is displayed.
    If, instead, the workflow is "green" in one runtime and "red" in the other, two status icons are displayed, one green and one red, each with number 1. ↩↩↩↩