Force.com Migration Tool Guide

Force.com Migration Tool Overview
Installing the Force.com Migration Tool
Prerequisites for Using the Force.com Migration Tool
Install the Force.com Migration Tool
Using the Force.com Migration Tool
Common Migration Issues
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Prerequisites for Using the Force.com Migration Tool

Before you can use the Force.com Migration Tool you must have Java and Ant installed and configured correctly. You may not need to install Java and Ant if you already have them on your computer, so first verify the installation from a command prompt.

Java

To see if you have Java installed:

  1. Open a command prompt.
  2. At the prompt, type java -version and press Enter.
The output should look something like the following:
1java version "1.6.0_39"
2Java(TM) SE Runtime Environment (build 1.6.0_39-b04)
3Java HotSpot(TM) 64-Bit Server VM (build 20.14-b01, mixed mode)

The Force.com Migration Tool works with Java version 1.6.x or later. If you have an earlier version, you’ll need to install Java 1.6.x or later.

To install Java, go to http://www.oracle.com/technetwork/java/javase/downloads/index.html and get the latest version of the Java JDK. When you’re finished with the installation, verify by typing java -version at a command prompt.

Ant

To see if you have Ant installed:

  1. Open a command prompt.
  2. At the prompt, type ant -version and press Enter.

The output should look something like the following:

1Apache Ant version 1.7.0 compiled on December 13 2006

If the Ant version is 1.5.x or earlier, you will need to download the latest version of Ant.

Even if you have Ant installed, you may still need to put the bin directory on your path. On a Windows operation system, you may also need to set the ANT_HOME and JAVA_HOME environment variables as follows.

Note

To install and configure Ant:

  1. Download Apache Ant version 1.6 or newer to a directory of your choice: http://ant.apache.org/bindownload.cgi. This directory will be known as ANT_HOME. Once the files are on your computer, there is no further installation required.
  2. Add the bin directory to your path. (Only the bin and lib directories are required to run Ant.)
  3. If you are using a Windows operation system, create an ANT_HOME environment variable and set the value to where you have installed Ant. Also create a JAVA_HOME environment variable and set the value to the location of your JDK.

For additional information, see http://ant.apache.org/manual/install.html.