v22 BrAPI-Sync (beta)
About
BrAPI-Sync is integrated in v22 of the BMS. The main goal of this BrAPP is to synchronize germplasm, study metadata, and observations between BrAPI-compliant databases. A parameter setting makes it possible to disable it for a given installation if so desired.
BrAPI-Sync is BETA functionality with known usability limitations. Expect to see improvements in future versions.
The use of BrAPI-Sync requires a crop-level BMS access role on both source and destination databases.
BrAPI-Sync is accessed from the Crop Administration section of the main, left-hand menu of the destination system.
Selecting the BrAPI sync (beta) option opens the dialog for choosing the source system to be synced with.
After choosing a Source, pressing the Login button launches a Login dialog on the Source system:
After pressing the Sign In button, a dialog verifying that you are authorizing access by BrAPI-Sync appears:
One signed in, you are returned the the BrAPI-Sync page for selecting the Source program (program on the remote system) and the Destination program (the local program that will be updated based on the remote system):
Pressing the Next button brings the dialog for choosing whether to synchronize germplasm, study metadata, or observations.
Germplasm
In order to synchronize Studies, the Germplasm must already exist in the destination system so the normal workflow would be to first sync a germplasm list that contains the germplasm used in a given study. Selecting Germplasm and clicking next brings up a filter dialog for choosing a study from which to import germplasm:
With a study selected, the germplasm contained in that study will be listed. Any germplasm that already exists in the destination system will have a green checkmark next to it:
In the example above, 100 germplasm entries are to be imported.
Selecting germplasm by clicking on the box(es) next to the ID and clicking the Import button will import the selected entries and a message regarding the status of the import process:
Once all of the germplasm entries for a study have been imported, clicking the Back button will return to the main BrAPI-Sync page for selecting what to synchronize.
Studies (metadata)
Selecting ‘Studies’ and pressing the Next button brings up the same Filter dialog as for selecting germplasm. Once a study is selected, a description of the study from the source system is displayed along with the option to import the meta-data of the study.
Note that a study in the BrAPI definition corresponds to an environment or instance in a Trial in the BMS sense.
In the following screen-shot, the meta-data for a study with 100 entries and 10 reps for 1000 plots is to be imported:
The following screen shows that it was successfully imported:
Once the study meta-data have been imported, the observations can be imported.
Observations
Having selected the previous example with 100 entries and 10 reps, the next dialog displays the traits that are to be synchronized:
After clicking the ‘Import Variables’ button, a Success message is displayed and the ‘Next’ button becomes active and will bring up the page for importing the observations:
After clicking the ‘Import Observations’ button a success message will appear indicating that the data have been imported.
Checking the observations tab of the newly imported study shows that they have been successfully imported:
The observations will be imported as pending observations, giving the user the opportunity to verify that they are correct and consistent with the local data requirements before accepting as committed observations.