Element parameter validation is there to guide you. It will help you identify the parameters that are missing, and find those that cause errors before simulating your workflow.
As you add elements to the workflow builder canvas and start entering parameter values, a pop up will appear on the current element that tells you the required parameters or any errors from the information you entered. It will also direct you to the specific parameters in the instance panel.
This will help you avoid small errors made during workflow building, and therefore result in you getting to a successful simulation faster, with fewer failed simulations in between.
What will you learn:
The different parts of element parameter validation
How to start element parameter validation
How to use element parameter validation in silent mode
The different parts of element parameter validation
Validation notification icon
The validation notification icon is next to the Simulate button in the workflow builder, and has three different notifications describing the current state of your workflow:
Successful validation
Validating
Validation error
Validation Notification Panel
The validation notification panel shows the notification status of specific elements and is also where you can silence the notifications.
Element validation error pop up
The element validation error pop up directs you to the element in an invalid state, and what the errors are.
Instance parameter highlighting
Invalid parameters are highlighted in red in the instance panel.
How to start element parameter validation
Element parameter validation does not start immediately as you add elements to the workflow builder canvas, but only after you start interacting with an element. Let’s start with a simple aliquot workflow as an example.
Add a Define Liquids and Plates and Aliquot element to the workflow builder canvas.
Connect the Liquids output from Define Liquids and Plates to the Liquids to Aliquot input of Aliquot.
Note: the element parameter validation has not yet been triggered while you are building the workflow.
Open the Define Liquids and Plates element instance panel by clicking the element.
Select Parameters in the Define From parameter drop down.
Note: Shortly after you have started to interact with an element's parameters, the parameter validation starts and a pop up appears associated with the element that has a validation error, along with the invalid parameter highlighted in the instance panel, and a validation notification icon next to the Simulate button. In this example, the required parameter Liquid Names is highlighted red with instructions in the pop up to notify you that this parameter is required.
Resolve the validation error by defining a liquid name.
Note: Resolving the invalid parameter error by filling in the required Liquid Names parameter with a value re runs the validation, and when successful clears the validation pop up. The validation notification icon next to the Simulate button will also display a green tick when there are no validation errors.
Open the Aliquot element instance panel by clicking the element
Change the Aliquot Volume parameter value to 100 ul to start the element validation for this element.
Note: Interacting with a parameter in the next element triggers its validation. Here you can see multiple parameters are invalid, and you are guided to resolve them.
Continue fixing the validation errors until all elements are successfully validated.
How to silence the element validation tool
As you become more proficient in workflow building you may not rely on the validation tool as much. Therefore, you are able to silence the validation pop ups so that your workflow building experience is less interrupted.
The element validation will still be running in silent mode and you will be able to launch the validation pop up for an invalid element when you are ready from the validation notification icon.
Click on the element parameter validation icon to open the validation panel.
Click on the toggle to enter silent mode
Add a Define Liquids and Plates and Aliquot element to the workflow builder canvas.
Connect the Liquids output from Define Liquids and Plates to the Liquids to Aliquot input of Aliquot.
Open the Define Liquids and Plates element instance panel by clicking on the element
Select Parameters in the Define From parameter drop down.
Note: In silent mode, element validation still runs and the validation error is logged in the validation icon. However, the element validation pop up and the parameter highlighting in the instance panel for the invalid element do not display automatically.
Display the validation pop up and parameter highlighting when in silent mode by clicking on the notification icon to open the validation panel and click on the invalid error notification.
Double clicking on the workflow builder canvas will remove the focus from the element you had highlighted, closing the instance panel and validation pop up.
Clicking on the invalid element again will open the instance panel back up in silent mode.