CDD Vault Update (November 2021): Protocol Fields and an API Endpoint for Dose-Response Curves

CDD Vault Update Logo
November 5, 2021

We may enjoy Fall as a time for S’mores and cozy blankets, but the CDD Dev team has just given you a couple of features that you are sure to enjoy almost as much as those marshmallows!

Protocol Fields

When creating Protocol definitions within CDD Vault, users have always been able to define the Protocol name, a Category, and a Description. These top-level Protocol annotations can now be modified and expanded to include additional Protocol fields. The Vault Administrator must create the new fields, for example SOP, Mode of Action, Assay Kit, Assay Target, etc.

To add additional Protocol fields, a Vault Administrator can navigate to the Settings > Vault > Protocol Fields page and click the “Add/Edit Protocol Fields” link (the pencil icon) located in the top right of this panel.

screenshot add edit protocol fields

Next, the Vault Administrator can:

  1. “Add a protocol field” at the bottom of the list of current Protocol fields
  2. Type in a Name for the new Protocol field
  3. Choose the data type (Text, Long text, Pick List or File)
  4. Select if the field is optional, required or conditionally required
  5. Repeat steps 1 through 4 as needed
  6. When finished, click the green “Update protocol fields” button in the lower right corner

screenshot update protocol fields

Users can then populate these new fields when creating Protocols. As a reminder, to create a new Protocol, click the “+ Create a new…”  button in the sidebar and select Protocol.

screenshot create a new protocol

A form containing all of the available Protocol fields is shown.

screenshot new protocol definition

Once the values are filled in, and the Protocol definition is saved, the Protocol Details tab will show the full definition of the Protocol.

screenshot protocol details

Noteworthy tips:

  • Values stored in these Protocol fields are keyword searchable within the Explore Data > Protocols
  • For “Text” versus “Long text” field types, the number of characters allowed in each are the same, this distinction only affects the size of the data input box and whether the special characters drop-down is displayed when creating a new Protocol definition. The “Long text” type will display a bigger text entry box that is resizable and the special characters drop-down is displayed so that users may insert special symbols (like a Greek character or the degree symbol).

Retrieve Dose-Response Plots/Curves via the API

API scripts may now retrieve dose-response curves/plots by using the GET plots API call. Here’s an example url syntax:

    https://app.collaborativedrug.com/api/v1/vaults/<vault_id>/batches/<batch_id>/protocols/<protocol_id>/plot?size=medium

Size is the only supported parameter with options for small (default), medium, or large.

This API call generates a png image of the dose-response plot for the specific Batch within the specified Protocol. png image of the dose-response plot