26.2.1

This document describes how to upgrade an existing IQNECT tenant to version 26.2.1. This migration requires changes on both the IQNECT side and the connected system side, including deployment of a new extension and additional system configuration.

Prerequisites #

Before starting the migration, confirm the following:

1. You have Codebeamer administrator access.
2. You have file system access to the Codebeamer server.
3. You have IQNECT tenant administrator access at https://app.iqnect.ai.
4. You have identified the Integration user for each connected system, and that user has access to all relevant items that must be indexed.
5. You have a maintenance window available, because the Codebeamer server must be restarted.

What changed in 26.2.1 #

This release changes how Codebeamer systems are connected to IQNECT.

In previous versions, the IQNECT Codebeamer widget obtained data from two sources:

1. The IQNECT server, which is the source of truth for data and configuration.
2. The connected system directly, for example to fetch item titles and item contents.

As of 26.2.1, the IQNECT Codebeamer widget only communicates with the IQNECT server. IQNECT is now responsible for reaching the connected system on behalf of the user by using delegated authorization. If the system is not publicly accessible, IQNECT can connect through the tunnel relay.

This release also changes how indexing works. Previously, the Codebeamer IQNECT extension sent full item contents to IQNECT for indexing. As of 26.2.1, the extension only sends item metadata. IQNECT then fetches the full item contents directly from Codebeamer by using the configured Integration user. The Integration user must have access to all relevant items that should be indexed.

Runtime data flow before 26.2.1 #

Runtime data flow as of 26.2.1 #

Indexing flow before 26.2.1 #

Indexing flow as of 26.2.1 #

Migration order #

Perform the migration in the following order for each Codebeamer-connected environment:

1. Update the Codebeamer extension and application configuration.
2. Restart Codebeamer and confirm that the extension is loaded.
3. Update the IQNECT tenant version to v26.2.1.
4. Reconfigure each connected system in IQNECT for the new connection model.
5. Configure the Integration user in the Integration tab for each system.
6. Run the delegated authentication flow by clicking Connect for each system.
7. Verify that the widget works, the system is connected, and indexing can proceed.

Codebeamer server changes #

1. Download the IQNECT Codebeamer extension from https://app.iqnect.ai/cb_extension/codebeamer-extension-26.2.1.zip.
2. Unzip the downloaded file and identify the JAR file that matches your Codebeamer version. The JAR file is named iqnect-cb-extension-26.2.1-<<CB_VERSION>>-<<JDK_VERSION>>.jar.
3. Log in to the Codebeamer web interface as an administrator, navigate to System Administration > Application Configuration, and update the iqnox.iqnect object as follows:

"iqnox" : {
     "iqnect" : {
         "clientId" : "KEEP_EXISTING",
         "clientSecret" : "KEEP_EXISTING",
         "queueMaxSize" : 50,
         "queueMaxWait" : 30000,
         "tokenUrl" : "https://api.iqnect.ai/v26.2.1/oauth/token",
         "uiBootstrapUrl" : "https://app.iqnect.ai/cb/26.2/bootstrap.js",
         "url" : "https://api.iqnect.ai/v26.2.1",
         "oauth" : {
             "clientId" : "iqnect",
             "redirectUris" : "https://api.iqnect.ai/systems/oauth2/callback, https://api.iqnect.ai/v26.2.1/systems/oauth2/callback",
             "renewalsEnabled" : true,
             "scope" : "iqnect",
             "tokenValidMinutes" : 60
         },
         "tunnel" : {
             "allowedBaseUrls" : "FULLY_QUALIFIED_DOMAIN_NAME_OF_YOUR_CODEBEAMER_SERVER",
             "enabled" : true,
             "url" : "https://relay.iqnect.ai"
         }
     }
 },

Keep the existing values of clientId and clientSecret.

Set allowedBaseUrls to the fully qualified base URL of your Codebeamer instance. For example, if the instance URL is https://cbdemo.iqnox.com/, then allowedBaseUrls should be https://cbdemo.iqnox.com.

4. Access the Codebeamer server file system and navigate to <INSTALL_DIR>/tomcat/webapps/cb/WEB-INF/lib, where INSTALL_DIR is the top-level directory where Codebeamer is installed.
5. Remove the existing IQNECT Codebeamer extension JAR file from the lib directory.
6. Copy the new JAR file to the lib directory.
7. Restart the Codebeamer server.

IQNECT tenant changes #

Tenant version update #

1. Log in to the https://app.iqnect.ai portal.
2. Open the tenant you want to upgrade.
3. Go to the Details view and inspect the IQNECT Version field.
4. Click Edit.
5. If the tenant is not already set to v26.2.1, update it and click Save.

Per-system configuration matrix #

Apply the following configuration to each connected Codebeamer system under the Systems menu.

For systems using Standard OIDC/OAuth2, consult your identity provider documentation for the correct values of ClientID, ClientSecret, Scopes, Authorization URL, and Token URL.

After saving the configuration for each system, click Connect and complete the delegated authentication flow.

Validation checklist #

Use the following checks after the migration:

1. Confirm that the Codebeamer server is running after the restart.
2. Log in to Codebeamer and confirm that the IQNECT button is visible and functional in the top-right corner.
3. Click the IQNECT button, then click the user name, and confirm that the displayed IQNECT version is 26.2.1.
4. In IQNECT, confirm that each expected system appears under Connected Systems.
5. Click Connect for each system and confirm that the delegated authentication flow completes successfully.
6. Confirm that the system status indicates that the system is connected.
7. Confirm that the configured Integration user is saved in the Integration tab for each system.
8. Confirm that indexing can proceed by checking that IQNECT can fetch full item contents through the new indexing path.

Rollback/failure signals #

Stop the migration and investigate before proceeding further if any of the following occurs:

1. The IQNECT button is missing after the Codebeamer restart.
2. The IQNECT version shown in Codebeamer is not 26.2.1.
3. The delegated authentication flow fails when clicking Connect.
4. The system does not appear under Connected Systems, or remains disconnected after authentication.
5. IQNECT cannot reach the system through the configured direct path or tunnel relay.
6. The configured Integration user cannot access the content required for indexing.
7. Indexing fails because IQNECT can receive metadata but cannot fetch full item contents from Codebeamer.

If rollback is required, restore the previous Codebeamer extension JAR, restore the previous iqnox.iqnect application configuration, restart Codebeamer, and return the tenant version and per-system IQNECT configuration to their previous values.