alwaysthinkin / sfdx-data-move-utility-desktop-app

This repository contains the special Desktop GUI Application, that will help you to prepare and execute data migration packages using the SFDMU Plugin.

---

The advanced Salesforce Data Loader SFDX Plugin (SFDMU) will assist you to populate your org (scratch/development/sandbox/production) with data imported from another org or CSV files. Supports Delete, Insert, Update and Upsert for multiple related sObjects.

• The SFDMU Plugin repository can be accessed here
• For the detailed documentation, visit the SFDMU Help Center
  
  
• Please, Note! We are currently in the process of developing a new major version of this GUI App. As a result, this version is no longer supported. However we highly appreciate any pull requests that address bug fixes or introduce new features. Your contributions are invaluable in improving the current version of the application. Thank you for your support!

---

About this App.

This application can help you to create SFDMU plugin configuration files from the simple and intuitive UI.

When can this Application be useful ?

Apart from the minimal setup the export.json file has a lot of advanced properties that can be leveraged in creating and running complex migration jobs.

Therefore in some cases the json file may become very long and hard to edit it manually using the standard Notepad.

Now with this Desktop Application you don't have to work with the Notepad and the Console, because all actions are performed in a visual mode. Now it's very simple to manage the migration jobs. You can add and remove org connections, set up SObjects and fields, then run the Plugin from the application itself.

Installation and running.

# Make sure you have the latest npm / python / yarn / electron installed on your machine, otherwise perform steps 1 - 4 accordingly. 

# 1. Install Python
https://www.python.org/downloads/

# 2. Install yarn
https://classic.yarnpkg.com/en/docs/install

# 3. Install node-gyp globally
yarn global add node-gyp

# 4. Install electron globally
yarn global add electron 

# 5. Clone this repository.
git clone https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App.git

# 6. Go into the project directory.
cd SFDX-Data-Move-Utility-Desktop-App

# 7. Install npm dependencies
npm install

# 8. Run the Application.
npm start

Notes

• This Application must have the SFDMU Plugin to be installed in your system previously.
• The Application puts user's data files into the standard Documents folder inside dedicated sub-folder named /SFDMU_APP.
  You can change the default path in the application's App Settings page.
• The Application also creates a file user.json in the application installation directory. This file is being used to store the application settings. Make sure you are NOT DELETING this file during upgrade the Application from the git repository, otherwise the settings will be lost.
• The Application supports multiple local users. Each user has his own local profile contains all his data, that is encrypted by the encryption key which is the password that is used to login into the application. So user's data never directly exposed to others. But after the creating of your local user's profile, you need to well remember your password because there is no password recovery option.

Supported OS

Normally all major OS (Win, MACOS, Linux) should be supported. It was successfully tested on Windows and MACOS machines.

Sometimes MAC users may have problems installing and launching the Application, because the Electron platform fails to install and run correctly on these local systems. For the current moment we can't provide a reliable solution for this issue.

According to the live experience the Application is always working fine in Windows-based systems.

For the windows-based machines you can try to fix the incorrect electron installation by:

npm install --global windows-build-tools

npm install electron

License

This product is licensed under the BSD-3-Clause - see the LICENSE.txt file for details.