/dataloader

apex data loader

Primary LanguageAutoItBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Notes for Data Loader v45.0.0 and later

Data Loader v45 and later is built with Zulu OpenJDK 11 and requires a 64-bit operating system. Download and install Zulu OpenJDK 11 before installing Data Loader. See instructions further down to install via scripts.

Data Loader v44 is the last version built with Oracle Java 8. Developers can check out code from the branch “DataloaderV44Release”. End users can download v44 or older from this project’s “releases” tab.

Java Requirement

Developers need to download Zulu OpenJDK 11 before building Data Loader.

Build Data Loader

git clone git@github.com:forcedotcom/dataloader.git
cd dataloader
git submodule init
git submodule update
mvn clean package -DskipTests

The build will include the appropriate eclipse swt jar by detecting your operating system type. If you would like to manually specify the eclipse swt jar, take a look at the pom.xml file to see a full list of available profiles.

Note: Salesforce officially supports Data Loader for 64-bit Windows and macOS. Any other platforms that Data Loader can be compiled for are unofficial.

For macOS and Windows, the build will generate needed JARs in the target directory.

Execute Data Loader

To run the Data Loader GUI, run the command

java -jar target/dataloader-xx.0-uber.jar

Use the command below to run the Data Loader GUI on Mac

java -XstartOnFirstThread -jar target/dataloader-xx.0-uber.jar

To run data loader for debug

java -XstartOnFirstThread -jar -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005  target/dataloader-xx.0.0-uber.jar

To run Data Loader from the command line, use the command:

java -cp target/dataloader-xx.0-uber.jar -Dsalesforce.config.dir=CONFIG_DIR com.salesforce.dataloader.process.ProcessRunner

The command-line version runs with whatever properties you have in your config.properties file, but you can also pass paramters at runtime as arguments to the program.

For example, the following command sets the operation to insert regardless of what settings are contained in the config.properties file:

java -cp target/dataloader-xx.0-uber.jar -Dsalesforce.config.dir=CONFIG_DIR com.salesforce.dataloader.process.ProcessRunner process.operation=insert

The process-conf.xml file can be used to define properties for multiple processes. Look at src/main/nsis/samples/conf/process-conf.xml for examples on how to configure it. The way to run a process defined in process-conf.xml is to specify process name on command line like this:

java -cp target/dataloader-xx.0-uber.jar -Dsalesforce.config.dir=CONFIG_DIR com.salesforce.dataloader.process.ProcessRunner process.name=opportunityUpsertProcess

Execute Data Loader With Scripts for v45 and Later

Launch scripts are provided to help end users launch Data Loader for Windows and macOS. Zip files are provided for macOS and Windows environments in the project's "releases" tab. There are specific installation instructions for macOS and Windows.

A new directory called "release" was added to the project’s root directory. Developers can build Data Loader and place the dataloader-xx.0-uber.jar inside "release/mac" or "release\win" directory to launch a customized build.

Test Data Loader

See the testing wiki

Resources

For more information, see the wiki, or the Data Loader Developer's Guide.

Questions can be directed to the open source forum.

Dependencies

Force Web Service Connector version is here. Force Wsc and Patner API