v1.2 Field Book (v6.2.2) Connections with DeltaBreed

In this training module you will learn how to connect DeltaBreed to Field Book via BRAPI and pull environments with observation variables (ontology) from DeltaBreed.

Kristen Lind
29 steps
58 seconds

These training materials take you through setting up a connection with Field Book v6.2.2 which has a different workflow for Field Book/DeltaBreed setup than previous and later version.

Important information to know before you begin

In order to import experiment ontologies (traits) into Field Book via BrAPI from DeltaBreed, you must first have experiments with field locations imported into DeltaBreed. Please note that you will need to use Field Book to scan a QR code within DeltaBreed so you will need two devices to set up the connection.

In DeltaBreed, the terminology is slightly different than Field Book, though the words mean similar concepts. \ DB "Environment" = "Field" in Field Book\ DB "Experiment" = "Trial" in Field Book\ DB "Observation variable" or "Ontology" = "Trait" in Field Book

Connect Field Book v6.2.2 to DeltaBreed

Remember that you can always check and see what version of Field Book you are running in the "About" view within the Field Book application.

About screen in Field Book showing version is 6.2.2.

When you are in the Field Book application, select the "Settings" option.

Main menu of Field Book with "Settings" highlighted

Within the Settings menu, choose "BrAPI".

Settings menu options with BrAPI selected.

In the "Breeding API" menu click on the barcode icon in the upper right hand corner of the screen. This is specially configured for the Field Book/DeltaBreed connection.

Breeding API menu with scanning barcode highlighted

Click on the checkbox next to "Enable BrAPI". When the the box seen below pops up, select "import new settings".

On a separate device, sign into your DeltaBreed production account by using your ORICD ID associated email and password. - Once you are in to Deltabreed, look at the left hand menu. - Click on BrAPI. - Click on the "Field Book BrAPI Settings" tab. - Use the Field Book camera (make sure that your camera is enabled) to scan the QR code. **Note that the other tab "BrAPI Base URL" and access token can be used together to connect other BrAPI enabled applications to DeltaBreed for the purposes of pulling data from the system. Pushing data back into DeltaBreed is not operational at this time and requires a flat file transfer.**

The system will then reroute you to a DeltaBreed sign in page. You will need to sign in using the same login information that you used to login on your laptop.

Once you have logged in. Authorize Field Book.

Once authorized, Field Book will ask you if you want to make this BrAPI server the default for "import source" or "export source". Choose "import source" as the export feature needs more development and is not operational at this time. Remember to click "save".

Field Book and DeltaBreed are now connected via BrAPI!

Pull DeltaBreed Environments (Experiments) and Traits (Observation variable or ontology) into Field Book

There are currently two use cases that exist when a user wants to pull ontology or observation variables into Field Book from DeltaBreed. Both require a BrAPI connection between Field Book and DeltaBreed. 1. Your experiment in DeltaBreed contains the variables you wish to measure. You can then pull the entire experiment into Field Book (recommended). 2. Your experiment in DeltaBreed does not contain the variables or ontology terms you wish to measure and you want to add those without appending your DeltaBreed experiment first.

Pull complete experiment and ontology from DeltaBreed into Field Book

In the main view of Field Book, click on "Fields".

Click on the green "+" button to add a field that is now available because of the BrAPI connection.

Select the field you wish to import.

Once selected, import options are available such as the level of collection and sorting options. Note that if you are collecting sub-entity datasets

Once selected, import options are available such as the level of collection. Users can change how plots, plants, tanks, etc. are sorted for data collection.

Once that field is imported, click on the field to see the drop down menu options. From here you have various options. You can also use the "sort" option to choose how to sort the experiment for collection.

Before collecting data, navigate to the "Traits" screen and double check that only the traits you wish to collect data on are selected. If no traits are available, see next section to pull in traits from your DeltaBreed program. (Step 17 below)

You can now collect data. Remember that to put this data back into DeltaBreed you will need to do a flat file transfer after you download the data from Field Book. Once you have collected your data, contact your BI Coordinator. They will be able to take your flat files, convert them into DeltaBreed format, and upload them into your DeltaBreed program.

Add variables directly from Field Book

In this example, the experiment file does not contain the ontology terms or observation variables that are to be measured or you need to bring in new traits that are present in DeltaBreed. In order to pull those variables for collection on Field Book, they do need to be present in your DeltaBreed program.

When you are in Field Book, and **after you have connected via BrAPI to DeltaBreed**, pull your experiment just as previous training steps have shown. After you have pulled in your experiment, go back to the main Field Book screen and click on "Traits".

Notice that there are currently no traits.\ Click on the + button in the lower right hand corner.

Click on the "DeltaBreed" option. Note that you must be connected to DeltaBreed via BrAPI. If you are not, the Field Book system will prompt you to connect.

BrAPI will pull all associated traits from DeltaBreed into Field Book.

Select the traits you wish to measure by clicking in the box on the right hand side and then click on "import".

Select trait screen with traits selected and import button highlighted

Field Book will double check that those are the traits you wish to import. If you want to change them, click on the back arrow in the upper left hand side of the screen. If you are happy with the selections, click on the "import" button at the bottom.

Traits for selection with import button highlighted

Those traits are now listed under the "traits" menu and can be used for data collection.

It is highly recommend that before a user starts data collection, that they double check that the desired traits to be collected are the correct ones that are selected in Field Book. There is a behavior that selects multiple traits when multiple fields are pulled on to the same device. Best practice would be to double check what traits are selected before data collection begins.

Export Field Book data to a flat file

Choose "export".

Remember that currently in v1.0, users are not able to export directly back into DeltaBreed so they must choose "local" and then format the flat file to upload separately into DeltaBreed. At this time, DeltaBreed cannot store photos. Those will need to be kept locally.

BI recommends exporting this file in database format. For Field Columns, select "all imported columns". For Traits, select "only active traits". If you choose all traits, traits that are not currently in use for this data collection will also be included in the export. Do not choose overwrite previous export. Click "Save".

Field Book screen with database, all imported columns and active traits selected.

You will then have access to the flat file. Choose where to store or how to share.

Share your Field Book flat file with your BI Coordinator

Share the file you exported from Field Book with your BI Coordinator so that they can upload your observations into your DeltaBreed program. BI Staff will use the flat file of your observations to create a DeltaBreed compatible file for upload. They may have additional questions as they upload into DeltaBreed.

Once BI staff have uploaded and validated your observations, you can view them within your experiment in the "experiment & observations" view screen within DeltaBreed.

DeltaBreed experiments screen that shows observations

You have completed all of the training materials for DeltaBreed v1.2. Please contact us if you have any questions or concerns at [bi-science-team@ufl.edu](mailto:bi-science-team@ufl.edu) or Kristen Lind, Training & Communications Lead at [kristenlind@ufl.edu](mailto:kristenlind@ufl.edu).