HomeEclipsePrinter Friendly Version

Eclipse

Setting up and using the Eclipse Plug-In

1. Installation and Integration

1.1. Which Version of Eclipse Should I Use?

The PureCM Eclipse Plugin is built against Eclipse Europa version 3.3.1.1

1.2. Installing the Windows Plugin

You must first install the PureCM Client. This will install the 'Java SDK' and the 'Java Client' in 'C:\Program Files\PureCM\Client'. The Eclipse Plugin uses the Java Client to perform all PureCM operations.

 

Download the Eclipse Plug-In jar file which corresponds to the version of 'PureCM Client' installed. Copy this file into the Eclipse 'Plugins' directory (e.g. 'C:\Program Files\eclipse\plugins').

 

The Eclipse Plugin should now be installed. We recommend you intially run Eclipse with the --clean option to clear the cache. If the plugin is successfully installed then the Eclipse menubar should include 'PureCM'. If this is not the case then please email support@purecm.com for further advice.

 

You are now ready to integrate your project with PureCM.

1.3. Installing the Linux plugin

You must first install the PureCM Client for your Operating System.  You can download this from the Downloads page.  The PureCM Client installer (whether RPM or Debian package) installs the necessary PureCM libraries and the PureCM SDK.  The Eclipse plugin needs these Lbraries in order to load.

Download the Eclipse Plug-In jar file which corresponds to the version of 'PureCM Client' installed. Copy this file into the Eclipse 'plugins' directory within your copy of Eclipse (e.g. /home/developer/eclipse/plugins/).

The Eclipse Plugin should now be installed. We recommend you intially run Eclipse with the --clean option to clear the cache. If the plugin is successfully installed then the Eclipse menubar should include 'PureCM'. If this is not the case then please email support@purecm.com for further advice. 

You are now ready to integrate your project with PureCM.

1.4. Installing the Mac OSX Plugin

You must first install the PureCM Client for your Operating System. You can download this from the Downloads page. The PureCM Client Package installs the necessary PureCM libraries and the PureCM SDK. The Eclipse plugin needs these Lbraries in order to load.

Download the Eclipse Plug-In jar file which corresponds to the version of 'PureCM Client' installed. Copy this file into the Eclipse 'plugins' directory within your copy of Eclipse (e.g. /home/developer/eclipse/plugins/).

You need to ensure that the PureCM dynamic libraries (installed under /usr/libs) are included in your DYLD_LIBRARY_PATH before launching Eclipse.

The Eclipse Plugin should now be installed. We recommend you intially run Eclipse with the --clean option to clear the cache. If the plugin is successfully installed then the Eclipse menubar should include 'PureCM'. If this is not the case then please email support@purecm.com for further advice.

You are now ready to integrate your project with PureCM.

1.5. Integrating an Eclipse Project?

You must first check that the PureCM Eclipse Plugin is installed correctly. If the plugin is correctly installed then the 'PureCM ' menu will appear within the Eclipse menu.

 

Right-click on an Eclipse project and select 'Team | Share Project'

 

Sharing a Project

 

In the Share Project Dialog select PureCM.

 

Selecting PureCM as Provider

 

If the project is already part of a PureCM workspace then the appropriate server and repository will be selected.

 

 

If the project is not within a PureCM workspace then Eclipse will need to create a new workspace at the Eclipse workspace root. You will need to select the server, repository and stream.

 

 

The Eclipse project will now be integrated with PureCM as indicated by the new project icon.

 

2. Project and File Operations

2.1. Adding Files

After adding files to an Eclipse Project you will want to add these file to PureCM before you submit. After the file adds have been submitted other developers can share the files on updating their workspace.

 

To add all uncontrolled files in a project right-click the project and select 'Team | Add Uncontrolled'.

 

 

You can also add all files using the Eclipse menubar by selecting 'PureCM | Add'.  This will add all files within the active project.

 

Alternatively if you want to add an individual file you can right-click the file in the 'Explorer' tab and select 'Team | Add'. This will only add this file and its parent folders if they are not already controlled.

 

2.2. Checkout, Checkin and Revert

You can perform PureCM operations on a file by right-clicking the file in the Explorer and selecting the 'Team' menu.

 

 

'Check Out' will make the file writable, ready to start working on. After a file is checked out it will appear when you select 'Team | View My Changes' and will also appear when you submiit your changes.

 

'Check In' will create a local revision or checkpoint. This local revision will only be available in your workspace, it will not be shared to all developers. You must submit your changes to share them with other developers.

 

'Undo Checkout' will undo any changes you have made since your last checkin (checkpoint).

 

'Revert' will undo all changes since you started working on the file. So 'Revert' is the same as 'Undo Checkout' if you have not done a 'Check In'.

2.3. Viewing Project Changes

Sometimes you may want to know what files you are working on in a project. You can see if a file has been changed by it's icon, but it is sometimes useful to get a complete list of all files which have changed.

 

Right-click the project and select 'Team | View My Changes'.

 

 

This will launch a dialog showing all files/folders which have been added, edited, deleted or moved.

 

 

 

2.4. Submitting Changes

The PureCM Eclipse Plugin supports two forms of submit: 'Project Submit' and 'Workspace Submit'. 'Project Submit' will only allow you to submit files contained within the active Eclipse project. We imagine this will be the most common way of submitting your changes, so you are not confusing the changes you are making in one project with the changes you are making in another. 'Workspace Submit' will allow you to submit all changes within the PureCM workspace for which the active project belongs. This will allow you to perform cross-project submits if required.

 

To submit your changes to the server right-click the project in the 'Explorer' and select 'Team | Submit Project Changes to Server' or 'Team | Submit Workspace Changes to Server'.

 

 

This will then launch a modal dialog showing all the files available for submit.

 

 

If there are some files you do not want to submit you can uncheck them by clicking the checkbox. You must provide a description of the changes before you submit. After providing a description you can click 'OK' to submit your changes to the server. If the submit was successful then a changeset will have been created for the stream, and other developers can share your changes by updating their workspace.

2.5. Updating the Workspace

Updating a workspace will get the latest files from the server. After another user has submitted a change you need to 'Update to Latest' within the workspace to incorporate the changes.

 To update a workspace within Eclipse, right-click the project and select 'Team | Update to Latest'.

You can view any PureCM messages in the 'Console View'. The update will fail with errors if there are conflicts (i.e. you are editing a file which has been updated). In this case you must resolve the conflicts using the PureCM GUI or 'pcm' command line client.

3. Views

3.1. Integrated Changes View

Open the 'Integrated Changes' view with the Eclipse menu 'Window | Show View | Other... | PureCM Views | Integrated Changes View'. Select the project from the drop-down.

 

The 'Integrated Changes' view shows all changesets which have been integrated in the project workspace (i.e. submitted to the server and then updated into the workspace). If a changeset has been submitted to the server but the workspace has not been updated then it will not appear in the list.

You can view the items within a changeset by double-clicking the changeset or right-clicking and selecting 'View'. This will display all the items belonging to the changeset.

 

To refresh the list of changesets you must right-click the view and select 'Refresh'.

3.2. My Changes View

Open the 'My Changes' view with the Eclipse menu 'Window | Show View | Other... | PureCM Views | My Changes View'.  Select the project from the drop-down.

The 'My Changes' view shows all files which are currently checked out, pending add, or pending delete in the selected project. This view does not automatically refresh when editing files. To refresh the view you must right-click and select 'Refresh'.

3.3. Log View

Open the 'Log View' with the Eclipse menu 'Window | Show View | Other... | PureCM Views | Log View'.  Select the server from the drop-down.

 

The Log View shows all the events for the selected server. Note that this is different to the client messages which will appear in the Console View.

You can view the details of an event by double-clicking on an event or right-clicking and selecting 'View'. This will launch a dialog with the event details.

You can refresh the list by right-clicking and selecting 'Refresh'.

3.4. PureCM Messages

Open the Eclipse 'Console View' using the menu 'Window | Show View | Others... | General | Console'.

 

PureCM information messgaes, warnings and errors will appear in the Console View.