Surround SCM supports integration with Eclipse. This information also applies to JBuilder and WebSphere integrations. See Surround SCM Third-Party Integrations for supported platforms and versions.

This article includes information about installing the integration plug-in, sharing projects, configuring Surround SCM preferences, performing Surround SCM actions, and troubleshooting.

Note: The following steps were tested using Eclipse 3.7 and Surround SCM 2012.0.

Installing the plug-in

Note: WebSphere has different plug-in installation steps. See Surround SCM WebSphere Integration for information.

1. In Eclipse, choose Help > Install New Software. The Install wizard starts.
2. Click Add. The Add Repository dialog box opens.
   
   
3. Enter a Name for the software download site, such as Surround SCM Plug-in Site.
4. Enter http://downloads.seapine.com/pub/eclipse/surround/ as the Location.
5. Click OK.
6. Expand Surround SCM Eclipse Team plug-in, select the plug-in version to install, and click Next.
   
   
7. Review the plug-in details and click Next.
8. Accept the license agreement and click Finish. You are prompted to restart Eclipse when the installation is complete.
9. Click Restart Now to restart Eclipse.

Sharing projects

You must associate the Eclipse project with a repository before you can perform Surround SCM actions.

1. Open the project in Eclipse.
2. Right-click the project and choose Team > Share Project. The Share Project wizard starts.
   
   
3. Select Surround SCM and click Finish. The Surround SCM Login dialog box opens.
4. Select the server you want 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.
5. Click Fix. The Surround SCM Repository Browser opens.
   
   
6. Select the branch and repository you want to point the project to 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.
7. Click OK. The new repository is displayed in the repository browser.
8. Select the new repository and click OK. The project is shared with Surround SCM.

Configuring Surround SCM preferences

1. In Eclipse, choose Window > Preferences.
2. Expand Team and select the Surround SCM category.
3. Select the Save modified files before Surround SCM actions option to specify how modified files are handled when a Surround SCM action is initiated.
   
   
4. Select the When user attempts to edit a read-only file option to specify what happens when a user edits a local, read-only file in the Eclipse editor.
5. Expand the Surround SCM node and select Label Decorations to set decoration options. Label decorations display additional information about a file or project using a label or icon.
   
   Note: To enable Surround SCM label decorations, expand the General and Appearance nodes. Select the Label Decorations category and select Surround SCM.
   
   
6. Select any Text Decorations options. Text decorations append text to nodes based on Surround SCM status.
7. Click the Icon Decorations tab and select any options to add Surround SCM status icons to nodes.
   
   Note: Setting text or icon decoration options may slow down performance.

Performing Surround SCM actions

You can access the following Surround SCM commands from the Surround SCM menu: Add, Get, Check Out, Undo Check Out, Check In, Rename, and Remove. You can also work with changelists, view file differences, history, and properties, refresh file status, synchronize the project with the repository, display the Surround SCM Messages pane, and start Surround SCM from this menu.

The Team shortcut menu provides access to rename and remove files, and disconnect from Surround SCM. Right-click the file you want to work with, choose Team, and select the action you want to perform.

Importing projects from Surround SCM

You can import projects from Surround SCM to recursively get local copies of all files in a project.

Note: Importing projects is only supported when using Surround SCM 2012.0 and later.

1. Choose File > Import. The Import wizard starts.
2. Expand Surround SCM, select Project from Surround SCM, and click Next.
   
   
3. Review the import overview and click Next. You are prompted to select a repository.
4. Select the repository that contains the project you want 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.
5. Enter a Project name to create a new project. If a .project file is found in the selected repository, the name is already set.
   
   
6. Click Finish.

Comparing file versions

To compare a local file to the current version in Surround SCM, right-click the file and choose Compare With > Latest Version. The compare editor opens and displays the file differences.

Replacing file versions

To replace a local file with the current version in Surround SCM, right-click the file and choose Replace With > Latest Version. The local file is replaced.

Troubleshooting

Surround SCM is not displayed in the Share Project list

Following are common causes and solutions.

• The Surround SCM plug-in is not installed. A plug-in must be installed for each version of Eclipse you are using.
• You are running an unsupported version of Eclipse.
• 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 library you want to use comes first in the PATH.

Most Surround SCM actions, except for Add, are not enabled in Eclipse

Following are common causes and solutions.

• The Eclipse project is not configured correctly. Make sure the project is configured to point to a valid Surround SCM branch and repository.
• 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. Eclipse uses the .MySCMServerInfo file to determine where to look for files in Surround SCM. Go to your project files directory and make sure the .MySCMServerInfo file data points to the correct branch and repository. If it points to an incorrect branch and repository, delete it and then refresh the project status to regenerate the .MySCMServerInfo file.

Cannot add files to Surround SCM from Eclipse

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 Eclipse project configuration points to the wrong branch. This can be an issue if you maintain the Eclipse local project files in Surround SCM and then branch the repository that contains the project files. Configure Eclipse to point to the correct branch and then add the files to Surround SCM.