What is a workflow?

A workflow is a sequence of tasks that processes a set of data. It can, in an automated way perform several actions that would, otherwise, have to be invoked one by one. Within the EPISODES Platform, the tasks composing a workflow are the applications (see also Applications Quick Start Guide) - any set of applications present in your workspace can become a workflow. We will show the usage of the workflow mechanism on an example using the application Ground Motion Prediction Equations: GMPE calculation and two other applications that prepare data to be used in the former. The sequence of the applications used is:

1. Ground Motion Parameters Catalog builder (see the application user guide)
2. Catalog Filter (see the application user guide)
3. Ground Motion Prediction Equations: GMPE calculation (see the application user guide)

Normally, when used in workspace, the three applications have to be managed separately, therefore, to run the last application (Ground Motion Prediction Equations: GMPE calculation), one has to first run the Ground Motion Parameters Catalog builder, then use its results for Catalog Filter, and finally, on the results of the latter, create and run the Ground Motion Prediction Equations: GMPE calculation. The amount of work required for running such a sequence of application grows with the number of the component applications, while when using a workflow, the whole sequence is reduced to one operation. Figure 1 shows a comparison between the aforementioned sequence of applications located in workspace and a workflow created from them.

Figure 1. Comparison of application sequence in workspace and a workflow created from them 

Creating a workflow - step by step

The workflow view combines all application forms inside the merged directory. You can create a customized workflow view which shows you:

• Inputs and form applications inside workflow (you can customize which forms are visible)

• Running controls and combined status, which gives you the ability to execute all applications inside the workflow using a single RUN button - the system will execute all applications in the correct order. You can also monitor individual application statuses, save their forms or enable autorun for the entire workflow.

• Outputs form applications and visualizations inside the workflow. You can customize which outputs are visible to hide irrelevant intermediate results.

2. Creating a workflow

To create a workflow

1. make sure that the given directory contains all applications that should be included inside a workflow;
2. check if all applications have defined inputs and forms, try to execute them;
3. if applications can be executed you can use MERGE WORKFLOW action for the directory which should be merged into the workflow.

Merging workflow does not change the logical structure of applications inside. You can easily undo this operation by clicking EXPAND WORKFLOW action.

Let's take a look at the example set of applications for estimating ground motion prediction equation (GMPE):

1. GMParametersBuilder - Ground Motion Parameters Catalog builder
2. CatalogFilter - Catalog filter
3. GMPEEqsCalc - Ground Motion Prediction Equations: GMPE calculation

All applications are inside GMParametersBuilder directory with the inputs defined as follows:

Note that some inputs (LGCD_catalog.mat and LGCD_GMCatalog 343kb.mat) are outside the GMParametersBuilder directory. The inputs that are outside the merged directory will become workflow inputs.
To merge GMParametersBuilder directory to the workflow:

1. Use 3 dots menu near GMParametersBuilder directory, click MERGE WORKFLOW action:
2. Accept dialog box message:

Now the workspace structure looks like this. GMParametersBuilder workflow contains all outputs from the applications that were inside the GMParametersBuilder directory.

Workflow view shows you:

1. Inputs and forms
   1. Note that only inputs that were outside the merged directory are editable. In this case LGCD_catalog.mat and LGCD_GMCatalog 343kb.mat files were outside the GMParametersBuilder directory. Other inputs are hidden and blocked, you can modify them only after expanding workflow back to directory.
   2. Currently, GMParametersBuilder workflow does not have any forms but you can choose which forms are visible in the workflow edit view using the EDIT/ DEBUG WORKFLOW button. More on that in the Editing workflows section.
2. Controls for running a workflow RUN button will execute all applications inside the workflow in the correct order. You can save workflow forms using a SAVE button.
3. Status Status shows the overall workflow status and individual application statuses.
4. Outputs By default all application outputs are visible. you can choose which outputs are visible in the workflow edit view using the EDIT/ DEBUG WORKFLOW button. More on that in the Editing workflows section.

You can easily delete/expand workflow using EXPAND WORKFLOW action. It will restore the underlying directory so that the workspace structure is the same as before merging a workflow.

If you want to change the workflow structure e.g. add/delete applications or change their inputs you can expand it, modify the content of the directory and merge the directory into workflow again.

3. Editing workflow

You can customize which forms and outputs are visible in the workflow view by clicking EDIT / DEBUG WORKFLOW button:

In the edit view you can customize:

1. Workflow description and application names:
2. Which forms are visible. You can show/hide the form using + or - buttons:
3. Which outputs are visible. You can show/hide the form using + or - buttons:

To save changes click SAVE WORKFLOW TEMPLATE button:

4. Copying and sharing

Workflow can be easily copied and shared with other IS-EPOS Platform users using COPY and SHARE actions.

Use COPY action and select the target directory:

The workflow will be copied with all internal applications. Workflow template is also copied (visible forms, visible outputs, workflow description and application names).

Use SHARE action and provide the email address of the user you want to share the workflow with:

The user will receive an email with the link to your workflow.

They can add your workflow to their workspace using ADD TO WORKSPACE button. The workflow will be copied with all internal applications. Again workflow template is also copied (visible forms, visible outputs, workflow description and application names).

Video version of this guide

This guide is also available as a video: