---
url: /workflow-management.md
---
# Workflow

The *Workflow* is the component that allows you to create your Data Science & Machine Learning pipeline.

## Workflow Management

To access the Workflow management screen, use the sidebar menu:

![sidebar-menu-with-workflows-section-highlighted](/images/sidebar-menu-with-workflows-section-highlighted.png)
*View workflows from the sidebar menu*

![workflows-management-page](/images/workflows-management-page.png)
*View the list of workflows*

### Viewing Workflows

From the Workflow management page, you can view public workflows, those belonging to your team, and your private ones.

For each of these, the following functions are available:

| Function | Button |
| -------- | -------- |
| Execute | ![execute-workflow-icon-button](/images/execute-workflow-icon-button.png) |
| Create *Template* | ![create-template-from-existing-workflow-icon-button](/images/create-template-from-existing-workflow-icon-button.png) |
| Edit | ![edit-workflow-icon-button](/images/edit-workflow-icon-button.png) |
| Delete | ![delete-workflow-icon-button](/images/delete-workflow-icon-button.png) |
| Report workflow | ![report-workflow-icon-button](/images/reportworkflowlogo.png) |

Clicking on the card itself will instead open the Workflow details panel.

![workflow-details-page](/images/workflow-details-page.png)
*Workflow details page*

Where, in the top right, additional functions will be available:

![workflow-details-page-top-buttons-set](/images/workflow-details-page-top-buttons-set.png)
*Additional workflow functions*

such as:

| Function | Button |
| -------- | -------- |
| View media generated by the *Service* of the *Workflow* | ![workflow-media-results-button](/images/workflow-media-results-button.png) |
| Select *Workflow* version | ![workflow-version-selector](/images/workflow-version-selector.png) |
| View annotations for the *Workflow* | ![workflow-notes-view-button](/images/workflow-notes-view-button.png) |
| Add the *Workflow* to a *Project* | ![workflow-details-page-manage-projects-icon-button](/images/workflow-details-page-manage-projects-icon-button.png) |
| Export the *Workflow* | ![workflow-details-page-export-workflow-icon-button](/images/workflow-details-page-export-workflow-icon-button.png) |

Within the same page, at the bottom, the following collapsible sections are also available:

* **Workflow:** to interact with the components of the *Workflow*

* **Datasets:** to view the list of input and output datasets along with a preview (![workflow-details-dataset-preview-icon-button](/images/workflow-details-dataset-preview-icon-button.png))

  ![workflow-details-datasets-collapsable-section](/images/workflow-details-datasets-collapsable-section.png)
  *Workflow Details - datasets section*

* **Models:** to view the list of input and output models, and download them (![workflow-details-model-download-icon-button](/images/workflow-details-model-download-icon-button.png))

  ![workflow-details-models-collapsable-section](/images/workflow-details-models-collapsable-section.png)
  *Workflow Details - models section*

* **Schedules:** to set and view the *Workflow execution schedules*

  ![workflow-details-workflow-schedulers-section](/images/workflow-details-workflow-schedulers-section.png)
  *Workflow Details - schedules section*

The following sections describe these features in more detail.

### Workflow Media (Multimedia Content)

Clicking on ![workflow-media-results-button](/images/workflow-media-results-button.png) will open the screen to view the multimedia content created by the *Service* components of the *Workflow* (see also [*Service* - Workflow Media](./io-ports.md?h=workflow#porta-di-ouput-speciale-per-workflow-media)):

![application-media-panel-open](/images/application-media-panel-open.png)
*Workflow Details - workflow media panel*

From here you can:

1. View the multimedia content generated by each *Service*
2. Select the specific execution to view the content for

### Version Selection

From the Workflow details page, you can access the version selector:

![workflow-version-selector](/images/workflow-version-selector.png)
*Access the version selector*

From there, you can select a specific version and perform various operations on it:
executions, modifications, etc.

![workflow-specific-version-selected](/images/workflow-specific-version-selected.png)
*Select a specific version*

The selection will be temporary. If you want to set a specific version as default, click on the ![star-icon](/images/star-icon.png). From that moment on, the card of the *Workflow* in the catalog will point to this version.

![workflow-specific-version-set-as-default](/images/workflow-specific-version-set-as-default.png)
*Set the default Workflow*

### Viewing Annotations

Clicking on ![workflow-notes-view-button](/images/workflow-notes-view-button.png) will open the list of annotations assigned to the *Workflow*:

![workflow-details-page-view-workflow-annotations-button](/images/workflow-details-page-view-workflow-annotations-button.png)
*Workflow annotations list*

### Adding to a *Project*

Clicking on ![workflow-details-page-manage-projects-icon-button](/images/workflow-details-page-manage-projects-icon-button.png) will open the dialog that allows you to add the *Workflow* to a *Project*.

The available *Projects* are those previously created from the dedicated section (see [Asset -> Projects](./projects-management.md))

![add-workflow-to-project-dialog](/images/add-workflow-to-project-dialog.png)
*Assign workflow to a project*

### Exporting

Clicking on ![workflow-details-page-export-workflow-icon-button](/images/workflow-details-page-export-workflow-icon-button.png) will allow you to export the *Workflow* in various formats:

* Standalone
* Manifest

![workflow-export-modes-dialog-with-dropdown](/images/workflow-export-modes-dialog-with-dropdown.png)
*Workflow export*

Selecting the **Standalone** mode will allow you to download a Docker Compose stack implementing the *Workflow* and designed for execution locally or on systems other than ALIDA.

Selecting the **Manifest** mode will instead allow you to download the equivalent Kubernetes version in manifest JSON format.

### Scheduling

From the *Schedules* section, you can schedule the *Workflow* execution through *Cron* expressions.

![workflow-details-workflow-schedulers-section](/images/workflow-details-workflow-schedulers-section.png)
*Create workflow scheduler*

*Workflow scheduler form*

## Creating a *Workflow*

* For instructions on creating a *Workflow*, please refer to the [Create Workflow](./quickstart.md#3-creazione-workflow) section of the Quickstart.

* For the features available in the *Workflow Designer*, please refer to the [Designer](./designer-overview.md) section.

In this section, we will illustrate some additional functions useful in the creation and modification phases of a *Workflow*.

For the examples, we will take as reference the *Workflow* created during the Quickstart.

![quickstart-workflow](/images/quickstart-workflow.png)
*Workflow Designer page*

#### Preliminary Settings

Immediately after clicking the **Create Workflow** button, the following form for preliminary settings will open:

![preliminary-workflow-settings](/images/preliminary-workflow-settings.png)
*Enter preliminary workflow information*

containing the following fields:

* **Access Level**
* **Default Data Source**

***Access Level*** determines the visibility level of the *Workflow* asset (as seen in [Basic Concepts](index.md#basic-concepts))

***Default Data Source*** allows you to select the default *Datasource* to which all *Service* components of the *Workflow* will point for saving results. This default configuration can then be changed for each *Service* from within the *Workflow Designer* (see *I/O Ports Settings* section below).

#### General Information

* The *Workflow Designer* will only allow the connection of compatible ports.

#### I/O Ports Settings

Clicking on one of the ports of the blocks on the canvas will open a configuration form on the *Element Details* panel, whose content will depend not only on the port type but also on the block type (service, dataset, ...).

For example, clicking on the input port of the dataset type of the KMeans *Service*, we find
the possibility of selecting - through the relative checkboxes - which columns of the dataset
actually pass to the *Service*.

![elements-details-panel-showing-service-input-dataset-port-configurator](/images/elements-details-panel-showing-service-input-dataset-port-configurator.png)
*Designer - detail of the dataset input port*

Clicking instead on the output port of the dataset type of the *Service*, we can on the right select the destination datasource
for the dataset output.
![elements-details-panel-showing-service-output-dataset-port-configurator](/images/elements-details-panel-showing-service-output-dataset-port-configurator.png)
*Designer - detail of the dataset output port*

#### Selection of execution *Target* for *Services*

For each *Service* that composes the *Workflow* it is possible to set a *Target*.

The *Target* determines the set of nodes in the cluster that are candidates to host the execution of the *Services* that have been assigned to them.

The possible *Targets* must be previously defined by the system administrator
from the control panel (see [Managing Targets](./targets-management.md))

#### Annotating the *Workflow*

ALIDA allows, from *Workflow Designer*, to assign a set
of structured notes to the *Workflow*. Notes that must be previously defined by an
administrator from *Control Panel* (see [Defining Annotations](./redis-variables-management.md#defining-annotations)).

To associate structured notes to the *Workflow*, open the management panel
by clicking on ![notes-button-large](/images/notes-button-large.png).

![workflow-designer-with-notes-button-highlighted](/images/workflow-designer-with-notes-button-highlighted.png)
*Designer - Assign annotations to workflow*

At that point, the procedure for adding and managing notes is identical to that described for the
*Services* ([Annotating Services](./service-management.md#annotating-services)).

#### Automatic Valorization of Port Parameters

When connecting *Services* to each other, ALIDA will assign the values of the arguments (those defined in the metamodel)
of the output port of a *Service* to the corresponding ones of the input port of the next *Service* in the *Workflow*.

**Example**

![two-services-coupling-example](/images/two-services-coupling-example.png)

## Modifying a *Workflow*

It is possible to modify a *Workflow*, or quickly modify the properties of a *Service* that composes it, by clicking on the ![edit-workflow-icon-button](/images/edit-workflow-icon-button.png).

### Versioning

Each time a modification is made, the *Workflow* will be versioned:

![workflow-details-page-with-versions-button-highlighted](/images/workflow-details-page-with-versions-button-highlighted.png)
*Workflow Details - View current version*

and it will be possible to set a previous version as default

![workflow-details-page-with-versions-list-and-star-button-highlighted](/images/workflow-details-page-with-versions-list-and-star-button-highlighted.png)
*Workflow Details - Select version from the list*

## Executing a *Workflow*

Once the *Workflow* has been configured and created, it can be executed or scheduled
for execution. If configured, ALIDA will also send the relevant notifications about its execution status.

### Namespace Selection

Clicking on ![execute-workflow-icon-button](/images/execute-workflow-icon-button.png), if the system administrator has defined additional namespaces from [*Control Panel*](./redis-variables-management.md#defining-namespaces), a popup will open for namespace selection.

Here, it is worth knowing that a namespace refers to an area of the cluster dedicated to the execution of the *Workflow*. Multiple namespaces can differ in security policies, available computing resources, and more (Consult your system administrator for more information).

![workflow-namespace-selection-popup](/images/workflow-namespace-selection-popup.png)
*Select namespace*

### *Workflow* Statuses

* `READY`: The *Workflow* has just been created and is ready for execution
* `STARTING`: The *Workflow* is in the initialization phase. Resources are being allocated for it
* `RUNNING`: The *Workflow* is currently running
* `COMPLETED`: The *Workflow* has completed execution. Results are available
* `STOPPED`: The *Workflow* has been manually stopped by the user
* `ERROR`: The *Workflow* has failed due to an error

### *Service* Logs of the *Workflow*

From the Workflow details page of an executed or running Workflow, you can access the logs of the individual *Services*
that have passed the initialization phase (status `STARTING`).

As indicated in the figure, clicking on ![show-logs-button](/images/show-logs-button.png) will open the log viewing panel.

![workflow-details-page-with-service-logs-dialog-open](/images/workflow-details-page-with-service-logs-dialog-open.png)
*Workflow Details - View logs*

From here, clicking on ![download-log-files-button](/images/download-log-files-button.png) will also allow you to
download a copy of the logs locally.

## Deleting a *Workflow*

Clicking on ![delete-workflow-icon-button](/images/delete-workflow-icon-button.png) will allow you to delete a *Workflow* from the catalog.

ALIDA will ask for confirmation:

![workflow-deletion-confirmation-button](/images/workflow-deletion-confirmation-button.png)
*Confirm workflow deletion*

## *Workflow* Report

By clicking on ![report-workflow-icon-button](/images/reportworkflowlogo.png) it will be possible to download a report on the *Workflow* in ZIP format.

This archive will contain:

1. **report.html**: an HTML file with information about the *Workflow* and in particular about each *Run*, *Dataset*, *Model*,
   *Datasource* and *Service* used.
2. **media**: a folder containing any files generated by the *Services* of the *Workflow*.
   Additionally, this will contain a subfolder for each *Service* that has generated a file. The subfolder will be identified by the `id` of the *Service* and will contain the generated data by it.

![report-workflow-example](/images/reportworkflowexample.png)
*Example of the HTML page generated as a report*

## Creating a *Template*

Clicking on ![create-template-from-existing-workflow-icon-button](/images/create-template-from-existing-workflow-icon-button.png)
will allow you to create a *Template* from an existing *Workflow*.

Visit [Workflow Templates Management](./workflow-templates-management.md) for more information.