Install the Codebeamer AI Plugin
This section describes how to install the Codebeamer AI plugin after the service principal is created.
Prerequisites
Codebeamer is installed. See Supported Codebeamer Versions.
Installing Codebeamer AI Plugin
Perform the following steps to install the AI plugin for the Codebeamer instance installed in your company.
1. Download the ZIP package that includes the cb-ai-plugin.jar file for your Codebeamer version from the PTC Software Download - Codebeamer AI page.
 |
• After upgrading Codebeamer, make sure to install the plugin using the correct cb‑ai‑plugin.jar file from the PTC Software Download - Codebeamer AI page. Do not start Codebeamer before installing the plugin. For supported plugin versions, refer to the PTC Release Advisor.
• If you are upgrading to Codebeamer 3.2.0.0 from any previous version, you must recreate the service principal to regenerate the Client ID and Client Secret and use the new credentials to integrate Codebeamer with the PTC SaaS Platform. For more information, refer Create a Service Principal for Codebeamer and Integrate Codebeamer with the PTC SaaS Platform.
|
2. Extract the ZIP file and copy the cb-ai-plugin.jar in <Codebeamer Installation Directory>/WEB-INF/lib.
3. Install the .jar file using the webapp context like cb, replace ROOT with the webapp context. For example, /home/appuser/codebeamer/tomcat/webapps/cb/WEB-INF/lib.
Configuring your server's externally visible URL
Configure the Codebeamer server URL. This URL is set based on the mail configuration in the mail section under Application Configuration as follows:
• The localname attribute will be used as the host name.
• The serverPort attribute will be used as the port.
• The serverScheme attribute will be used as the same.
Consider the following example configuration:
"mail": {
"serverPort": 8080,
"serverScheme": "https",
"usePersonal": true,
"localname": "example.com"
},
This configuration defines the following URL that will be used to access the Codebeamer server: https://example.com:8080.
If these attributes are not configured explicitly Codebeamer uses the default URL, which is http://localhost:8080.