v26 BMS connection with Fieldbook app v5.6.5 via BrAPI using OIDC OAuth 2
Field Book is an open source android application developed as part of the broader PhenoApps initiative. It is used for data collection in the field or lab. Fieldbook App connects to BMS using BrAPI or Studybooks files.
It can be downloaded at http://phenoapps.org/apps/ or from Google Play store.
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.) and 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://bms-uat.ibp.services/bmsapi/bean/.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://bms-uat.ibp.services/bmsapi/bean/
Click OK.
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 the option Field Book, Just once.
After a Succesful conection message, Fieldbook APP is ready to download Studybooks from BMS.
To get the studybook (Fields) instances, return to main screen and then click on FIELDS.
To add environment instance into Fieldbook. Click on the + and select BrAPI
Environments may be filtered by program or by trial
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 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.
Data can be exported using Local storage or via BrAPI.
The number of new or modified observations will be shown. In this example, 4 New Observations have been collected. Click Export.
“BrAPI Export Successful” message shows up if the export is successful.
ADDITIONAL Settings:
In the General Settings, set the Default import and export source as BrAPI.
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
See also: https://ibplatform.atlassian.net/wiki/spaces/DEV/pages/2486730793/How+to+connect+use+connect+with+BMS+using+OAuth#Option-2%3A-BrAPI-v2-OIDC-%2F-OAuth-Authorization-flow
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