Downloading and deploying additional resources to your Klocwork Portal
Klocwork provides additional resources, which administrators can download and share with users. These resources include the integration analysis tools (Build Tools), which are required to run analysis and load results to the Portal, the continuous integration analysis tools (CI Agent tools), and taxonomy files.
As Klocwork Administrator, you can download additional resources such as build tools and CI agent tools from https://library.roguewave.com/display/SUPPORT/Klocwork+-+Product+Downloads and place them within the clients directory of the Klocwork Server installation. This will allow your users to download analysis tools directly from the portal. Once downloaded, your users can easily install these tools on their own.
The additional tools packages are organized by platform, where each archive contains the executables supported for the respective platform. Below are the available Build Tools packages:
| Package | Platform |
|---|---|
| kwbuildtools23.1x.xxx.win64.zip | Windows (64-bit) |
| kwbuildtools23.1x.xxx.linux64.zip | Linux (64-bit) |
Below are the available CI Agent Tools packages:
| Package | Platform |
|---|---|
| kwciagent23.1x.xxx.win64.zip | Windows (64-bit) |
| kwciagent23.1x.xxx.linux64.zip | Linux (64-bit) |
The xxx portion of the path indicates the minor build number.
To deploy these additional tools packages:
- Download the applicable tools package from Support downloads.
You'll need to log in to the site using your Rogue Wave Support Center user ID and password. If you do not currently have a Rogue Wave Support Center user ID and password, you'll need to register as a new user. You need to have active maintenance to access this page.
- Once downloaded, copy the additional tools packages into the <server_install_path>/clients directory, where <server_install_path> is the location of your Klocwork Server installation on Windows.
Important: This directory contains a file called clients.json. Do not delete this file.
- Refresh the portal and verify that the Downloads list appears on the right hand side of the portal. The Downloads list contains links to the desktop analysis plug-ins. Your users can download and install the Build and CI Agent tools directly from here.
- Communicate the deployment to your users, by sending them a link to the portal and an internal email that describes how users can download and install the plug-ins.
Packaging and deploying taxonomy files to your Klocwork Portal
Taxonomies are another downloadable artifact you can add to the Klocwork Portal and share with your users. For example, users with Project Admin roles can import taxonomies files into their existing projects. The method of deploying them is slightly different. To share taxonomy files, you need to do the following:
- Locate the taxonomy files you want to package together; For example, you can package together the taxonomy files found in the <server_install_path>/taxonomies folder and/or add your own custom taxonomy files.
- Zip the taxonomy files and add them to a taxonomies.zip file. Note that if you name this file anything else, it will not appear in the Portal as expected.
- Once zipped up, copy the entire taxonomies.zip file into the <server_install_path>/clients directory, where <server_install_path> is the location of your Klocwork Server installation on Windows.
Important: This directory contains a file called clients.json. Do not delete this file.
- Refresh the portal and verify that the Downloads list appears on the right hand side of the portal. The Downloads list contains a link to download the taxonomies.zip file. Your users can download and copy the taxonomies.zip directly from here.
- Communicate the change to your users, by sending them a link to the portal and sending an internal email that describes how users can download and install the taxonomies. Users need to unzip this file into their <server_install_path>/taxonomies folder.
Adding custom links to your portal
To add custom links that appear on the right hand side of the portal, see Adding custom links to Validate.
