Search:     Advanced search

Surround SCM NetBeans Integration

Article ID: 753  |  Last updated: 11 Jul, 2017

Surround SCM supports integration with NetBeans. See Surround SCM Third-Party Integrations for supported platforms and versions.

This article includes information about installing and adding the integration plug-in, adding and connecting to a project, performing Surround SCM actions, configuring Surround SCM settings, license usage, and troubleshooting.

Installing and adding the plug-in

The NetBeans plug-in is automatically installed during the Surround SCM Client installation. To add the plug-in:

  1. In NetBeans, choose Tools > Plugins.
  2. Click the Downloaded tab.
  3. Click Add Plugins.
  4. Browse to the Surround SCM installation directory.
  5. Select the plug-in in the NetBeans subdirectory.
  6. Click Install.
  7. Follow the prompts to install the plug-in.
  8. Restart NetBeans.

Adding and connecting to a project

The steps for adding a project to Surround SCM or connecting to an existing Surround SCM branch and repository are basically the same. If the files are already in Surround SCM, get the files to your computer and open them in NetBeans.

  1. Open the NetBeans project. Make sure the Project window is active.
  2. Right-click the project and choose Surround SCM > Enable Surround SCM. You are prompted to establish a Surround SCM association.
    Note: You may not be prompted to establish the association if the project already exists in Surround SCM, you performed a get, and you opened the project from the working directory.
  3. Click Fix. The Surround SCM Repository Browser opens.
  4. Select the branch and repository to add the files to.
  5. Click Create Repository to create a repository for the NetBeans project. Surround SCM automatically uses the project name for the repository name, but you can change it. The project folder is used as the working directory and cannot be changed.
  6. Click OK to create the repository.

Performing Surround SCM actions

To perform a Surround SCM action, select it from the Surround SCM menu or right-click a file and choose it from the Surround SCM shortcut menu.

Actions are also available on the Surround SCM toolbar. If the toolbar is not displayed, choose View > Toolbars > Surround SCM to display it. Choose View > Toolbars > Customize to customize the Surround SCM toolbar.

 Action  Use to:
Synchronize Project Add project files to Surround SCM. Only adds files that are recommended to be controlled. Compiled binaries are excluded.
Add Files/Folders Manually add selected files or all files in the selected package to Surround SCM.
Get Files/Folders Retrieve local copies of selected files or all files in the selected package to the working directory.
Check Out Files/Folders Check out the selected files or all files in the selected package to make changes to them.
Check In Files/Folders Check in updated files and make changes available to other users.
Undo Check Out Files/Folders Discard any changes made to a checked out file or package and remove the lock.
Delete/Safe Delete Remove the selected files from the project and Surround SCM. To remove files from the project only, click Cancel in the Surround SCM Remove Files dialog box.
Remove Files Remove the selected files from Surround SCM only.
Differences Compare the local copy of a file in your working directory with the current version in Surround SCM.

Note: The diff utility used is configured in Surround SCM. The Differences dialog box only opens if the local file is different from the latest version on the Surround SCM Server. To view differences between the local file and another version, view the file history and then diff the files.
History View the file history.
Properties View the file properties.
Refresh Files/Folders Update the current status of the selected file or package.
Refresh All Update the current status of all files in the project.

Configuring Surround SCM settings

You can customize the Surround SCM plug-in settings, including enabling text and icon annotations. Keep in mind that using annotations in large projects can slow NetBeans performance.

  1. In NetBeans, choose Tools > Options.
  2. Click Miscellaneous and then click the Surround SCM tab.

License usage

A Surround SCM license is used when NetBeans needs information about a file from Surround SCM. By default, NetBeans automatically performs background status checks with source control providers. If you use floating licenses and are not performing Surround SCM actions, you can disconnect the project from Surround SCM to keep licenses available to other users. Floating licenses are automatically released after 15 minutes of inactivity.


The NetBeans integration plug-in is not in the Surround SCM installation directory

The plug-in was not installed. Run the Surround SCM Client installer to install the plug-in.

Surround SCM files are not displayed correctly in NetBeans

You added files to Surround SCM, but actions on the Surround SCM menu are not enabled when viewing the files in NetBeans. Following are common causes and solutions.

  • The NetBeans project is configured incorrectly. Make sure the project points to a Surround SCM branch/repository on the Surround SCM Server you are connecting to. To check the information, select a file and choose Surround SCM > Properties.
  • The branch/repository points to an invalid working directory. Make sure the working directory for the repository associated with the project is the same folder that NetBeans opened the project from. You may experience issues if you set up the working directory to point to a different location.
  • The local .MySCMServerInfo file is out of sync and NetBeans may not be able to determine where Surround SCM files are located. In the directory where the Surround SCM files are located, open the .MySCMServerInfo file in a text editor. Make sure the correct branch/repository is listed. If not, delete the file and refresh it from NetBeans to regenerate it with the correct data.
Article ID: 753  |   Last updated: 11 Jul, 2017

Prev   Next
Changing the Surround SCM Plug-in Used with Visual Studio...     Surround SCM and Microsoft Office Integration Issues