|
1 | | -## SFDMU GUI Application Overview |
| 1 | +## Overview |
2 | 2 |
|
3 | | -The **SFDMU GUI App** enhances the efficiency of creating and managing data migrations within Salesforce environments. |
| 3 | +Welcome to the latest release version of the **SFDMU GUI Application**. |
4 | 4 |
|
5 | | -This tool is a graphical interface for creating and maintaining the **export.json** configuration file used by the [**SFDX Data Move Utility (SFDMU) plugin**](https://github.com/forcedotcom/SFDX-Data-Move-Utility), facilitating the management of sObjects, fields, and organization connections to enhance accuracy and efficiency in data migration tasks. |
| 5 | +For installation instructions and running guidance, please refer to the [README on the master branch](https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App?tab=readme-ov-file). |
6 | 6 |
|
7 | 7 | ## Useful Resources |
8 | 8 |
|
9 | | -- **Comprehensive guidance on the SFDMU GUI App is available at the [SFDMU GUI App Documentation](https://help.sfdmu.com/sfdmu-gui-app).** |
10 | | -- **Access additional resources and the SFDMU Plugin Repository [here](https://github.com/forcedotcom/SFDX-Data-Move-Utility).** |
11 | | -- **For detailed documentation and support, refer to the [SFDMU Help Center](https://help.sfdmu.com/).** |
12 | | - |
13 | | -## Application Benefits |
14 | | - |
15 | | -The **SFDMU GUI App** offers several advantages that enhance user productivity and ensure secure data handling: |
16 | | - |
17 | | -- **Ease of Use:** The intuitive graphical interface simplifies the SFDMU Plugin configuration of migration tasks, even for users with limited technical skills, making complex operations more accessible. |
18 | | -- **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 visual approach helps users better manage and organize their data migration tasks. |
19 | | -- **Error Reduction:** By minimizing common configuration mistakes made during manual file editing, the graphical interface enhances the reliability of data migrations. |
20 | | -- **Secure Data Handling:** All data is processed locally on the client's machine, with the only exception being interaction with the Salesforce REST API. This ensures that your data remains secure and is handled in compliance with strict privacy and security policies. |
21 | | - |
22 | | -## Supported OS |
23 | | - |
24 | | -The application is developed using the [ElectronJS](https://www.electronjs.org/) framework, and supports: |
25 | | - |
26 | | -- Major operating systems including Windows, macOS, and Linux. |
27 | | -- Requires Windows 10 or newer for Windows users. |
28 | | -- Only **x64** CPU architecture is supported. |
29 | | - |
30 | | -## Application Quick Start |
31 | | - |
32 | | -Installing and running the **release version** of the SFDMU GUI App is straightforward, even for users with minimal technical expertise. |
33 | | - |
34 | | -All releases were made using the [Electron Forge Framework](https://www.electronforge.io/). |
35 | | - |
36 | | -### Prerequisites |
37 | | - |
38 | | -Ensure the [SF CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm) is installed before using the SFDMU GUI App. |
39 | | - |
40 | | -### Installation Steps |
41 | | - |
42 | | -**All releases can be found in the ["release"](https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App/tree/release?tab=readme-ov-file) branch of the SFDMU GUI App GitHub repository.** |
43 | | - |
44 | | -#### Step 1. Select the Release Tag |
45 | | - |
46 | | -Navigate to the repository page, locate the "Releases" section on the sidebar, and click on the release tag associated with your desired version. |
47 | | - |
48 | | -#### Step 2. Download the Setup Files |
49 | | - |
50 | | -Download the appropriate setup file for your OS from the subdirectories under `dist/`: |
51 | | - |
52 | | -- **macOS**: |
53 | | - - Go to `dist/darwin/x64/` and download the file, e.g., `sfdmu-gui-app-darwin-x64-X.X.X.zip`. |
54 | | -- **Linux (Debian-based systems)**: |
55 | | - - Navigate to `dist/deb/x64/` and download `sfdmu-gui-app_X.X.X_amd64.deb`. |
56 | | -- **Linux (RPM-based systems)**: |
57 | | - - Visit `dist/rpm/x64/` and download `SFDMU-GUI-App-X.X.X-1.x86_64.rpm`. |
58 | | -- **Windows**: |
59 | | - - Find `dist/windows/x64/` and download the zip package, e.g., `sfdmu-gui-app-X.X.X Setup.zip`. |
60 | | - |
61 | | -#### Step 3. Install the Application |
62 | | - |
63 | | -Follow the instructions below based on your operating system to complete the installation: |
64 | | - |
65 | | -##### macOS: |
66 | | -1. Open `Downloads`, find the `.zip` file, and extract it to get the `sfdmu-gui-app.app`. |
67 | | -2. Move the application to your `Applications` folder. |
68 | | - |
69 | | -##### Linux (Debian-based): |
70 | | -1. Open a terminal. |
71 | | -2. Go to `Downloads`: |
72 | | - ```bash |
73 | | - cd ~/Downloads |
74 | | - ``` |
75 | | -3. Install with: |
76 | | - ```bash |
77 | | - sudo dpkg -i sfdmu-gui-app_X.X.X_amd64.deb |
78 | | - ``` |
79 | | - |
80 | | -##### Linux (RPM-based): |
81 | | -1. Open a terminal. |
82 | | -2. Navigate to `Downloads`: |
83 | | - ```bash |
84 | | - cd ~/Downloads |
85 | | - ``` |
86 | | -3. Install using: |
87 | | - ```bash |
88 | | - sudo rpm -i SFDMU-GUI-App-X.X.X-1.x86_64.rpm |
89 | | - ``` |
90 | | - |
91 | | -##### Windows: |
92 | | -1. Go to the download location, extract the `.zip` file, and run `sfdmu-gui-app-X.X.X Setup.exe`. |
93 | | -2. The app will auto-launch after installation, creating shortcuts on your desktop and in the Start menu. |
94 | | - |
95 | | -### Running the Application |
96 | | - |
97 | | -- **macOS:** Open `sfdmu-gui-app.app` from your `Applications` folder. |
98 | | -- **Linux:** Use the application menu to launch the SFDMU GUI App. |
99 | | -- **Windows:** The app typically launches automatically after installation; for later use, find it via the Start menu or desktop shortcut. |
100 | | - |
101 | | -## Running the Application from Source Code |
102 | | - |
103 | | -Alternatively, instead of using the installable executable, you can clone the source code and run the application directly from it. Please refer to the detailed documentation for guidance. |
104 | | - |
105 | | ---- |
106 | | - |
107 | | -**For comprehensive details on installation, operation, and configuration, visit the** [SFDMU GUI App Documentation](https://help.sfdmu.com/sfdmu-gui-app). |
| 9 | +- **Find comprehensive guidance on the SFDMU GUI App at the [SFDMU GUI App Documentation](https://help.sfdmu.com/sfdmu-gui-app).** |
| 10 | +- **Access the SFDMU Plugin Repository and additional resources [here](https://github.com/forcedotcom/SFDX-Data-Move-Utility).** |
| 11 | +- **For detailed documentation and support, visit the [SFDMU Help Center](https://help.sfdmu.com/).** |
0 commit comments