Surround SCM supports integration with Eclipse. This information also applies to JBuilder and Rational Application Developer (RAD) for WebSphere integrations. JBuilder is only supported in Surround SCM 2015.0 and earlier.
See Surround SCM Third-Party Integrations for supported platforms and versions.
This article includes information about installing the integration plug-in, sharing projects, performing Surround SCM actions, configuring Surround SCM preferences, license usage, and troubleshooting.
Note: The following information uses Eclipse, but the steps for configuring and using the JBuilder and RAD integrations are the same.
Installing the plug-in
Note: The Surround SCM plug-in version numbering changed starting with version 10.0.0 (June 2016). Versions 2008 - 2016 are old. Before upgrading to plug-in version 10.0.0 or later, you must uninstall all Surround SCM 2008.0.0 - 2016.0.1.19 plug-ins. This ensures Eclipse always uses the current plug-in version. To view the installed Eclipse plug-ins, choose Help > About > Installation Details. See the Eclipse help for information about uninstalling plug-ins.
- In Eclipse, choose Help > Install New Software. The Install wizard opens.
- Click Add. The Add Repository dialog box opens.
- Enter a Name for the software download site, such as Surround SCM Plug-in Site.
- Enter https://www.perforce.com/downloads/helixalm/surroundscm/integrations/eclipse as the Location.
- Click OK.
- Expand the Surround SCM Eclipse Team plug-in node and select the Surround SCM Team plug-in
- Click Next.
- Review the plug-in details and click Next.
- Accept the license agreement and click Finish. You are prompted to restart Eclipse when installation is complete.
- Click Restart Now to restart Eclipse.
You must associate the Eclipse project with a repository before you can perform Surround SCM actions.
- Open the project in Eclipse.
- Right-click the project and choose Team > Share Project. The Share Project wizard opens.
- Select Surround SCM and click Finish. The Surround SCM Login dialog box opens.
- Select the server to connect to, enter your username and password, and click Connect. You are prompted to create a Surround SCM repository association for the local project directory.
- Click Fix. The Surround SCM Repository Browser opens.
- Select the branch and repository to associate the project with and click Create Repository. The project directory is assigned as the working directory for the new repository.
Note: If a working directory is already set for the selected repository, a conflict may occur. Clear the Inherit working directory from parent option and enter the local project path as the working directory.
- Click OK. The new repository is displayed in the repository browser.
- Select the new repository and click OK. The project is shared with Surround SCM.
Performing Surround SCM actions
To perform a Surround SCM action, select it from the Surround SCM menu. You can also right-click a file and choose an action from the Team shortcut menu.
|| Use to:
||Manually select files to retrieve local copies to the working directory.
|Check Out Files
||Check out the selected files to make changes to them.
|Check In Files
||Check in updated files and make changes available to other users.
|Undo Check Out Files
||Discard any changes made to a checked out file and remove the checked out status.
||Retrieve local copies of files in a folder to the working directory.
|Check Out Folders
||Check out files in a folder to make changes to them.
|Check In Folders
||Check in updated files in a folder and make changes available to other users.
|Undo Check Out Folders
||Discard any changes made to files in the selected folder and remove the checked out status.
||Add files to Surround SCM.
||Add repositories to Surround SCM that correspond with Eclipse project folders.
||View the file history.
||View the file properties.
||View and work with changelists
|Synchronize with Repository
||Synchronize files and folders with Surround SCM
|Refresh Files Status
||Update the file status. For example, if you check out a file from the Surround SCM Client, it is not displayed as checked out in Eclipse until you refresh the file status.
||View Surround SCM action and status messages.
|Start Surround SCM
||Open Surround SCM.
The following actions are only available in the Team shortcut menu when you right-click a file.
|| Use to:
||Rename files in Surround SCM and the project.
||Remove files from Surround SCM and the project.
|Disconnect from Surround SCM
||Disconnect the project from Surround SCM and remove the association. The project must be shared again to reassociate it with Surround SCM.
Importing projects from Surround SCM
You can import projects from Surround SCM to recursively get local copies of all files in a project.
- Choose File > Import. The Import wizard opens.
- Expand the Surround SCM node, select Project from Surround SCM, and click Next.
- Review the import overview and click Next. You are prompted to select a repository.
- Select the repository that contains the project to import and click OK.
- If a .project file is not in the repository, you are prompted to create a new project. Click Yes and continue with step 5.
- If a working directory is not set for the repository, you are prompted to set one. Click Yes, set the working directory, and click OK.
- Enter a Project name to create a new project. If a .project file is found in the selected repository, the name is already set.
- Click Finish.
Comparing file versions
To compare a file to the current version in Surround SCM, right-click it and choose Compare With > Latest Version. The compare editor opens and displays the file differences.
Replacing file versions
To replace a file with the current version in Surround SCM, right-click it and choose Replace With > Latest Version. The local file is replaced.
Configuring Surround SCM preferences
You can configure preferences for the Surround SCM integration in Eclipse, such as how to handle saving modified files before performing Surround SCM actions, checking out read-only files before they can be edited, and adding or removing files from Surround SCM based on changes in the project. You can also configure decoration options to display file information using labels and icons.
- Choose Window > Preferences.
- Expand the Team node and select Surround SCM. The Surround SCM preferences are displayed.
- Make any changes.
- Expand the Surround SCM node and select Label Decorations to set text and icon decoration options.
Note: To enable Surround SCM label decorations, expand the General and Appearance nodes. Select the Label Decorations category and select Surround SCM. Using label decorations may slow down performance.
- Click OK to save the changes.
A Surround SCM license is used when Eclipse needs information about a file from Surround SCM. By default, Eclipse 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.
Surround SCM is not displayed in the Share Project list
Following are common causes and solutions.
- The Surround SCM plug-in is not installed. Install it for each version of Eclipse you are using.
- You are running an unsupported version of Eclipse. Upgrade to a supported version.
- The Surround SCM JAR file is not installed correctly. Make sure the Surround SCM SCCI.jar file exists in the /plugins/com.seapine.surroundscm_ subdirectory in the Eclipse directory. If the file is missing, reinstall the plug-in.
- The Surround SCM library file is not installed correctly. Locate the Surround SCM SCCI.dll file (.so on Linux, .jnilib on Mac OS X). Make sure the directory where the library file resides is in your PATH system variable.
- Multiple copies of the Surround SCM library file are installed. The plug-in uses the first library file it finds based on the PATH order. Delete old copies of the library or edit your PATH system variable to make sure the directory reference to the correct library to use comes first in the PATH.
Most Surround SCM actions are not enabled
Following are common causes and solutions.
- The project is not configured correctly. Make sure the project is configured to point to a valid Surround SCM branch and repository on the server you are connected to.
- Eclipse cannot connect to the Surround SCM Server. Make sure the Surround SCM Server is running and your username and password are correct.
- The local .MySCMServerInfo file is out of sync. This file is used to determine where to look for files in Surround SCM. Make sure the .MySCMServerInfo file data in the project files directory points to the correct branch and repository. If the file points to an incorrect branch or repository, delete it and then get the project from the Surround SCM Client to regenerate it.
Cannot add files to Surround SCM
Following are common causes and solutions.
- The Surround SCM integration is not configured correctly. Make sure the project points to a valid Surround SCM branch and repository and the local .MySCMServerInfo file exists.
- The project configuration points to the wrong branch. This can be an issue if you maintain the local project files in Surround SCM and then branch the repository that contains the server project files. Configure the version control settings for the project to point to the correct branch and then add the files to Surround SCM.