Skip to main content

Updating a protocol

Learn how to update your existing protocols using version-controlled editing and publishing

Updated over 3 weeks ago

This document outlines the process for updating an existing protocol within the application. The update process involves creating a new draft of the protocol, making edits, and publishing it as a new version.

Steps to Update a Protocol

  1. Locate the Protocol:

    • Navigate to the protocols list page.

    • Find the protocol you wish to update.

  2. Access the Update Option:

    • Click on the :kebab-menu: on the far right-hand side of the protocol entry.

    • Select the Update option from the dropdown menu.

Protocols and user permissions

  • Only the author of a protocol can update it. Admins can only update their own authored protocols.

  • If you attempt to update a protocol authored by someone else, the update option will not be available. You can duplicate it instead, which allows you to make edits and create a new version under your ownership.

    Learn more about user roles here.

  1. Create a Draft:

    • Upon selecting Update, a notification will inform you that a new draft of the protocol will be created.

    This draft allows you to make edits without affecting the original protocol until you publish it.

  2. Edit the Draft:

    • Make necessary changes to the protocol. For example, you can add new steps or modify existing ones.

  3. Publish the Update:

    • After making your edits, proceed to publish the updated protocol.

    • You will be prompted with a notification indicating that the protocol will be published as a new version (e.g., Version 2) and will replace the previously published version.

  4. Confirm the Update:

    • Once published, navigate to the My Protocols section to verify the changes.

    • You can view the version history and switch between versions if needed.

Version History:

Synthace maintains a history of protocol versions, allowing you to see which version was used for a specific protocol run. By default, the most recent version will be loaded when accessing the protocol.

Key Differences Between Updating and Duplicating a Protocol

  • Updating: You are modifying the existing protocol and publishing a new version while retaining the original.

  • Duplicating: You create a copy of the protocol, which can then be edited independently.

This process ensures that all changes are tracked, and you can access previous versions as needed.

Updating tags and protocol visibility

If you want to modify a protocol's tags or visibility settings, simply “update” the protocol and modify these settings during the publication of your new draft.

Learn about publishing protocols here.

Did this answer your question?