Skip to content

Get information about workflows

Browse workflows and get summary information

  • To get the list of all the public workflows go to the Workflows page.

  • To get the list of the workflows of a project:

    • Select the project: the list of its workflows is displayed in the right panel.

    Or:

    • Open the project and select the Workflows tab on the toolbar of the project's workspace.

  • To get the list of workflows using a given public model, in the Models page select a model with Workflows on or Workflows off greater than zero. In the right panel you will see the list of workflows containing a block for the selected model.

  • To get the list of workflows associated with a given runtime, in the Runtimes page select a runtime. Currently published workflows are listed under the Published workflows tab while unpublished workflows which have been published inside the runtime at least once in the past are listed under the Unpublished workflows tab.

  • To get the list of workflows associated with a public API key, in the API keys page 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 Only published.

    Note

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

The information shown for each workflow, which varies based on the the list, is:

  • Name
  • Owner, which can be referred to also as creator or author
  • Publication status, represented by a colored ring icon1
  • Date, time and author of the latest publication
  • Date, time and author of the last modification
  • Number of blocks, possibly represented by the icon of an hexagon
  • Amount of CPU required by the blocks in the diagram, possibly represented by the icon of a gauge
  • Amount of RAM required by the blocks in the diagram, possibly represented by the icon of a chip
  • Amount of CPU and RAM required by the asynchronous services shared between all blocks (to be considered only in case of publication in asynchronous mode)
  • Associated runtimes
  • Associated API keys

Some information can be represented by icons only. In those cases you can get a descriptive tooltip by hovering over the icon.

Read the article about using the elements of the UI to learn about sorting, filtering and making other uses of the lists.

Get status detail

To get detailed information about the workflow publication 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 inside each of them. 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 definition

If you want to know how a workflow is designed and have information about its component blocks, open it. The current page 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 icon of an hexagon
    • Amount of CPU required by the blocks in the diagram, to the right of the icon of a gauge
    • Amount of RAM required by the blocks in the diagram, to the right of the icon of a chip
    • Publication 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.

    • If the workflow has been changed after being [published]((../publish/index.md) in one or more runtimes, there will be be a message like To update on runtime, to indicate that the published workflow doesn't correspond to the current version.
    • If a new version of the workflow was created by another user after you opened the workflow, where will be a Refresh link. Select it to make the editor show the current version of the workflow.

  • The current version of the workflow is displayed on the toolbar above the canvas on the right.

  • 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.
  • To see the input format definition, select Input format definition on the toolbar above the canvas on the right.

Get publication overview

To get an overview of which, if any, versions of the workflow are published in available runtimes:

  1. For public workflows, in the Workflows page, select the workflow then select the details button on the toolbar above the list.

    The detail view in the Workflows page allows looking at the details of a workflow at a time. The controls on the left of the toolbar above the list allow you to move between workflows.

  2. If not already selected, select the Overview tab.

Or:

  • For project workflows, in the project workspace, select the Workflows tab then select the workflow in the left panel and the Overview tab in the central panel.

The overview is a list with an entry for each published version of the workflow.
If a version is published in multiple runtimes, there is only one entry for it and all runtimes are indicated by icons.
If there is a current version that is more recent than the published ones, an entry is shown for that version as well.

Get load information

To get detailed information about the load generated by a workflow in terms of CPU, memory and storage:

  1. For public workflows, in the Workflows page, select the workflow then select the details button on the toolbar above the list.

    The detail view in the Workflows page allows looking at the details of a workflow at a time. The controls on the left of the toolbar above the list allow you to move between workflows.

  2. If not already selected, select the Load manager tab.

Or:

  • For project workflows, in the project workspace, select the Workflows tab then select the workflow in the left panel and the Load manager tab in the central panel.

The load manager is a list with an entry for each published version of the workflow.
If a version is published in multiple runtimes, there is only one entry for it and all runtimes are indicated by icons.
If there is a current version that is more recent than the published ones, an entry is shown for that version as well.

  • To expand and collapse the detail of a version of the workflow, use the expand and collapse buttons to the left of the version number.

The list has an entry for each workflow component that generates or can generate runtime load, plus two rows of totals: the total load for synchronous publication—if allowed—and the total load for asynchronous publication.

The list can be sorted by component name.

The load elements are a subset of the deployment properties of each block, that is:

  • (Shown only for individual components, not in totals) The number of replicas.
  • The minimum request of memory.
  • The memory limit.
  • The minimum request of CPU.
  • The CPU limit.
  • The minimum request of ephemeral storage.
  • The ephemeral storage limit.

For individual components, data that do not affect the load, such as timeout and number of consumers, are also shown.

Labels

To see any labels associated with a workflow:

  1. Open the workflow.
  2. Select Labels on the toolbar above the canvas on the right.

Get API information

To find out the endpoints of the workflow in a given runtime and the API keys to which the workflow is associated, in order to use a published workflow programmatically:

  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 EI-Flow designer 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.

Get the workflow's description

To find out the description 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 Description field.

Publication settings

If you want to know the parameters with which a 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. ↩↩↩