v28 BMS and Fieldbook app v6.0.0 data transfer via BrAPI using OIDC OAuth 2
- Corina Habito
BMS version 27 has been thoroughly tested and confirmed as compatible with the specific Fieldbook version indicated on this page title. The use of other/newer Fieldbook versions downloaded from Github is at your own risk.
About Fieldbook app
Fieldbook app can be downloaded for free from Google Play or from Github
Fieldbook is an application that can be installed on Android tablets and phones. It was developed to work primarily on a tablet, but its performance on phones is very good.
Fieldbook App connects to BMS using BrAPI or export/import of Studybook files.
Citation : Rife, T.W.and J.A.Poland (2014) Field Book: An Open Source Application for Field Data Collection on Android. Crop Sci.54(4): 1624 – 1627.
Instructions
Open the Fieldbook Application and go to Settings.
Under Settings, go to BrAPI.
Enable BrAPI to access its configuration.
Go to BrAPI Version and select option V2.
Under Auth Settings, open OIDC Flow then select the option OAuth2 Implicit Grant
Open OIDC Discovery URL (the location of the OIDC discovery JSON document).
Scan a barcode with the URL or define it as https://www.<institute’s BMS URL address>/bmsapi/<crop name>/.well-known/openid-configuration, for this tutorial use: https://trial-as.ibp.services/bmsapi/rice/.well-known/openid-configuration
Click OK.
Open Base URL. Scan a barcode with the URL or enter the BrAPI Base URL https://<institute’s BMS address>/bmsapi/<crop name> . In this tutorial use : https://trial-as.ibp.services/bmsapi/rice/
Click Authorize.
It will launch the BMS Authorization page on a web browser of the Android device. Enter the BMS login Name and Password and click on Sign In.
Click Authorize.
Click Import Source and Export Source to the BrAPI server as default Import and Export Source. Click Save.
To get the studybook (Fields) instances, return to main screen and then click on FIELDS.
To add environment instance into Fieldbook. Click on the +.
Environments may be filtered by program or by trial. Select Filter by program.
Select Rice Demo Program. Click Select Program.
Observation Level must be set to PLOT if you wish to collect data at the plot level
Select an environment from the List.
Click Preview Field. This allows users to check the field before saving. Click Save.
Click on Traits to select the traits that will be measured. Please take note that traits from other fields/environments will also be in the list of traits.
To start entering observed values, click “COLLECT”.
Collected observation values can be exported to BMS by clicking Export.
The number of new or modified observations will be shown. In this example, 8 New Observations have been collected. Click Export.
“BrAPI Export Successful” message shows up if the export is successful.
When you go back to BMS, the observation tab will be highlighted with an orange line to show that the observations has pending data.
Click Accept to update the BMS trial with the collected data from Fieldbook.
Other Fieldbook Installation and Settings instructions:
In the General Settings, set the Default import and export source as BrAPI.
Installation from downloaded .apk file
Download APK file. It will usually go to the downloads folder.
Click on the file <Field-Book-version.apk>
Click install
Open the app.
Specify a Storage Location by clicking Choose a folder.
Select the permission to allow access to photos and videos.
Select or create a new folder for Fieldbook to use. Click CREATE NEW FOLDER.
Type-in the name of the folder. Click OK.
Click Use this Folder.
Click Allow to allow access to the newly created folder.
Click permissions. Best to use While using the app.
Alternative workflow: OIDC OAuth 2
For this flow to work it’s mandatory to provide either an environment property BASE_URL or set the property directly in
bmsapi/WEB-INF/classes/application.properties. This is needed for BMSAPI to know the public url in cases where it’s running behind a proxy.For the moment this flow only works in https
Important: Android supported links
Make sure the Android setting Open supported links is set to Open in this app instead of “Ask every time”, for the link fieldbook.phenoapps.org
Related articles
https://ibplatform.atlassian.net/wiki/spaces/DT/pages/2477195339