Version: 3.8.1

Codebeamer

Supported Native Datatypes#

The following tables shows which native datatypes are supported and how they translate into symphony datatypes:

The adapter provides a builtin query that is based on the project and tracker specified in the configuration.

To allow customers more detailed control of the query, a custom query can be specified.

The custom queries available in the configuration are all saved views of the connected user.

Codebeamer instances might have enabled so called throttling. This means that the throughput of API calls is somehow limited.

By default the adapter is configured to wait 1 second before retrying the call if refused by the Codebeamer server with HTTP code 429.

The adapter will give up after maximum of 500 retries which means the Codebeamer server did not respond the call withing the last 8 minutes.

The OAUTH2 support is only available for symphony classic.

Experimental authentication support, not intended for production usage

The OAUTH2 support is based on the mechanism discussed in OAuth2 MTLS.

The following table summarizes all the java system properties that need to be configured in order to enable the OAUTH2 authentication:

Name	Example	Description
SYMPHONY_OAUTH2_TOKEN_ENDPOINT	https://localhost:8443//openid-connect/token	URL of the token endpoint
SYMPHONY_OAUTH2_KEYSTORE_LOCATION	/build/server-keystore.pfx	Location of the mTLS keystore in `PKCS12` format
SYMPHONY_OAUTH2_KEYSTORE_PASSWORD	secret	Password for the keystore
SYMPHONY_OAUTH2_TRUSTSTORE_LOCATION	/build/client-truststore.jks	Location of the truststore in `JKS` format
SYMPHONY_OAUTH2_TRUSTSTORE_PASSWORD	secret	Password for the truststore
SYMPHONY_OAUTH2_TLS_PROTOCOL	TLS	SSL protocol to be used
SYMPHONY_OAUTH2_CLIENT_ID	codebeamer	Client ID as specified in the identity provider
SYMPHONY_OAUTH2_USER	admin	Optional user name (empty string if not applicable)
SYMPHONY_OAUTH2_PASSWORD	admin	Optional password (empty string if not applicable)