Quick start with the Plugin

The Plugin is very simple to configure and run.

Prerequisites.

Before using this Plugin you need to perform standard procedure of installing SFDX CLI on your local machine from here:

https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm

Installation.

As SFDX plugin:

# If you already have outdated version of the Plugin installed on your local machine
# and want to update it, first uninstall the existing version:
$ sfdx plugins:uninstall sfdmu

# Install the latest version of the Plugin:
$ sfdx plugins:install sfdmu

With the source code:

# If you have any old Plugin installation, take some preliminary steps 
# before installing from the current git source.
# Uninstall all previously installed SFDMU instances from the SFDX CLI.
$ sfdx plugins:uninstall sfdmu

# If once you have linked any old source code of the Plugin, make sure that it is already
# unlinked from the Salesforce CLI. 
# Go to your local directory which contains the old Plugin sources and type:
$ sfdx plugins:unlink

# Now you are ready to install the new version of the Plugin from the current repository.
# 1. Clone the git locally: 
$ git clone https://github.com/forcedotcom/SFDX-Data-Move-Utility

# 2. Make the installation directory current:
$ cd SFDX-Data-Move-Utility

# 3. Install npm modules: 
$ npm install

# 4. Link the Plugin to the Salesforce CLI: 
$ sfdx plugins:link

Running. The basic example: upserting all Account records from Org to Org.

  1. Create export.json file with following format and put it to any directory:
{
    "objects": [
        {
            "query": "SELECT Id, Name FROM Account",
            "operation": "Upsert",
            "externalId": "Name"
        }
    ]
}
  1. Make sure that you already have connected to the source and target salesforce Orgs using SFDX (for example you can connect with the force:auth:web:login)

  2. Open the directory where you have put your export.json in the Console / Terminal and enter command as below:

$ sfdx sfdmu:run --sourceusername source@name.com --targetusername target@name.com

... where the --sourceusername is your source Org alias/username and the --targetusername is your target Org alias/username.


Just wait for the Plugin to complete upserting your Accounts.


Download and use the SFDMU Desktop GUI Application, that will assist you to create the export.json file with the intuitive and handy GUI.


See also:

Installation

Minimal Configuration

Running

Debugging

Full export.json format

Last updated on Mo Mar 2021