|
1 | 1 | ---- |
2 | | -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.<br /> |
| 2 | +The Salesforce Data Move Utility (SFDMU) is a sophisticated SFDX Plugin designed to streamline the process of populating your Salesforce org (whether scratch, development, sandbox, or production) with data imported from another org or CSV files. It seamlessly supports Delete, Insert, Update, and Upsert operations across multiple related sObjects, enhancing the efficiency and accuracy of data migration tasks. |
3 | 3 |
|
4 | | -- **The SFDMU Plugin repository can be accessed [here](https://github.com/forcedotcom/SFDX-Data-Move-Utility)** |
5 | | -- **For the detailed documentation, visit the [SFDMU Help Center](https://help.sfdmu.com)**<br /><br /> |
6 | | -- **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!** |
| 4 | +- **Access the SFDMU Plugin Repository [here](https://github.com/forcedotcom/SFDX-Data-Move-Utility) for additional resources and information.** |
| 5 | +- **For comprehensive documentation and support, please visit the [SFDMU Help Center](https://help.sfdmu.com).** |
7 | 6 |
|
8 | | ---- |
| 7 | +------ |
9 | 8 |
|
10 | | -### About this App. |
| 9 | +### Discover More About This Application |
11 | 10 |
|
12 | | -**This application can help you to create SFDMU plugin configuration files from the simple and intuitive UI.** |
| 11 | +This user-friendly application is a valuable tool for creating SFDMU plugin configuration files. Its intuitive and interactive user interface simplifies the process, allowing you to focus on your data and migration tasks rather than navigating complex configuration files. |
13 | 12 |
|
| 13 | +------ |
14 | 14 |
|
15 | | -### When can this Application be useful ? |
| 15 | +### Why Use This Application? |
16 | 16 |
|
17 | | -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. |
| 17 | +The `export.json` file, essential for SFDMU setup, houses numerous advanced properties pivotal for crafting and executing complex migration jobs. As the complexity of these jobs escalates, the corresponding JSON file can become extensive and unwieldy, making manual editing using standard text editors a daunting task. |
18 | 18 |
|
19 | | -Therefore in some cases the json file may become very long and hard to edit it manually using the standard Notepad. |
| 19 | +Eliminate the need for Notepad and Console with this Desktop Application. Execute all tasks visually within the application’s interface, transforming the management of migration jobs into a hassle-free experience. Add or remove org connections with ease, swiftly configure SObjects and fields, and initiate the Plugin directly from within the application, saving time and reducing the possibility of errors. |
20 | 20 |
|
21 | | -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. |
| 21 | +### Transitioning to Version 4 |
22 | 22 |
|
| 23 | +We are excited to announce the release of a new major version of the Application (version 4). If you have previously utilized the SFDMU GUI App, it is crucial to review the extensive list of improvements and breaking changes below prior to transitioning to this updated version. These enhancements are designed to offer a more streamlined and efficient user experience, ensuring your data migration tasks are completed effortlessly and accurately. |
23 | 24 |
|
| 25 | +**For detailed instructions on how to install, configure, run, and debug the application, please visit:** |
24 | 26 |
|
25 | | -### Installation and running. |
26 | | -```bash |
27 | | - |
28 | | -# Make sure you have the latest npm / python / yarn / electron installed on your machine, otherwise perform steps 1 - 4 accordingly. |
29 | | - |
30 | | -# 1. Install Python |
31 | | -https://www.python.org/downloads/ |
32 | | - |
33 | | -# 2. Install yarn |
34 | | -https://classic.yarnpkg.com/en/docs/install |
35 | | - |
36 | | -# 3. Install node-gyp globally |
37 | | -yarn global add node-gyp |
38 | | - |
39 | | -# 4. Install electron globally |
40 | | -yarn global add electron |
41 | | - |
42 | | -# 5. Clone this repository. |
43 | | -git clone https://github.com/forcedotcom/SFDX-Data-Move-Utility-Desktop-App.git |
44 | | - |
45 | | -# 6. Go into the project directory. |
46 | | -cd SFDX-Data-Move-Utility-Desktop-App |
47 | | - |
48 | | -# 7. Install npm dependencies |
49 | | -npm install |
50 | | - |
51 | | -# 8. Run the Application. |
52 | | -npm start |
53 | | - |
54 | | -``` |
55 | | - |
56 | | - |
57 | | - |
58 | | -## Notes |
59 | | - |
60 | | -* This Application must have the [SFDMU Plugin](https://github.com/forcedotcom/SFDX-Data-Move-Utility) to be installed in your system previously. |
61 | | -* The Application puts user's data files into the standard **Documents** folder inside dedicated sub-folder named **/SFDMU_APP**. |
62 | | - You can change the default path in the application's ***App Settings*** page. |
63 | | -* The Application also creates a file **user.json** in the application installation directory. This file is being used to store the application settings. |
64 | | - Make sure you are **NOT DELETING** this file during upgrade the Application from the git repository, otherwise the settings will be lost. |
65 | | -* The Application supports multiple local users. |
66 | | - 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. |
67 | | - 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. |
68 | | - |
69 | | - |
70 | | - |
71 | | -## Supported OS |
72 | | - |
73 | | -Normally all major OS (Win, MACOS, Linux) should be supported. It was successfully tested on Windows and MACOS machines. |
74 | | - |
75 | | -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. |
76 | | - |
77 | | -According to the live experience the Application is always working fine in Windows-based systems. |
78 | | - |
79 | | -For the windows-based machines you can try to fix the incorrect electron installation by: |
80 | | - |
81 | | -```bash |
82 | | -npm install --global windows-build-tools |
83 | | - |
84 | | -npm install electron |
85 | | -``` |
86 | | - |
87 | | -## License |
88 | | - |
89 | | -This product is licensed under the BSD-3-Clause - see the [LICENSE.txt](LICENSE.txt) file for details. |
90 | | - |
91 | | - |
| 27 | +**[SFDMU GUI App Help](https://help.sfdmu.com/sfdmu-gui-app)** |
92 | 28 |
|
| 29 | +Embark on a smoother, more intuitive data migration journey with the updated SFDMU application, ensuring reliable and efficient data transfer across your Salesforce orgs. |
0 commit comments