Upgrading Wolfram Workbench

If you are upgrading to a newer release of Wolfram Workbench from an older release, there are simple steps to follow to migrate your workspace to the new release. Your workspace is the directory on disk that contains all of your project files, as well as meta-data such as preferences you may have customized. The steps to follow for upgrading depend on whether or not you used the "-data" command line argument when starting Wolfram Workbench. The "-data" argument is recommended because it clearly specifies the location of your workspace.

Tip: It doesn't hurt to make a backup of your workspace before upgrading. After you've upgraded your workspace, you won't be able to use it again with an older version of Wolfram Workbench. If you ever want to go "back in time" to an earlier release, you'll need that backup!

The workspace chooser dialog allows you to choose the location of your workspace. This dialog appears on first startup in the absence of a -data argument. The default location provided by this dialog will be a "workspace" child of your home directory (for example, C:\Documents and Settings\UserName\workspace.)

Unless you have an existing workspace from a previous Wolfram Workbench version, you can keep this default or choose some other location. You should not store your workspace inside the Wolfram Workbench install directory, because that will make it more difficult to upgrade to a newer version of Wolfram Workbench. You should not copy or move the workspace directory, because it may contain metadata with absolute file system paths, which will be invalid if the workspace is copied elsewhere.

In Wolfram Workbench 3.0 and earlier, Wolfram Workbench's default location for the workspace was under the Wolfram Workbench directory. For example, if the eclipse.exe was in D:\eclipse-SDK-3.0.1\eclipse, then the default workspace location would be D:\eclipse-SDK-3.0.1\eclipse\workspace.

To load a workspace created using 3.0 or earlier, just point to the old workspace directory using the workspace chooser, whether it's under the old install directory or elsewhere.

 

Using the "-data" argument

If you were previously using the "-data" argument to start Wolfram Workbench, your upgrade path is much easier:

  1. Install the new version of Wolfram Workbench in a new location, separate from any old version of Wolfram Workbench.
  2. Start this new version of Wolfram Workbench, using the "-data" command line argument to point to your old workspace location.

See the example in the previous section for an illustration.

Adding third party plug-ins

If you have installed extra plug-ins in your Wolfram Workbench environment, you will need to add these new plug-ins to each new build or version of Wolfram Workbench you install. Before you do this, refer to the documentation for those plug-ins to ensure they are compatible with the version of Wolfram Workbench you are moving to. There are several ways to add these extra plug-ins to your new Wolfram Workbench install:

  1. Copy the directories for each plug-in into the "dropins" directory of your new Wolfram Workbench version.
  2. Use an Wolfram Workbench update site to re-install those extra plug-ins or features in the new version of Wolfram Workbench.
  3. If you are using product extensions, simply copy the "links" directory into the new Wolfram Workbench version install directory. For more details on product extensions, see the documentation in the Platform Plug-in Developer Guide, under Programmer's Guide > Packaging and delivering Wolfram Workbench based products > Product extensions.