Codebeamer Widget

The OSLC Connector for Codebeamer widget is used to facilitate the communication between Codebeamer and the OSLC Connector for Codebeamer plugin and integrate it in the Codebeamer UI.

The OSLC Connector for Codebeamer is provided as a docker image, available in the repo.mid.de repository as sfit-oslc-generic-plugin-codebeamer

⚓ Requirements

1. Codebeamer Felicity or later

2. Install the OSLC Connector for Codebeamer plugin

3. Enable the technical user for TRS

4. Configure users to have Codebeamer REST API access

5. Enable external scripts in Codebeamer and provide them

6. Set the extension.json

📘 Enable the technical user for TRS

1. genOSLC requires a technical user with access to codeBeamer projects that needs to get synchronized using the TRS feed

2. Trackers must contain the “OSLC Links” field and be configured to use the “oslcLinks” shared field

📘 Configure users to have Codebeamer REST API access

The OSLC Connector for Codebeamer sends requests to Codebeamer’s API in the user’s name. To do that, the user needs to have Rest / Remote API - Access. Rest / Remote API Access can be set by editing the User Groups.

📘 Enable external scripts in Codebeamer and provide them

In System Admin → Application Configuration add the following snippet:

"externalScripts" : {
  "enabled" : true
}

Next, download https://<genOSLC base URL>/cb/assets/genoslc_cb_extension.js. Copy the file to <codebeamer Installation dir>/repository/config/customization/js, before starting codebeamer.

More documentation on External JavaScript Extentions supported by Codebeamer can be found here.

📘 Set the extension.json

To tell Codebeamer to load OSLC Connector for Codebeamer plugin the externalWidgetExtensions needs to be configured. Navigate to System Admin → Application Configuration add the following snippet

"externalWidgetExtensions" : {
    "uri" : "https://<genOSLC base URL>/cb/assets/extension.json"
}