With Laboperator workflows you can execute experiments by guiding lab technicians through procedures (e.g. based on a SOP) while at the same time interacting with lab devices and 3rd party software solutions. Workflow templates are written in yaml and follow the Laboperator workflow schema. Please conctact us if you want to learn more on how to create new workflow templates.
TABLE OF CONTENTS
- Uploading/downloading Workflow or Step Templates
- Creating a Workflow Run from Workflow Templates
- Parameterizing and starting a Workflow Run
- Executing a Workflow Run
- Pausing, Completing, Closing and Reopening a Workflow
- Repeating Steps and Sub-Steps
- Locking a Workflow Run
- Comment Feature
- Adding Workflow Steps at runtime
- Creating a Workflow Run from Workflow Step Templates
Uploading/downloading Workflow or Step Templates
Laboperator workflows are built on workflow templates or workflow step templates which are file based workflow descriptions. To upload a template click on the +ADD button on the navigation menu and select Workflow Template or Workflow Step Template. You can also choose the collection you want to upload the template to.
Note: You can upload a template with the same uuid and version only once.
Once uploaded, a template can be shared like any other resource in Laboperator from within the context menu. To download the YML-file of a template double click on the template and open the download tab in the context menu. You can also view a versions history in the context menu of a template.
Creating a Workflow Run from Workflow Templates
From a workflow templates you can create workflow runs that can be executed. Double click on the workflow Ttmplate and click on the start new workflow run button. The workflow run will open automatically. Beside, the workflow run will be available as a resource in my collection. Alternatively you can create a workflow run using the +ADD-button in the navigation menu and select Workflow Run. Choose start from uploaded template and select the template you want to create the workflow run from.
Parameterizing and starting a Workflow Run
After creating a workflow run you see the parameter page where you can parameterize the workflow run to a certain extend. Parameters which are marked with a * are mandatory before the workflow run can be started. After all mandatory parameters are set you can start the execution of the workflow run by clicking on start.
Executing a Workflow Run
After starting a workflow run you see the execution view of the workflow. Within the section of the navigation menu the different workflow steps are listed. You can hide the list by clicking on the menu button in the top left corner of the header. The content section displays the sub-steps and guides you through the workflow. Various actions can be implemented here, for example manual instruction or an automated data capturing from a device.
Pausing, Completing, Closing and Reopening a Workflow
In the top right corner of the header you find several buttons to control the workflow run. With x you can leave the execution view and return to the parameter page. From here you can navigate to all other Laboperator resources and functionalities and return to your active workflow run later. To reopen a workflow run open the corresponding resource and click on open execution view. This can even be done after completing a workflow run.
If you pause the workflow using the pause button within the execution view or on the parameter page the current workflow run will be paused. After pausing a workflow run you can restart it using the play button.
Clicking on the double tick will complete the workflow run right away, even if it's not yet completely worked through. If you have reached the end of a workflow run you’ll be asked to complete the run or add another step. If you complete the run you can exit the execution view by clicking on done or using the x in the top right corner.
Repeating Steps and Sub-Steps
While a workflow run is active (not paused) you can repeat steps or substeps by clicking on the corresponding buttons on the header.
Locking a Workflow Run
workflow runs can be locked at any time from the parameter page or within the execution view. A click on the lock button opens a window to confirm the locking.
Note: After locking the Workflow Run it can't be altered or edited anymore. Locking the workflow run can't be undone.
On the right side of the execution view you can comment your workflow run. To open the sidebar click on the speech-bubble button. You can even add links or pictures to your comments.
Adding Workflow Steps at runtime
If you have access to workflow step templates you can add steps at runtime. Click on the add step button in the bottom left corner of the navigation menu. Now you can select the steps you want to add. You then might parameterize the step and click on add step. The new step will be added at the end of the steps in the navigation menu and you can adjust the order using drag and drop functionality. Also at the end of a workflow you will be asked if you want to add another step.
Creating a Workflow Run from Workflow Step Templates
Beside starting a workflow run from a workflow template you can create your own workflow using workflow step templates. Click on the +Add button in the navigation menu and select workflow run. Choose start from blank template, insert a title and click on submit. You can further select the collection you want to add the workflow run to.
After creating the blank template you can open it from the collection you created it in. When starting the workflow run a list of available workflow steps is shown. Select and parameterize the steps at your will and click the start button in the top right corner.