BrAPI Settings

Configuration

Brapi settings screen layout part 1

BrAPI Configuration Settings

url BrAPI Base URL

Set the server URL when importing via BrAPI.

Brapi settings base url

BrAPI Base URL setting

authorize Authorize BrAPI

Open the authorization page to login to the BrAPI server and allow Field Book to communicate with it.

version BrAPI Version

Set the version of the BrAPI specification that will be used to communicate with the server. Defaults to V2.

Brapi settings version

BrAPI version setting

page Page Size

Set the page size for BrAPI server responses. Defaults to 1000.

Brapi settings page size

BrAPI page size setting

chunk Chunk Size

Set the chunk size. Defaults to 500.

Brapi settings chunk size

BrAPI chunk size setting

timeout Server Timeout

Set the time limit in seconds to wait for a repsonse from the server before timing out. Defaults to 2 minutes.

Brapi settings server timeout

BrAPI server timeout setting

Advanced Auth Settings

Brapi settings screen layout part 2

BrAPI Advanced Auth Settings

version OIDC Flow

BrAPI server authentication version. Defaults to OAuth2 Implicit Grant.

Brapi OIDC flow setting

BrAPI OIDC flow setting

url OIDC Discovery URL

The location of the OIDC discovery JSON document.

Brapi OIDC url setting

BrAPI OIDC url setting

BrAPI Variables

display Value vs Label Display

Sets desired field for display when using a categorical trait the comes from a BrAPI Variable.

Brapi value label setting

BrAPI Value vs Label setting

Community Servers

barcode Scan a server barcode

Add a BrAPI server by scanning a URL barcode.

Advanced

Access servers from the BrAPI community.

Brapi whitelisted databases

BrAPI database whitelist