The SFDMU GUI App enhances the efficiency of creating and managing data migrations within Salesforce environments.
This tool is a graphical interface for creating and maintaining the export.json configuration file used by the SFDX Data Move Utility (SFDMU) Plugin, facilitating the management of sObjects, fields, and organization connections to enhance accuracy and efficiency in data migration tasks.
- SFDMU GUI App Detailed Documentation: SFDMU GUI App Reference Guide.
- SFDMU Plugin GitHub Repository: SFDMU Plugin Repo.
- SFDMU Knowledgebase and Help Portal: SFDMU Help Center.
- SFDMU Support Policy: SFDMU User Support Policy.
- How to contribute to SFDMU ?: SFDMU Contribution Policy
The SFDMU GUI App offers several advantages that enhance user productivity and ensure secure data handling:
- Ease of Use: The intuitive graphical interface simplifies the configuration of migration tasks for the SFDMU Plugin, making complex operations more accessible even to users with limited technical skills.
- Visual Management: Users can easily add, modify, or remove migration components such as sObjects and field mappings, offering a clear visual representation of changes. This approach helps users better manage and organize their data migration tasks.
- Error Reduction: The application detects common configuration and metadata mistakes made during manual
export.jsonfile editing, enhancing the reliability of data migrations. - Secure Data Handling: All data is processed locally on the client's machine, with the only exception being interaction with the Salesforce REST API, ensuring that data remains secure and is handled in compliance with strict privacy and security policies.
The application is developed using the ElectronJS framework and supports:
- Major operating systems including Windows, macOS, and Linux.
- Requires Windows 10 or newer for Windows users.
- Only x64 CPU architecture is supported.
Installing and running the release version of the SFDMU GUI App is straightforward, even for users with minimal technical expertise.
- All releases were made using the Electron Forge Framework.
- All releases are available on the "release" branch of the SFDMU GUI App GitHub repository.
- You can find the MD5 hash sums in the respective
.md5files located in the same repository folder as the setup file. - Release setup executables are available for versions v4.5.0 and later. Older versions must be installed and run directly from the source code.
Ensure the SF CLI is installed before using the SFDMU GUI App.
Download and install the latest release of the SFDMU GUI App for your operating system:
- macOS: Access the
zipinstallation file here: macOS x64 setup. - Linux (Debian-based systems): Access the
debinstallation file here: Debian x64 setup. - Linux (RPM-based systems): Access the
rpminstallation file here: RPM x64 setup. - Windows: Access the
zipfile containing the setup executable here: Windows x64 setup.
To install:
- Click on the file link provided for your operating system to navigate to the download page.
- Once on the page, use the download link located at the top right to download the file.
- Follow the steps specific to your operating system for installation and running the application as detailed in Steps 3 and 4 below.
For those wishing to run a specific release of the SFDMU GUI App:
Navigate to the repository page, locate the "Releases" section on the sidebar, and click on the release tag associated with your desired version.
Download the appropriate setup file for your OS from the subdirectories under dist/:
- macOS: Navigate to
dist/darwin/x64/and download the file, e.g.,sfdmu-gui-app-darwin-x64-X.X.X.zip. - Linux (Debian-based): Go to
dist/deb/x64/and downloadsfdmu-gui-app_X.X.X_amd64.deb. - Linux (RPM-based): Visit
dist/rpm/x64/and download `SFDMU-GUI-App-X.X
.X-1.x86_64.rpm`.
- Windows: Find
dist/windows/x64/and download the zip package, e.g.,sfdmu-gui-app-X.X.X Setup.zip.
Follow the installation instructions provided for each operating system:
- Open
Downloads, find the.zipfile, and extract it to get thesfdmu-gui-app.app. - Move the application to your
Applicationsfolder.
-
Open a terminal.
-
Go to
Downloads:cd ~/Downloads
-
Install with:
sudo dpkg -i sfdmu-gui-app_X.X.X_amd64.deb
-
Open a terminal.
-
Navigate to
Downloads:cd ~/Downloads
-
Install using:
sudo rpm -i SFDMU-GUI-App-X.X.X-1.x86_64.rpm
- Go to the download location, extract the
.zipfile, and runsfdmu-gui-app-X.X.X Setup.exe. - The app will auto-launch after installation, creating shortcuts on your desktop and in the Start menu.
-
Open a Terminal window.
-
Execute the following command to run the application:
/Applications/sfdmu-gui-app.app/Contents/MacOS/sfdmu-gui-app
- Use the application menu to launch the SFDMU GUI App.
- The app typically launches automatically after installation. For later use, locate it via the Start menu or a desktop shortcut.
Alternatively, instead of using the installable executable, you can clone the source code and run the application directly from it. Detailed documentation for this process is available for guidance.
For comprehensive details on installation, operation, and configuration, visit the SFDMU GUI App Documentation.
