Skip to content

Commit 9834d93

Browse files
authored
Update README.md
1 parent 1338d54 commit 9834d93

1 file changed

Lines changed: 54 additions & 29 deletions

File tree

README.md

Lines changed: 54 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,60 @@
11
## SFDMU GUI Application Overview
22

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.
64

75
## Useful Resources
86

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/).**
7+
- **Detailed Documentation of SFDMU GUI App**: [SFDMU GUI App Reference Guide](https://help.sfdmu.com/sfdmu-gui-app).
8+
- **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/).
1210

1311
## Application Benefits
1412

1513
The **SFDMU GUI App** offers several advantages that enhance user productivity and ensure secure data handling:
1614

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 tasks for 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.
2119

2220
## Supported OS
2321

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:
2523

2624
- Major operating systems including Windows, macOS, and Linux.
2725
- Requires Windows 10 or newer for Windows users.
28-
- Only **x64** CPU architecture is supported.
26+
- Only x64 CPU architecture is supported.
2927

3028
## Application Quick Start
3129

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/).
3531

36-
### Prerequisites
32+
## Prerequisites
3733

3834
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.
3935

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/).
45+
- **Linux (Debian-based systems)**: Access the `deb` installation file here: [Debian x64 setup](https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App/tree/release/dist/deb/x64/).
46+
- **Linux (RPM-based systems)**: Access the `rpm` installation file here: [RPM x64 setup](https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App/tree/release/dist/rpm/x64/).
47+
- **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/).
4148

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:
4358

4459
#### Step 1. Select the Release Tag
4560

@@ -49,58 +64,68 @@ Navigate to the repository page, locate the "Releases" section on the sidebar, a
4964

5065
Download the appropriate setup file for your OS from the subdirectories under `dist/`:
5166

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`.
6073

6174
#### Step 3. Install the Application
6275

63-
Follow the instructions below based on your operating system to complete the installation:
76+
Follow the installation instructions provided for each operating system:
6477

6578
##### macOS:
79+
6680
1. Open `Downloads`, find the `.zip` file, and extract it to get the `sfdmu-gui-app.app`.
6781
2. Move the application to your `Applications` folder.
6882

6983
##### Linux (Debian-based):
84+
7085
1. Open a terminal.
86+
7187
2. Go to `Downloads`:
88+
7289
```bash
7390
cd ~/Downloads
7491
```
92+
7593
3. Install with:
94+
7695
```bash
7796
sudo dpkg -i sfdmu-gui-app_X.X.X_amd64.deb
7897
```
7998

8099
##### Linux (RPM-based):
100+
81101
1. Open a terminal.
102+
82103
2. Navigate to `Downloads`:
104+
83105
```bash
84106
cd ~/Downloads
85107
```
108+
86109
3. Install using:
110+
87111
```bash
88112
sudo rpm -i SFDMU-GUI-App-X.X.X-1.x86_64.rpm
89113
```
90114

91115
##### Windows:
116+
92117
1. Go to the download location, extract the `.zip` file, and run `sfdmu-gui-app-X.X.X Setup.exe`.
93118
2. The app will auto-launch after installation, creating shortcuts on your desktop and in the Start menu.
94119

95-
### Running the Application
120+
#### Step 4. Run the Application
96121

97122
- **macOS:** Open `sfdmu-gui-app.app` from your `Applications` folder.
98123
- **Linux:** Use the application menu to launch the SFDMU GUI App.
99124
- **Windows:** The app typically launches automatically after installation; for later use, find it via the Start menu or desktop shortcut.
100125

101126
## Running the Application from Source Code
102127

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.
104129

105130
---
106131

0 commit comments

Comments
 (0)