Using Workflows in Laboperator

TABLE OF CONTENTS

• Uploading/downloading Workflow
• Executing a Workflow Run
• Pausing, Completing, Closing, and Reopening a Workflow
• Repeating Steps and Sub-Steps
• Locking a Workflow Run
• Comment Feature

Uploading/Downloading Workflow

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.

schema_version: '1.0.1'
info:
  version: '0.0.1'
 
  uuid: c42accb9-dfc3-4230-9ca7-5ce95c8f71d1
  title: Test


fields:
  balance:
    group: Instruments
    title: Please choose a balance
    type: relationship
    resourceType: devices
    hidden: true


  stableWeight:
    title: Stable Weight
    type: string


steps:
  stepOne:
    info:
      title: test
   
    substeps:
      - primary: test
        expandDescription: true
        description: |
          !{{balance}}


          !{{stableWeight}}


        buttons:
          - label: Print
            key: keyPrint
            color: secondary


        behaviors:
          - when:
              on_manual:
                key: keyPrint
            do:
              - send_command:
                  device: balance
                  command: get_weight


          - when:
              on_data_point:
                  device: balance
                  channel: weight
            do:
              - set_field:
                  field: stableWeight
                  value: data_point.str_value
flow:
  - stepOne

Once uploaded, a template can be shared, moved, edited, deleted, etc. like any other resource in Laboperator. 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 version's history in the context menu of a template.

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 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. 

The top right corner of the header contains buttons to control the workflow run. The workflow run is active.

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 resume 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.

LabOperator asks for user confirmation to complete the workflow run. If it is confirmed, the workflow run is finished.

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.

Comment Feature

On the right side of the execution view, you can comment on your workflow run. To open the sidebar click on the speech-bubble button. You can even add links or pictures to your comments.