# Teamscale Integration for NetBeans

Before installing the Teamscale Integration for NetBeans, make sure its system requirements are met.

# Installing the Plug-in

Depending on your needs, there are several options to install the Teamscale Integration for NetBeans.

The CQSE website offers both the latest version and older versions of the plug-in. For most users, the latest version is recommended.

  1. Select Tools > Plugins from the IDE's menu bar.
  2. Switch to the dialog's Settings tab.
  3. Add the desired update center.
    • Latest Version: https://www.cqse.eu/download/teamscale/ide/netbeans/latest/catalog.xml.gz
    • Older Version: https://www.cqse.eu/download/teamscale/ide/netbeans/vM.N.x/catalog.xml.gz (replacing M.N by the feature version you need but keeping the .x, e.g., 7.8.x)
  4. Click OK and switch to the Available Plugins tab.
  5. Search for the Teamscale Integration for NetBeans plug-in, select it, and click Install.
  6. Accept the license terms and, when asked, dismiss the validation warning about the plugin being unsigned.

# Installing While Offline

In case you cannot reach the CQSE Website during the installation, e.g., due to a security policy, you can perform an offline installation.

  1. Download an archive of the update center from the CQSE website.
  2. Transfer the downloaded archive to your offline computer and unpack it there.
  3. Select Tools > Plugins from the IDE's menu bar.
  4. Switch to the dialog's Downloaded tab.
  5. Click Add Plugins.
  6. Select the com.teamscale.ide.netbeans NBM file inside the unpacked archive.
  7. Accept the license terms and, when asked, dismiss the validation warning about the plugin being unsigned.

# Connecting to Teamscale

  1. Open the Window > Services window.
  2. Select the Teamscale Servers node and choose Add Server from its context menu.
  3. Fill the dialog with the appropriate values.
    • You will need your Access Key for authentication. If you have already filled in Server Name, URL, and Username, simply click Get Key and copy the key from the web page that opens.
    • Alternatively, log into your Teamscale server, open your user profile (located in the top right menu, and then click IDE Access Key. This takes you to the same web page.
  4. Click OK.

# Configuring Using .teamscale.toml Files

In addition to connecting to a Teamscale server, the local project needs to be mapped to the project(s) on the Teamscale server. Since Teamscale 8.6, this is done using one or more .teamscale.toml configuration files in a simple, uniform file format (.teamscale.toml).

Configuring using Project Mappings Settings (plug-in version 8.5 and older)
  1. Open the Project Properties dialog by choosing Properties from the project’s context menu.
  2. Open the Teamscale category.
  3. Select the Enable Teamscale for this project checkbox.
  4. Select your Teamscale server's Server Name.
  5. Select the Project Name of the Teamscale project corresponding to your NetBeans project.
  6. Should your project’s directory structure differ from the structure present on the server, create a mapping: