You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-29Lines changed: 54 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,45 +1,60 @@
1
1
## SFDMU GUI Application Overview
2
2
3
-
The **SFDMU GUI App** enhances the efficiency of creating and managing data migrations within Salesforce environments.
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.
3
+
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**](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.
6
4
7
5
## Useful Resources
8
6
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/).**
-**SFDMU Plugin Repository**: [SFDX Data Move Utility](https://github.com/forcedotcom/SFDX-Data-Move-Utility).
9
+
-**SFDMU Knowledgebase and Documentation Portal**: [SFDMU Help Center](https://help.sfdmu.com/).
12
10
13
11
## Application Benefits
14
12
15
13
The **SFDMU GUI App** offers several advantages that enhance user productivity and ensure secure data handling:
16
14
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.
15
+
-**Ease of Use**: The intuitive graphical interface simplifies the configuration of migration tasksfor the **SFDMU Plugin**, making complex operations more accessible even to users with limited technical skills.
16
+
-**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.
17
+
-**Error Reduction**: The application detects common configuration and metadata mistakes made during manual `export.json`file editing, enhancing the reliability of data migrations.
18
+
-**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.
21
19
22
20
## Supported OS
23
21
24
-
The application is developed using the [ElectronJS](https://www.electronjs.org/) framework, and supports:
22
+
The application is developed using the [ElectronJS](https://www.electronjs.org/) framework and supports:
25
23
26
24
- Major operating systems including Windows, macOS, and Linux.
27
25
- Requires Windows 10 or newer for Windows users.
28
-
- Only **x64** CPU architecture is supported.
26
+
- Only x64 CPU architecture is supported.
29
27
30
28
## Application Quick Start
31
29
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/).
30
+
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](https://www.electronforge.io/).
35
31
36
-
###Prerequisites
32
+
## Prerequisites
37
33
38
34
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
35
40
-
### Installation Steps
36
+
## Installation and Running
37
+
38
+
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.
39
+
40
+
### Installation of Latest Release
41
+
42
+
Download and install the latest release of the SFDMU GUI App for your operating system:
43
+
44
+
-**macOS**: Access the `zip` installation file here: [macOS x64 setup](https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App/tree/release/dist/darwin/x64/).
-**Windows**: Access the `zip` file containing the setup executable here: [Windows x64 setup](https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App/tree/release/dist/windows/x64/).
41
48
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.**
49
+
To install:
50
+
51
+
1. Click on the link provided for your operating system to navigate to the download page.
52
+
2. Once on the page, use the download link located at the top right to download the file.
53
+
3. Follow the steps specific to your operating system for installation and running the application as detailed in **Steps 3 and 4**.
54
+
55
+
### Installation of Specific Release
56
+
57
+
For those wishing to run a specific release of the SFDMU GUI App:
43
58
44
59
#### Step 1. Select the Release Tag
45
60
@@ -49,58 +64,68 @@ Navigate to the repository page, locate the "Releases" section on the sidebar, a
49
64
50
65
Download the appropriate setup file for your OS from the subdirectories under `dist/`:
51
66
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`.
67
+
-**macOS**: Navigate to `dist/darwin/x64/` and download the file, e.g., `sfdmu-gui-app-darwin-x64-X.X.X.zip`.
68
+
-**Linux (Debian-based)**: Go to `dist/deb/x64/` and download `sfdmu-gui-app_X.X.X_amd64.deb`.
69
+
-**Linux (RPM-based)**: Visit `dist/rpm/x64/` and download `SFDMU-GUI-App-X.X
70
+
71
+
.X-1.x86_64.rpm`.
72
+
-**Windows**: Find `dist/windows/x64/` and download the zip package, e.g., `sfdmu-gui-app-X.X.X Setup.zip`.
60
73
61
74
#### Step 3. Install the Application
62
75
63
-
Follow the instructions below based on your operating system to complete the installation:
76
+
Follow the installation instructions provided for each operating system:
64
77
65
78
##### macOS:
79
+
66
80
1. Open `Downloads`, find the `.zip` file, and extract it to get the `sfdmu-gui-app.app`.
67
81
2. Move the application to your `Applications` folder.
68
82
69
83
##### Linux (Debian-based):
84
+
70
85
1. Open a terminal.
86
+
71
87
2. Go to `Downloads`:
88
+
72
89
```bash
73
90
cd~/Downloads
74
91
```
92
+
75
93
3. Install with:
94
+
76
95
```bash
77
96
sudo dpkg -i sfdmu-gui-app_X.X.X_amd64.deb
78
97
```
79
98
80
99
##### Linux (RPM-based):
100
+
81
101
1. Open a terminal.
102
+
82
103
2. Navigate to `Downloads`:
104
+
83
105
```bash
84
106
cd~/Downloads
85
107
```
108
+
86
109
3. Install using:
110
+
87
111
```bash
88
112
sudo rpm -i SFDMU-GUI-App-X.X.X-1.x86_64.rpm
89
113
```
90
114
91
115
##### Windows:
116
+
92
117
1. Go to the download location, extract the `.zip` file, and run `sfdmu-gui-app-X.X.X Setup.exe`.
93
118
2. The app will auto-launch after installation, creating shortcuts on your desktop and in the Start menu.
94
119
95
-
###Running the Application
120
+
#### Step 4. Run the Application
96
121
97
122
-**macOS:** Open `sfdmu-gui-app.app` from your `Applications` folder.
98
123
-**Linux:** Use the application menu to launch the SFDMU GUI App.
99
124
-**Windows:** The app typically launches automatically after installation; for later use, find it via the Start menu or desktop shortcut.
100
125
101
126
## Running the Application from Source Code
102
127
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.
128
+
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.
0 commit comments