CA

AllFusion® Harvest Change Manager Plug-in for Eclipse r6.20 Readme


1.0 Welcome

2.0 New and Enhanced Features
2.1 Check-in Comments for Versions and Packages in Views
2.2 Command Line Install and Update Support
2.3 More Common Functionality Across Multiple Versions of Eclipse
2.4 LDAP Authentication Support
2.5 Checkout Error Messages in Dialog
2.6 Delete Package
2.7 Compare with Trunk from Package
2.8 Get Latest Repository Version Compared to Workspace Version on Checkout
2.9 General Usability Enhancements
2.10 Harvest Ignore and Edit Ignored Patterns
2.11 Detection of External Edits
2.12 Refactoring Improvements
2.13 Switch Package
2.14 Set Defaults in Repositories View
2.15 Approve and Promote Package
2.16 Compare Versions
2.17 Last Check-Out Mode in Eclipse Populated in Dialogs
2.18 Mark as Merged Menu Item in Synchronizer View
2.19 Login Prompt when Credentials Not Found
2.20 Share Projects with Linked Resources

3.0 Operating System Support
3.1 Windows
3.2 Linux

4.0 System Requirements
4.1 AllFusion Harvest r7 patch 4 or AllFusion Harvest r7.1
4.2 Eclipse 3.1, 3.0, or 2.1.x
4.3 IBM Rational Application Developer and IBM Rational Web Developer 6.0
4.4 IBM WebSphere Development Studio Client for iSeries 6.0
4.5 Web Browsers

5.0 Installation Considerations
5.1 Perform Pre-installation Tasks
5.2 Install the AllFusion Harvest Plug-in for Eclipse

6.0 Documentation Changes

7.0 Finding Known Issues and Fixes

8.0 Published Fixes

9.0 Contact Technical Support


1.0 Welcome

Welcome to the readme for the AllFusion® Harvest Change Manager Plug‑in for Eclipse (AllFusion Harvest Plug‑in for Eclipse) r6.20. This document contains important information you need to know before installing or using the AllFusion Harvest Plug‑in for Eclipse with AllFusion® Harvest Change Manager (AllFusion Harvest) r7.1 or AllFusion Harvest r7 patch 4. For information on installing AllFusion Harvest components, see the AllFusion Harvest r7.1 or AllFusion Harvest r7 documentation, available from Technical Support at http://ca.com/support.

Important! Three versions of the AllFusion Harvest Plug‑in for Eclipse are distributed with this release, each version supporting a distinct version of Eclipse. Use the following list to determine which version of the AllFusion Harvest Plug‑in for Eclipse you need for your Eclipse installation:


2.0 New and Enhanced Features


2.1 Check-in Comments for Versions and Packages in Views

PR 5219: Developer check‑in comments (description notes) for versions and packages now display in the Package List view, Package Properties sheet, Version List view, and Version Properties sheet.


2.2 Command Line Install and Update Support

Eclipse provides command line support for the Eclipse Update Manager. The AllFusion Harvest Plug‑in for Eclipse may be installed, updated, or removed from the command line. For information on how to run the Eclipse Update Manager from the command line or perform a silent installation, see http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/misc/update_standalone.html.

Note: Eclipse does not support command line installations for Eclipse 2.1.


2.3 More Common Functionality Across Multiple Versions of Eclipse

PR 5237: The plug‑in has undergone architectural changes that enable CA to provide a more common feature set across multiple versions of Eclipse. For example, the multiple view path support, which was added in the prior r6.1 plug‑in (for Eclipse 3.0), is now available to Eclipse 2.1 plug‑in users.

Note: There may be some minor behavioral differences in the feature set between Eclipse 2.1, 3.0, and 3.1; however, those differences can be attributed to different implementations of a specific version of Eclipse.


2.4 LDAP Authentication Support

PR 3400: The AllFusion Harvest Plug‑in for Eclipse supports LDAP external authentication.

When External Authentication is active, passwords cannot be changed from the AllFusion Harvest Plug‑in for Eclipse. If your password expires and needs to be changed, an error indicates that the login failed and you must update your password with the External Authentication application.


2.5 Checkout Error Messages in Dialog

PR 4051: In past releases if a check‑out failed, a dialog opened with the message: “Unable to checkout files. Reason: the execution of the checkout process has failed.” You were then required to click OK to close the dialog and then navigate to the log file to find the real reason for the failure.

With this enhancement, the check‑out operation collects the error messages and displays them in the dialog.


2.6 Delete Package

PR 4959: The Delete package action is now supported from the Repositories View. You can select multiple packages.


2.7 Compare with Trunk from Package

PR 4977 and 5365: The Compare with Trunk action has been enhanced to let you select a Package node, allowing a comparison of each branch version in the package against its parent trunk. A separate comparison window is displayed for each branch.


2.8 Get Latest Repository Version Compared to Workspace Version on Checkout

PR 4980 and 4952: A preference and supporting functionality have been added to give you the option of specifying whether to use the workspace version of a file for checkout or to always use the latest repository version. To better support multiple modes of development, a preference has been added that lets you specify your preference.

Problem symptoms:

Example 1: Steps

Start with version 0 of file a.txt.

  1. Check out file=a.txt, mode=Update, package=p1 using Harvest Workbench to create version 1.

  2. In Eclipse, ensure that your workspace has version 0 of the file, and your context is set to mode=Update, package=p2.

  3. Check out the file a.txt.

Result:

You receive a message indicating that a later version exists, and this later version will be checked out (otherwise the check‑out will fail).

Example 2: Steps

Start with version 0 of the file a.txt.

  1. Check out file=a.txt, mode=Update, package=p1 using Harvest Workbench to create version 1.

  2. In Eclipse, ensure your workspace has version 0 of the file, and your context is set to mode=Concurrent Update, package=p2.

  3. Check out the file a.txt.

Result:

You receive a message indicating that a later version exists. You must decide which version you want to use (workspace version or latest repository version).

Two dialogs have been added to support the described behavior, one informing the user that the latest repository version will be used because it is the only option if the operation is to succeed. Another dialog prompts the user to choose which version to use. You can bypass both messages by setting the preference Window, Preferences, Team, AllFusion Harvest CM, Always Check Out latest version.


2.9 General Usability Enhancements

PR 4987: The following usability enhancements have been added:


2.10 Harvest Ignore and Edit Ignored Patterns

PR 5019: When committing resources, often there are resources that you do not want to add to version control. The new Harvest Ignore facility reads the contents of the .harvestignore file to determine what to ignore.

You can select a folder or files in the current directory to be ignored for configuration management from the Navigator view using the Team, Ignore option. The Ignore option is available for items (files or folders) that are not currently being ignored. Note that this feature functions similarly to the Ignore features documented in the Eclipse online Help. See the Eclipse documentation for more information on how the ignore functionality works.

The patterns defining which files or folders to ignore are stored in a file named .harvestignore in the directory where the patterns are to be used. You may also manually create the .harvestignore file.

To remove or edit the ignore patterns, you can delete the file manually or edit it using the Edit ignore patterns file option. This option is available for files or folders that are currently ignored. Patterns can use an asterisk (*) or question mark (?) as a wildcard character.

The Ignore and Edit ignore patterns file options cannot be seen in the Repositories View. They are available only in the Navigator view or Package Explorer.

Note: The Harvest Ignore facility and Edit ignore patterns file options are not supported for Eclipse 2.1. These features require the pattern matching support of a minimum of Java Runtime Environment 1.4.


2.11 Detection of External Edits

PR 5051: With this enhancement, edits to files in the workspace made by applications external to Eclipse are treated as Offline Mode edits. When checking for offline changes to a file, the Synchronizer detects a change to a file made externally to Eclipse. If the file was changed externally, a dialog box opens requesting the user to specify whether the detected offline changes should be accepted or not.

To minimize user interaction, this dialog is presented only once for each Synchronize with Harvest operation when external changes are discovered. If the user accepts the external edits, externally modified files are then treated as if they had been edited in Offline Mode.


2.12 Refactoring Improvements

Online Java Refactoring Improvements

PR 4983: The online Java refactor process has been enhanced to make it consistent with the corresponding offline action.

The old process handled Java refactoring with the following logic:

  1. If the file is checked out, check it in. (This creates a version if there were changes.)

  2. Rename the file. (This creates a version.)

  3. Check out the file to allow content changes. (The class declaration in the file changes, creating a version.)

The new online Java refactoring process uses the following logic:

  1. If the file is checked out, save the contents elsewhere temporarily and undo the check‑out of the file.

  2. Rename the file. (This creates a version.)

  3. Check out the file, replace the contents saved from Step 1, and allow the content change. (The class declaration in the file changes, creating a version.)

The refactor operation is stored offline, and the Synchronize with Harvest operation detects the offline refactor changes. Doing a Release performs both the steps to rename the file and check in the file contents change.

Online Refactor Performance Improvement

PR 5099: This enhancement lets you perform online refactor operations without first checking out the files. By default, the refactor operation will check out files in online mode as it has in prior releases. However, to improve the speed of the refactor operation, you may clear the Checkout files while refactoring option in Team, Preferences.

When this option is cleared, refactor operations that cause changes to files will automatically make the affected files writable and mark the files as offline‑edited. The affected files will be decorated with the + icon, indicating that changes were made. Subsequent synchronize operations will detect these files as offline changes and permit you to check out and release the changes.

Java Refactoring Improvements

PR 5296: Java refactoring improvements include the following:


2.13 Switch Package

PR 5132: The Switch Package action is now supported from the Repositories View. This action lets you modify the package for files checked out in the workspace.


2.14 Set Defaults in Repositories View

PR 5312: From the Repositories view, you can now set default packages for AllFusion Harvest states to streamline dialog field entries and selections. The Set as Default Package action decorates the package with a red checkmark, indicating the package is designated as the default for the AllFusion Harvest state. Actions occurring in the Repositories View will use the default package for the state in which the package was invoked.

From the Repositories view, you can set a unique default context for AllFusion Harvest state nodes and items that are descendents of state nodes. This streamlines dialog field entries and selections.

Note: Setting a unique default context for AllFusion Harvest state nodes and descendant items does not apply to items in Eclipse workspace.

The Add to Workspace wizard also lets you set the default context of items as you add them to the workspace.

Note: This feature is not available for Eclipse 2.1.


2.15 Approve and Promote Package

PR 5354: Two processes, Approve and Promote, can be executed from the Promote dialog. The 'Approve before promoting' option can be selected from the Promote dialog if the user has access to an Approve process on the state that the package is in.


2.16 Compare Versions

PR 5364: With this enhancement you can compare versions of different items in the Repositories view. The items can have different item IDs.


2.17 Last Check-Out Mode in Eclipse Populated in Dialogs

PR 5372: The AllFusion Harvest Plug‑in for Eclipse recalls the last selected check‑out mode and populates the Checkout Mode dialog with that mode. The most recent check‑out mode is populated whether you right‑click a file and select the Check out or begin editing a file that is not check out in the editor.


2.18 Mark as Merged Menu Item in Synchronizer View

PR 5389: The Mark as Merged menu item updates resources tags to indicate changes were merged from a repository version into the workspace version.


2.19 Login Prompt when Credentials Not Found

PR 5397: If Eclipse authorization information is not found, the Harvest Broker Logon dialog appears. Enter your AllFusion Harvest broker login credentials to re‑establish your broker connection.


2.20 Share Projects with Linked Resources

PR 5432: Projects with linked resources can be shared and version‑controlled, but the linked resources in the project are ignored and unshared.


3.0 Operating System Support

This section lists the platforms supported by the AllFusion Harvest Plug‑in for Eclipse. CA supports these platforms for the duration of their life cycle, as determined by their manufacturer, or until CA announces that we are no longer supporting them. For the latest information about supported platforms, see our web site, http://ca.com/support.


3.1 Windows

The AllFusion Harvest Plug‑in for Eclipse is supported on the following Windows platforms:


3.2 Linux

This release of the AllFusion Harvest Plug‑in for Eclipse has been certified on Novell SUSE LINUX Enterprise Server 9.


4.0 System Requirements

This section describes the system requirements for the AllFusion Harvest components supported on each platform.


4.1 AllFusion Harvest r7 patch 4 or AllFusion Harvest r7.1

This release of the AllFusion Harvest Plug‑in for Eclipse is supported with AllFusion Harvest r7 patch 4 and AllFusion Harvest r7.1.


4.2 Eclipse 3.1, 3.0, or 2.1.x

The Eclipse Foundation's Eclipse SDK 3.1, 3.0, or 2.1.x must be installed separately on the supported platforms.

If your target integrated development environment (IDE) is one of the following IBM IDEs that installs Eclipse, you do not need to install a separate version of Eclipse:


4.3 IBM Rational Application Developer and IBM Rational Web Developer 6.0

The IBM Rational Application Developer (formerly known as WebSphere Studio Application Developer) 6.0 and IBM Rational Web Developer (formerly known as WebSphere Studio Site Developer) 6.0 IDEs are also supported by Eclipse 3.0. These products are not certified with Eclipse 3.1.


4.4 IBM WebSphere Development Studio Client for iSeries 6.0

The IBM WebSphere Development Studio Client for iSeries 6.0, which runs on Eclipse 3.0, has been certified with the AllFusion Harvest Plug‑in for Eclipse r6.20


4.5 Web Browsers

The following Web browsers are supported:


5.0 Installation Considerations

This section contains prerequisite information for installing the AllFusion Harvest Plug‑in for Eclipse and instructions to install the plug‑in for your operating system platform.

Before proceeding, ensure that you have the AllFusion Harvest documentation available, especially the AllFusion Harvest Change Manager Installation Guide and readme. The latest AllFusion Harvest documentation is available from Technical Support at http://ca.com/support.


5.1 Perform Pre-installation Tasks

Before installing the plug‑in, you must install the AllFusion Harvest client, Harweb, and the Eclipse SDK or one of the IBM IDEs in the System Requirements.

To install AllFusion Harvest and Eclipse components

  1. Install the AllFusion Harvest client on each computer where the plug‑in will be installed, according to the instructions in the AllFusion Harvest Change Manager Installation Guide.

    Install Harweb on a computer that is accessible by the workstation where the plug‑in is installed. The plug‑in works with Harweb for certain functions such as interactive merge and forms management. For instructions on installing Harweb, see the AllFusion Harvest Change Manager Installation Guide.

  2. Install the Eclipse SDK 3.1, 3.0, or 2.1.x on each computer where the plug‑in will be installed.

    Note: The Eclipse SDK must be downloaded from http://www.eclipse.org and installed on the target systems prior to installing the plug‑in.

    The SDK version of Eclipse 2.1.x, 3.0, or 3.1 (eclipse‑SDK‑n.x‑<platform>) must be downloaded and used, rather than the platform version (eclipse‑platform‑n.x‑<platform>). For example, HP‑UX needs eclipse‑SDK‑3.0‑hpux‑motif.zip.

    The Eclipse SDK 3.1, 3.0, 2.1.x includes the Eclipse Platform, Java development tools, and Plug‑in Development Environment, which contains source code and user and programmer documentation. Eclipse does not include a Java Runtime Environment (JRE). For the proper version of the JRE or Java Development Kit (JDK) that must be installed on your machine to run Eclipse, go to: http://wiki.eclipse.org/index.php/Eclipse_FAQs.

The AllFusion Harvest Plug‑in for Eclipse is installed using the Eclipse Update Manager, a feature provided by Eclipse. The Eclipse Update Manager is a built‑in plug‑in installation and update manager that simplifies the installation process and lets you manage various plug‑in instances. For details on managing your configuration, see the Eclipse help.

Important! If you have the 6.2.0.20051110 milestone build installed (early preview version of this release), you must uninstall it manually from your file system before installing the new plug‑ins.

To uninstall the milestone build for this release

  1. Delete the directory, <eclipse home>\features\com.ca.harvest.e31_6.2.0.20051110.

  2. Delete the .jar file, <eclipse home>\features\com.ca.harvest.plugin.e31_6.2.0.20051110.jar.

  3. Install the new plug‑in as described in the section, Install the AllFusion Harvest Plug‑in for Eclipse.

  4. Launch Eclipse and select Window, Reset Perspective.

Note: If you do not uninstall the milestone build, duplicate AllFusion Harvest menu items appear in the plug‑in after installing the new release.


5.2 Install the AllFusion Harvest Plug-in for Eclipse

To install the AllFusion Harvest Plug‑in for Eclipse for AllFusion Harvest r7.1 or AllFusion Harvest r7, use the Update Manager in Eclipse.

To install the AllFusion Harvest Plug-in for use with Eclipse 3.1

  1. In Eclipse, select Help, Software Updates, Find and Install.

    The installation wizard opens.

  2. Select Search for new features to install and click Next.

  3. Click New Remote Site.

    The New Remote Site dialog opens.

  4. In the Name field, enter SupportConnect.

  5. In the URL field, enter:
    http://supportconnectw.ca.com/public/harvesteclipse
    

    This default URL points to the CA update site for the AllFusion Harvest Plug‑in for Eclipse.

  6. Click OK.

    The new SupportConnect site is added to the update sites list.

  7. Select the check box beside the remote site created and click Next or Finish.

    The Search Results dialog opens.

  8. Expand the site and expand the Eclipse 3.1 category node.

  9. Select the check box next to the 7.20.0 plug‑in version, then click Next to continue through the wizard to install the plug‑in.

  10. When prompted to restart Eclipse, click Yes.

To install the AllFusion Harvest Plug-in for use with Eclipse 3.0

  1. In Eclipse, select Help, Software Updates, Find and Install.

    The installation wizard opens.

  2. Select Search for new features to install and click Next.

  3. Click New Remote Site.

    The New Remote Site dialog opens.

  4. In the Name field, enter SupportConnect.

  5. In the URL field, enter:
    http://supportconnectw.ca.com/public/harvesteclipse
    

    This default URL points to the CA update site for the AllFusion Harvest Plug‑in for Eclipse.

  6. Click OK.

    The new SupportConnect site is added to the update sites list.

  7. Expand the SupportConnect site node.

  8. Check the box beside Eclipse 3.0 and click Next.

  9. Select the check box next to the 6.20.0 plug‑in version, then click Next to continue through the wizard to install the plug‑in.

  10. When prompted to restart Eclipse, click Yes.

To install the AllFusion Harvest Plug-in for use with Eclipse 2.1

  1. In Eclipse, select Help, Software Updates, Update Manager.

  2. In the Eclipse Feature Updates view, right‑click and select New, Site Bookmark.

    The New Site Bookmark dialog opens.

  3. In the Name field, enter SupportConnect.

  4. In the URL field, enter:
    http://supportconnectw.ca.com/public/harvesteclipse
    

    This default URL points to the CA update site for the AllFusion Harvest Plug‑in for Eclipse.

  5. Leave the other options at their default values and click Finish.

    The new SupportConnect site is added to the Feature Updates view.

  6. Expand the SupportConnect site node.

  7. Expand the Eclipse 2.1 category node.

  8. Select the 5.20.0 plug‑in version.

    Information about the selected plug‑in is displayed in the Eclipse Preview.

  9. Click Install Now or Update Now and continue through the wizard to install the plug‑in.

  10. When prompted to restart Eclipse, click Yes.


6.0 Documentation Changes

When documentation is updated, the latest version is made available at http://supportconnectw.ca.com/public/harvesteclipse/. Documentation, provided as online help, automatically installs with the AllFusion Harvest Plug‑in for Eclipse.


7.0 Finding Known Issues and Fixes

You can find known issues and fixes by logging in to SupportConnect and searching the Knowledge Base. To do so, perform the following steps:

  1. Click the Support Connect link from the Technical Support page at http://ca.com/support and log in.

  2. Click Knowledge Base.

  3. In the Search field, enter AllFusion Harvest Change Manager Plug‑in for Eclipse.

  4. Select All of these words.

  5. Choose criteria for your search by selecting the check box for each of the following:

  6. Click Search.

    Results are listed on the Full Site Search page.


8.0 Published Fixes

All published fixes for this product can be found through the Fixed Issues list on the update web page at http://supportconnectw.ca.com/public/harvesteclipse/.

The Readme (readme_harvest_eclipse.html) is available from SupportConnect at http://supportconnectw.ca.com/public/harvesteclipse/.


9.0 Contact Technical Support

For online technical assistance and a complete list of locations, primary service hours, and telephone numbers, contact Technical Support at http://ca.com/support.


Copyright © 2006 CA. All rights reserved.