Skip to main content

Edit the underlying workflow of a protocol

Workflows and elements can change and evolve over time, keep your protocols update with ease by editing the protocol workflow in situ.

Updated over 3 weeks ago

This document provides a step-by-step guide on how to edit the underlying workflow of a protocol, whether by duplicating an existing workflow or updating an existing protocol version.

Steps to Edit a Protocol Workflow

  1. Locate the Protocol: Navigate to the protocol folder and find the protocol you want to edit.

  2. Open the Protocol interface: Click on the three dots next to the protocol and select "Duplicate" to create a copy of the protocol for editing or “Update” to update an existing protocol. Note that you are only able to “Update” protocols that you have created. Protocols from other team members must be duplicated.

  3. Access the Workflow Builder: At the bottom of the page, click "Back to editing the workflow" to enter the editable workflow builder.

  4. Make Edits to the Workflow: Modify the workflow as needed. For instance, you can:

  • Remove or change elements that expose parameters to the end user.

  • Add new mixing elements and adjust parameters accordingly.

  • Change mixing modes (e.g., to using a "mix all onto all" mode).

  1. Update the Simulation Preview: After making changes, click on "Simulate" to run the workflow. This will allow you to see the simulation results. Click on the kebab menu in the simulation results card and then "View Simulation" to verify the changes. If you are satisfied with the changes, click "Update Protocol" on the simulation card to refresh the protocol preview with the one from the edited workflow.

  2. Edit Parameters: You can make several types of edits to your protocols:

    1. Once you have modified your protocol and updated the simulation, navigate back to the Protocol Definition.

    2. Remove any unnecessary parameters that are no longer required. If parameters from deleted elements were previously exposed to end users, they will be automatically removed from the Protocol.

    3. Add parameters for new elements and ensure you expose the necessary values (e.g., transfer volume, liquid name, etc.).

    4. Define outputs from any new elements you have added to the workflow within a new protocol step if necessary.

  3. Personalization: Navigate to the personalization page to update labels and descriptions if desired.

  4. Finalize Protocol Details: On the final page, provide a new name for the protocol and a description of the changes made. This can be a great way to signal to your internal users that the protocol has been updated and even to keep a change log of the protocol over time.

  5. Publish the Protocol: Choose to publish the protocol for personal use or broader access. Add any new tags that are required.

  6. Validate the Protocol: Click on the protocol card and select "Use Protocol" to check that the steps and outputs are correct. You can always re-adjust parameters as needed and ensure the workflow behaves as expected.

Summary

By following these steps, you can edit the underlying workflow of a protocol, ensuring it meets your requirements and accurately reflects any changes made.

Did this answer your question?