SFDX Data Move Utility

https://help.sfdmu.com/
Admin
The SFDX Data Move Utility (SFDMU) is a powerful and versatile open-source Salesforce data migration...
Tokens:74,282
Snippets:928
Trust Score:3.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install windows-build-tools

Source: https://help.sfdmu.com/sfdmu-gui-app

Use npm to install `windows-build-tools` as a prerequisite for Windows installations.

```bash
npm install --global windows-build-tools

```

--------------------------------

### Install node-gyp Globally

Source: https://help.sfdmu.com/sfdmu-gui-app

Install `node-gyp` globally via npm before proceeding with the application setup.

```bash
npm install --global node-gyp

```

--------------------------------

### Start the Application

Source: https://help.sfdmu.com/sfdmu-gui-app

Run the application without debugging using the npm start script.

```bash
npm start

```

--------------------------------

### Install SFDMU using SF CLI

Source: https://help.sfdmu.com/faq/plugin-usage-and-extensions/is-sfdmu-compatible-with-latest-sf-cli

Use this command to install SFDMU as a plugin for the SF CLI.

```bash
sf plugins install sfdmu
```

--------------------------------

### Install and Run SFDMU GUI App on Windows

Source: https://help.sfdmu.com/troubleshooting/gui-installation-problems/gui-app-installation-failed-or-showing-blank-screen

Steps to install and run the SFDMU GUI App on Windows after encountering installation or blank screen issues. Ensure Visual Studio Build Tools with C++ development and Python are installed.

```bash
npm install
npm run build
npm start
```

--------------------------------

### Install SFDMU Add-on SDK

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Install the SDK in your add-on project using npm.

```bash
npm install <absolute-path-to>/custom-addon-sdk
```

--------------------------------

### Accessing and Logging Source/Target Org Information

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

This example demonstrates how to get the current script and access its source and target org objects to log their names and media types. Useful for differentiating between org-to-org and file-based migrations.

```typescript
const script = this.runtime.getScript();
const sourceOrg = script.sourceOrg;
const targetOrg = script.targetOrg;

this.runtime.service.log(this, `source=${String(sourceOrg?.name ?? '')}`, 'INFO');
this.runtime.service.log(this, `target=${String(targetOrg?.name ?? '')}`, 'INFO');
this.runtime.service.log(this, `sourceIsFile=${String(sourceOrg?.isFileMedia ?? false)}`, 'INFO');

```

--------------------------------

### Install Project Dependencies

Source: https://help.sfdmu.com/sfdmu-gui-app

Install all necessary project dependencies using npm after navigating to the project directory.

```bash
npm install

```

--------------------------------

### Valid All-Slave Configuration Example

Source: https://help.sfdmu.com/faq/sfdmu-configuration-and-pre-validation/can-all-objects-be-defined-as-slave-objects-in-the-configuration

This JSON configuration demonstrates a valid setup where all objects are defined as slaves, relying on provided external IDs for filtering. Ensure 'providedAccountIds' or similar variables are supplied by an external source.

```json
{
    "objects": [
        {
            "query": "SELECT Id FROM Account WHERE Id IN :providedAccountIds",
            "externalId": "Name",
            "operation": "Upsert",
            "master": false
        },
        {
            "query": "SELECT Id, AccountId FROM Contact WHERE AccountId IN :providedAccountIds",
            "externalId": "LastName",
            "operation": "Upsert",
            "master": false
        },
        {
            "query": "SELECT Id, AccountId FROM Opportunity WHERE AccountId IN :providedAccountIds",
            "externalId": "Name",
            "operation": "Upsert",
            "master": false
        }
    ]
}
```

--------------------------------

### Install RPM Package (Linux)

Source: https://help.sfdmu.com/sfdmu-gui-app

Install the SFDMU GUI App on RPM-based Linux systems using the rpm command with the downloaded .rpm file.

```bash
sudo rpm -i SFDMU-GUI-App-X.X.X-1.x86_64.rpm
```

--------------------------------

### Complete Add-On Manifest Entry Example

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

An example of a full object-level manifest entry for a custom add-on, specifying event, command, locators, description, filters, and arguments.

```json
{
  "beforeUpdateAddons": [
    {
      "event": "onBeforeUpdate",
      "command": "sfdmu:run",
      "module": "./custom-addon-sdk/custom-modules/my-addon/dist/index.js",
      "path": "./custom-addon-sdk/custom-modules/my-addon/dist/index.js",
      "description": "Normalize Account fields before update",
      "objects": ["Account"],
      "objectName": "Account",
      "excluded": false,
      "args": {
        "trimFields": ["Name", "BillingCity"],
        "schemaVersion": 1
      }
    }
  ]
}
```

--------------------------------

### Example package.json for Add-on

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Configuration for an SFDMU add-on's package.json, specifying main entry points and build scripts.

```json
{
  "name": "my-sfdmu-addon",
  "version": "1.0.0",
  "type": "module",
  "main": "./dist/index.js",
  "types": "./index.ts",
  "scripts": {
    "compile": "tsc -p . --pretty",
    "build": "npm run compile"
  }
}
```

--------------------------------

### Install Debian Package (Linux)

Source: https://help.sfdmu.com/sfdmu-gui-app

Install the SFDMU GUI App on Debian-based Linux systems using the dpkg command with the downloaded .deb file.

```bash
sudo dpkg -i sfdmu-gui-app_X.X.X_amd64.deb
```

--------------------------------

### Install Latest SFDMU Plugin Version

Source: https://help.sfdmu.com/installation

Install the latest production version of the SFDMU plugin using the SF CLI. This is the recommended installation method.

```bash
# Install the latest version of the plugin:
$ sf plugins install sfdmu
```

--------------------------------

### Example export.json Configuration

Source: https://help.sfdmu.com/troubleshooting/plugin-connectivity-and-configuration/plugin-cannot-locate-export-json-in-working-directory

This is an example of the export.json file structure required by SFDMU. Ensure your file matches this format.

```json
{
  "objects": [
    {
      "query": "SELECT Id, Name FROM Account",
      "operation": "Upsert",
      "externalId": "Name"
    }
  ]
}

```

--------------------------------

### Manage SFDMU Plugin Installation

Source: https://help.sfdmu.com/get-started

Commands for uninstalling, installing the latest, or installing a specific version of the SFDMU plugin.

```bash
# Uninstall an old version of the Plugin, if any:
sf plugins uninstall sfdmu

# Install the latest version of the Plugin:
sf plugins install sfdmu

# Or install the latest version using an explicit latest tag:
sf plugins install sfdmu@latest

# Or install a specific plugin version:
sf plugins install sfdmu@<version>

```

--------------------------------

### ProductAttributeSet CSV Example

Source: https://help.sfdmu.com/examples/advanced-examples

Example CSV file for the ProductAttributeSet object. This object is Readonly and must be preconfigured.

```csv
MasterLabel | DeveloperName  
Campus | Campus_1  
```

--------------------------------

### NPM Package Installation

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Installs a custom add-on distributed as an NPM package.

```bash
npm install my-company-sfdmu-addon
```

--------------------------------

### Example Working Folder Structure

Source: https://help.sfdmu.com/full-documentation/reports/the-execution-log

Illustrates the typical directory structure including the export.json file and the logs subdirectory containing timestamped log files.

```text
|- export.json
|- logs/
   |- 2024-04-24__02_17_22.log
   |- 2024-04-25__15_43_07.log
   |- ...

```

--------------------------------

### Install npm Modules for SFDMU

Source: https://help.sfdmu.com/installation

Install the required Node.js modules for the SFDMU plugin. This step is essential when installing from source code.

```bash
# Install required npm modules:
$ npm install
```

--------------------------------

### ProductAttribute CSV Example

Source: https://help.sfdmu.com/examples/advanced-examples

Example CSV file for the ProductAttribute object, demonstrating the use of composite keys for linking products and variant parents.

```csv
Campus__c | Sequence | $$Product.StockKeepingUnit$VariantParent.ProductCode | Product.$$ProductCode$StockKeepingUnit | VariantParent.$$ProductCode$StockKeepingUnit  
Oslo | 1 | BACH-F-1; BACH-F | BACH-F-1 | BACH-F  
Jerusalem | 2 | BACH-F-2; BACH-F | BACH-F-2 | BACH-F  
```

--------------------------------

### Install SFDMU Plugin with Sudo (macOS)

Source: https://help.sfdmu.com/get-started

Use the 'sudo' prefix for the installation command if you encounter permission issues on macOS.

```bash
sudo sf plugins install sfdmu

```

--------------------------------

### Minimal ExportFiles Module Setup

Source: https://help.sfdmu.com/full-documentation/add-on-api/export-file-core-add-on-module

Declare the core:ExportFiles module within the 'afterAddons' array for minimal setup. This ensures the module runs after parent records are processed, allowing file links to be created against target parent records.

```json
{
  "objects": [
    {
      "operation": "Upsert",
      "externalId": "Name",
      "query": "SELECT Name FROM Account",
      "afterAddons": [
        {
          "module": "core:ExportFiles"
        }
      ]
    }
  ]
}
```

--------------------------------

### Example Generated Add-on Entry File

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

A basic implementation of an SFDMU custom add-on module using the provided template.

```typescript
export default class MyAddon implements ISfdmuRunCustomAddonModule {
  public runtime: ISfdmuRunCustomAddonRuntime;
  public constructor(runtime: ISfdmuRunCustomAddonRuntime) {
    this.runtime = runtime;
  }
  public async onExecute(
    context: ISfdmuRunCustomAddonContext,
    args: Record<string, unknown>
  ): Promise<ISfdmuRunCustomAddonResult> {
    this.runtime.service.log(this, 'Hello from template', 'INFO');
    this.runtime.service.log(this, args, 'JSON');
    return { cancel: false };
  }
}
```

--------------------------------

### Example tsconfig.json for Add-on

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

TypeScript configuration for an SFDMU add-on, specifying module resolution and output directories.

```json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "outDir": "./dist",
    "rootDir": ".",
    "sourceMap": true,
    "strict": true
  },
  "include": ["./index.ts"]
}
```

--------------------------------

### Product2 CSV Example

Source: https://help.sfdmu.com/examples/advanced-examples

Example CSV file for the Product2 object, including fields for variations and variation parents. It utilizes composite keys for external IDs.

```csv
Name | Type | IsActive | StockKeepingUnit | ProductClass | ProductCode | $$ProductCode$StockKeepingUnit  
Bachelor i Finance | Base | TRUE |  | VariationParent | BACH-F | BACH-F  
Bachelor i Finance Oslo |  | TRUE | BACH-F-1 | Variation |  | BACH-F-1  
Bachelor i Finance Jerusalem |  | TRUE | BACH-F-2 | Variation |  | BACH-F-2  
```

--------------------------------

### ProductAttributeSetProduct CSV Example

Source: https://help.sfdmu.com/examples/advanced-examples

Example CSV file for the ProductAttributeSetProduct object, used for linking attribute sets to products with composite keys.

```csv
ProductAttributeSet.DeveloperName | $$ProductAttributeSet.DeveloperName$Product.ProductCode | Product.$$ProductCode$StockKeepingUnit  
Campus_1 | Campus_1; BACH-F | BACH-F  
```

--------------------------------

### Start Debug Session

Source: https://help.sfdmu.com/sfdmu-gui-app

Initiate a debug session for the application by running the npm debug script. This command compiles the source code and starts the debugger.

```bash
npm run debug

```

--------------------------------

### Example Folder Structure for Plugin Migrations

Source: https://help.sfdmu.com/full-documentation/reports/issues-with-missing-parent-lookup-records

Illustrates the typical directory layout for plugin migration projects, including the placement of export.json and the reports subdirectory containing MissingParentRecordsReport.csv.

```text
|- export.json
|- reports/
   |- MissingParentRecordsReport.csv
   |- object-set-2/
      |- MissingParentRecordsReport.csv
   |- object-set-3/
      |- MissingParentRecordsReport.csv
   |- ...

```

--------------------------------

### Install Previous SFDMU Plugin Version

Source: https://help.sfdmu.com/get-started

Use these commands to uninstall the current SFDMU plugin and install a specific previous stable version.

```bash
# Remove current plugin
sf plugins uninstall sfdmu

# Install previous stable version
sf plugins install sfdmu@4.39.0

```

--------------------------------

### Run SFDMU GUI App (macOS)

Source: https://help.sfdmu.com/sfdmu-gui-app

Execute this command in the Terminal to launch the SFDMU GUI App on macOS after installation.

```bash
/Applications/sfdmu-gui-app.app/Contents/MacOS/sfdmu-gui-app
```

--------------------------------

### Example SFDMU Folder Structure

Source: https://help.sfdmu.com/full-documentation/reports/the-target-csv-files

Illustrates the expected directory and file layout when SFDMU generates target CSV files, including subdirectories for multiple object sets.

```text
|- export.json
|- target/
   |- TestObject_Description__c_delete_target.csv
   |- AnotherObject_Status__c_update_target.csv
   |- ...
   |- object-set-2/
      |- TestObject_Description__c_delete_target.csv
      |- AnotherObject_Status__c_update_target.csv
      |- ...
   |- object-set-3/
      |- TestObject_Description__c_delete_target.csv
      |- AnotherObject_Status__c_update_target.csv
      |- ...
   |- ...

```

--------------------------------

### Basic SFDMU Configuration for Upserting Accounts

Source: https://help.sfdmu.com/get-started

Example export.json configuration for performing basic upserts on Account objects, using 'Name' as the external ID.

```json
{
    "objects": [
        {
            "query": "SELECT Id, Name FROM Account",
            "operation": "Upsert",
            "externalId": "Name"
        }
    ]
}

```

--------------------------------

### NPM Package Deployment Configuration

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

References an installed NPM package as the add-on module.

```json
{
  "addons": [
    {
      "event": "onAfter",
      "module": "my-company-sfdmu-addon"
    }
  ]
}
```

--------------------------------

### Script Object Structure Example

Source: https://help.sfdmu.com/full-documentation/export-json-file-objects-specification/script-object

Illustrates the basic structure of the Script object within the export.json file, showing how to define objects for data migration.

```json
{
  // Root level of export.json functions as the global Script object for setting migration parameters.
  "objects": [
          // Array for configuring individual data migration objects; a Script object property.
         {
          "query": "SELECT Id, Name, Phone FROM Account",
          "operation": "Upsert",
          "externalId": "AccountExternalId__c"
        }
  ]            
  // Additional global Script object properties
}
```

--------------------------------

### Advanced SFDMU Configuration for Related SObjects

Source: https://help.sfdmu.com/get-started

Example export.json configuration for upserting multiple related SObjects, demonstrating how to maintain complex relationships.

```json
{
    "objects": [
        {
            "query": "SELECT Id, Phone, TestObject3__c FROM Account WHERE Name LIKE 'TEST_ACC_%'",
            "operation": "Upsert",
            "externalId": "Name"
        },
        {
            "query": "SELECT Id, Account__c, TestObject3__c, RecordTypeId FROM TestObject__c",
            "operation": "Upsert",
            "externalId": "Name"
        },
        {
            "query": "SELECT Id, Account__c, TestObject__c FROM TestObject2__c",
            "operation": "Upsert",
            "externalId": "Name"
        },
        {
            "query": "SELECT Id, TestObject2__c FROM TestObject3__c",
            "operation": "Upsert",
            "externalId": "Name"
        }
    ]
}

```

--------------------------------

### Script Object: afterAddons Configuration

Source: https://help.sfdmu.com/full-documentation/export-json-file-objects-specification/script-object

Example of configuring 'afterAddons' in export.json to execute specific modules after the migration process for data cleanup.

```json
{
  "objects": [],
  "afterAddons": [
    {
      "module": "GeneralCleanup",
      "args": {
        "cleanupAction": "Remove Obsolete Data"
      }
    }
  ]
  // ... other export.json properties 
}
```

--------------------------------

### Example SFDMU Project Folder Structure

Source: https://help.sfdmu.com/full-documentation/reports/issues-with-the-source-csv-files

This illustrates the typical directory layout for an SFDMU project, highlighting the location of the export.json file and the reports subdirectory where CSVIssuesReport.csv is generated.

```text
|- export.json
|- reports/
   |- CSVIssuesReport.csv
   |- object-set-2/
      |- CSVIssuesReport.csv
   |- object-set-3/
      |- CSVIssuesReport.csv
   |- ...

```

--------------------------------

### Windows Debug Launch Command

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Example command to launch SFDMU in debug mode on Windows, enabling IDE debugger attachment.

```bash
sfdmu-run-debug.cmd --sourceusername DEMO-SOURCE --targetusername DEMO-TARGET --path ".\\path\\to\\migration-folder"
```

--------------------------------

### Insert Variation Attributes and Product Variations

Source: https://help.sfdmu.com/examples/advanced-examples

This example shows how to insert Product2 variations, Product Attributes, and their relationships. It highlights that ProductAttributeSet is readonly and requires preconfiguration.

```json
{
    "objects": [
        {
            "query": "SELECT Name, Type, IsActive, StockKeepingUnit, ProductClass, ProductCode FROM Product2 WHERE IsActive = true AND ProductClass IN ('Variation', 'VariationParent')",
            "operation": "Insert",
            "master": false
        },
        {
            "query": "SELECT MasterLabel FROM ProductAttributeSet",
            "externalId": "DeveloperName",
            "operation": "Readonly"
        },
        {
            "query": "SELECT Campus__c, Sequence, ProductId, VariantParentId FROM ProductAttribute",
            "operation": "Insert"
        },
        {
            "query": "SELECT ProductAttributeSetId, ProductId FROM ProductAttributeSetProduct",
            "operation": "Insert"
        }
    ],
    "excludeIdsFromCSVFiles": true
}

```

--------------------------------

### Minimal ISfdmuRunCustomAddonModule Implementation

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

A basic implementation of the ISfdmuRunCustomAddonModule interface, demonstrating the constructor and the onInit/onExecute hooks. Use this as a starting point for your custom add-ons.

```typescript
import type {
  ISfdmuRunCustomAddonContext,
  ISfdmuRunCustomAddonModule,
  ISfdmuRunCustomAddonResult,
  ISfdmuRunCustomAddonRuntime
} from 'sfdmu-addon-sdk';

export default class MyAddon implements ISfdmuRunCustomAddonModule {
  public runtime: ISfdmuRunCustomAddonRuntime;

  public constructor(runtime: ISfdmuRunCustomAddonRuntime) {
    this.runtime = runtime;
  }

  public async onInit(
    context: ISfdmuRunCustomAddonContext,
    args: Record<string, unknown>
  ): Promise<ISfdmuRunCustomAddonResult> {
    this.runtime.service.log(this, `Init ${context.moduleDisplayName}`, 'INFO');
    this.runtime.service.log(this, args, 'JSON');
    return { cancel: false };
  }

  public async onExecute(
    context: ISfdmuRunCustomAddonContext,
    args: Record<string, unknown>
  ): Promise<ISfdmuRunCustomAddonResult> {
    this.runtime.service.log(this, `Execute ${context.eventName}`, 'INFO');
    this.runtime.service.log(this, args, 'JSON');
    return { cancel: false };
  }
}

```

--------------------------------

### SFDMU Configuration with Include Regex

Source: https://help.sfdmu.com/faq/sfdmu-configuration-and-pre-validation/how-to-modify-include-regex-option-in-sfdmu-configuration

This is an example of an SFDMU configuration snippet that includes the 'includedRegex' and 'excludedRegex' fields for mock fields. Use this as a reference for the original configuration.

```json
{
  "objects": [
    {
      "operation": "Upsert",
      "externalId": "FirstName;LastName;Email",
      "mockFields": [
        {
          "name": "Phone",
          "pattern": "phone",
          "excludedRegex": "",
          "includedRegex": ""
        },
        {
          "name": "Fax",
          "pattern": "phone",
          "excludedRegex": "*"
        }
      ],
      "master": false,
      "query": "SELECT Id, Name, updateable_true FROM Contact",
      "updateWithMockData": true
    }
  ]
}

```

--------------------------------

### Example CLI Error Output

Source: https://help.sfdmu.com/troubleshooting/security-authentication-issues/allow-disabling-ssl-and-hash-checks-for-plugin-linking

This output shows a typical SSL error encountered when linking plugins in a restricted network environment, indicating issues with certificate verification.

```bash
PS C:\Sandbox\SFDX-Data-Move-Utility> sfdx plugins:link
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.

(node:5912) Warning: Setting the NODE_TLS_REJECT_UNAUTHORIZED environment variable to '0' makes TLS connections and HTTPS requests insecure by disabling certificate verification.

error An unexpected error occurred: "SSL Error: UNABLE_TO_GET_ISSUER_CERT_LOCALLY".

sfdx-cli: linking plugin sfdmu... !

Error: yarn --non-interactive --mutex=file:C:\Sandbox\SFDX-Data-Move-Utility\yarn.lock

--preferred-cache-folder=C:\Users\1219611\AppData\Local\sfdx\yarn --check-files exited with code 1

PS C:\Sandbox\SFDX-Data-Move-Utility>
```

--------------------------------

### Debug Logging in Custom Add-On

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Provides example logging statements within a custom add-on to aid in debugging and verifying execution flow.

```javascript
this.runtime.service.log(this, 'Debug marker: before map step', 'INFO');
const data = this.runtime.service.getProcessedData(context);
this.runtime.service.log(this, `recordsToInsert=${data.recordsToInsert.length}`, 'INFO');
```

--------------------------------

### Configure DeleteHierarchy Operation

Source: https://help.sfdmu.com/full-documentation/advanced-features/delete-by-hierarchy

Example configuration for the DeleteHierarchy operation in export.json. This setup targets Accounts for deletion based on their IDs.

```json
{
    "objects": [
        {
            "operation": "DeleteHierarchy",
            "externalId": "Id",
            "query": "SELECT Id FROM Account"
        }
    ]
}
```

--------------------------------

### Configure RecordsFilter Module in export.json

Source: https://help.sfdmu.com/full-documentation/add-on-api/records-filter-core-add-on-module

Declare and configure the core:RecordsFilter module in your export.json file to enable advanced filtering of source records. This example shows the setup for the BadWords filter.

```json
{
     "objects": [
     {
         "operation": "Upsert",
         "externalId": "LastName",
         "query": "SELECT LastName, Description FROM Contact",
         "filterRecordsAddons": [
            {
                "module": "core:RecordsFilter",
                "args" : {
                    "filterType": "BadWords",
                    "settings" : {
                        "badwordsFile": "./badwords.json",
                        "detectFields": [
                            "Description"
                        ],
                        "highlightWords" : true,
                        "outputMatches": true
                    }
                }
            }
         ]
     }
 ]
}
```

--------------------------------

### Invalid All-Slave Configuration Example

Source: https://help.sfdmu.com/faq/sfdmu-configuration-and-pre-validation/can-all-objects-be-defined-as-slave-objects-in-the-configuration

This JSON configuration illustrates an invalid all-slave setup. Without explicit record filtering (e.g., using ':providedAccountIds'), slave objects cannot fetch data, leading to failure.

```json
{
    "objects": [
        {
            "query": "SELECT Id FROM Account",
            "externalId": "Name",
            "operation": "Upsert",
            "master": false
        },
        {
            "query": "SELECT Id, AccountId FROM Contact",
            "externalId": "LastName",
            "operation": "Upsert",
            "master": false
        },
        {
            "query": "SELECT Id, AccountId FROM Opportunity",
            "externalId": "Name",
            "operation": "Upsert",
            "master": false
        }
    ]
}
```

--------------------------------

### Task Information and Filtering

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Get the current plugin task and log its sObject name, operation, and update mode. Includes an example of filtering temporary records based on the 'Name' field during a 'filterRecordsAddons' event.

```typescript
const task = this.runtime.service.getPluginTask(context);
if (!task) {
  return { cancel: false };
}

this.runtime.service.log(this, `sObject=${task.sObjectName}`, 'INFO');
this.runtime.service.log(this, `operation=${String(task.operation)}`, 'INFO');
this.runtime.service.log(this, `updateMode=${task.updateMode}`, 'INFO');

if (context.eventName === 'filterRecordsAddons') {
  task.tempRecords = task.tempRecords.filter((record) => String(record['Name'] ?? '').length > 0);
}

```

--------------------------------

### SFDMU Query for Master Object (Language__c) with Multiple Masters

Source: https://help.sfdmu.com/faq/conceptual-definitions-in-sfdmu/what-is-master-and-what-is-slave

Example query for a 'Language__c' master object when multiple masters are defined. Note the LIMIT clause is preserved.

```sql
SELECT Id, Name, Language__c, Language__r.Code__c FROM Account LIMIT 10

```

--------------------------------

### Build the Project

Source: https://help.sfdmu.com/sfdmu-gui-app

Build the project using npm. This step can be omitted if a pre-compiled version is downloaded.

```bash
npm run build

```

--------------------------------

### Create Custom Add-on from Template

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Command to generate a new custom add-on project using the provided script.

```bash
node scripts/create-custom-addon-template.js <addon-name>
```

--------------------------------

### Using Runtime Logging Helpers

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Demonstrates the use of various logging methods provided by the ISfdmuRunCustomAddonRuntime, including formatted messages and execution start/finish markers. Helps in creating detailed and traceable logs for add-on execution.

```typescript
this.runtime.logAddonExecutionStarted(this);
this.runtime.logFormattedInfo(this, 'Addon started for object %s', context.objectName);
this.runtime.logFormattedInfoVerbose(this, 'args=%s', JSON.stringify(args));
this.runtime.logFormattedWarning(this, 'Running in validation mode only');
this.runtime.logAddonExecutionFinished(this);
```

--------------------------------

### Example Configuration with Multiple Object Sets

Source: https://help.sfdmu.com/full-documentation/advanced-features/multiple-object-sets

This configuration defines two distinct object subsets. The first subset deletes Accounts and Opportunities, while the second subset inserts an Account record. This demonstrates handling the same Account object in different operations within a single job.

```json
{
  "objectSets": [
    {
      "objects": [
        {
          "query": "SELECT Id FROM Account",
          "operation": "DeleteHierarchy"
        },
        {
          "query": "SELECT Id FROM Opportunity",
          "operation": "DeleteHierarchy"
        }
      ]
    },
    {
      "objects": [
        {
          "query": "SELECT Name FROM Account LIMIT 1",
          "operation": "Insert"
        }
      ]
    }
  ]
}
```

--------------------------------

### Sample Add-On Module Configuration

Source: https://help.sfdmu.com/full-documentation/add-on-api/introduction-to-the-sfdmu-add-on-api-engine

This JSON structure shows how to configure an add-on module within the 'afterAddons' array in an object definition. It specifies the module name, a description, and arguments for configuration.

```json
{
  "objects": [
    {
      // ... rest of object definition        
      "afterAddons": [
        {
          "module": "ModuleName",
          "description": "Description of what the module does and how it should be used",
          "args": {
            // Arguments to configure the module, can vary based on module requirements
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Uninstall Old SFDMU Plugin Version

Source: https://help.sfdmu.com/installation

Before installing a new version, uninstall any existing SFDMU plugin. This ensures a clean installation.

```bash
# Uninstall any old versions of the plugin:
$ sf plugins uninstall sfdmu
```

--------------------------------

### Basic SELECT all Query for Product2

Source: https://help.sfdmu.com/faq/data-migration-with-plugin/using-the-all-multiselect-keyword-with-the-product2-object

This is the initial query attempted when migrating Product2 records using the 'all' keyword. It demonstrates the basic syntax but may lead to errors if certain fields are not handled correctly.

```sql
SELECT all FROM Product2
```

--------------------------------

### Compile and Build Add-on

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Commands to compile and build a standalone SFDMU add-on project.

```bash
npm install
npm run compile
npm run build
```

```bash
npm run compile
npm run build
```

--------------------------------

### DeleteSource Configuration Example

Source: https://help.sfdmu.com/full-documentation/advanced-features/delete-source

Configure the DeleteSource operation within the 'objects' array of your SFDMU export configuration. This example shows how to delete 'TestObject__c' records associated with selected Accounts.

```json
{
    "objects": [
        {
            "operation": "Readonly",
            "externalId": "Name",
            "master": true,
            "query": "SELECT Id FROM Account WHERE Name LIKE 'Test%'"
        },
        {
            "operation": "DeleteSource",
            "master": false,
            "query": "SELECT Id, Account__c FROM TestObject__c"
        }
    ]

}
```

--------------------------------

### Add-On Manifest Entry with Module and Path Locators

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Demonstrates an add-on manifest entry where both 'module' and 'path' are provided, illustrating that 'module' takes precedence.

```json
{
  "addons": [
    {
      "event": "onBefore",
      "module": "./custom-addon-sdk/custom-modules/demo/dist/index.js",
      "path": "./legacy/path/that-will-be-ignored.js"
    }
  ]
}
```

--------------------------------

### Navigate to Project Directory

Source: https://help.sfdmu.com/sfdmu-gui-app

Change the current directory to the cloned SFDX Data Move Utility Desktop App project folder.

```bash
cd SFDX-Data-Move-Utility-Desktop-App

```

--------------------------------

### Example export.json Configuration with Orgs Section

Source: https://help.sfdmu.com/full-documentation/export-json-file-objects-specification/script-org-object

This configuration demonstrates how to define connection details for multiple Salesforce organizations within the 'orgs' array in the export.json file. SFDMU uses this section to connect to specified orgs when they are not available via Salesforce CLI.

```json
{
  "orgs": [
    {
      "name": "source@example.com",
      "instanceUrl": "https://my.source.instance.salesforce.com",
      "accessToken": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    },
    {
      "name": "target@example.com",
      "instanceUrl": "https://my.target.instance.salesforce.com",
      "accessToken": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }
  ],
  "objects": [
    // Object definitions go here...
  ]
}
```

--------------------------------

### SFDMU Account CSV Data

Source: https://help.sfdmu.com/faq/sfdmu-configuration-and-pre-validation/how-to-prevent-resetting-checkboxes-using-sfdmu-with-multiselect-keyword

Example CSV file containing Account data for SFDMU operations.

```csv
Id,AccountNumber,Name
0018d00000N237jAAB,1234567890,ACC_10000

```

--------------------------------

### SOQL Query with Polymorphic Field

Source: https://help.sfdmu.com/faq/object-and-field-handling-in-soql-queries/is-it-necessary-to-always-specify-the-parent-object-for-a-polymorphic-field

Example of querying a polymorphic field by explicitly specifying the parent object type.

```soql
SELECT Id, ParentId$Case FROM FeedItem WHERE Parent.Type = 'Case'
```

```soql
SELECT Id, ParentId$Case, Name, Body FROM Attachment WHERE Parent.Type = 'Case'
```

--------------------------------

### Message Bundle Usage

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

Demonstrates how to use defined message keys for logging formatted information within a custom add-on.

```javascript
this.runtime.logFormattedInfo(this, 'hello_world');
this.runtime.logFormattedInfo(this, 'records_count', String(42));
```

--------------------------------

### Recommended Add-on Project Structure

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

A standard project layout for SFDMU custom add-ons, including entry points and build output directories.

```plaintext
my-addon/
|- index.ts
|- package.json
|- tsconfig.json
|- resources/
   |- messages.md
|- dist/
   |- index.js
```

--------------------------------

### Enable Hierarchical Deletion

Source: https://help.sfdmu.com/full-documentation/export-json-file-objects-specification/script-object-object

Activate deleteByHierarchy to remove records and their related hierarchy. This example configures it for an Account object deletion.

```json
{
  "objects": [
    {
      "query": "SELECT Id FROM Account",
      "operation": "Delete", // Default target is the destination
      "deleteByHierarchy": true // Enables hierarchical delete behavior
      // Additional ScriptObject properties                
    }    
  ]
  // ... other export.json properties    
}
```

--------------------------------

### Local File Deployment Configuration

Source: https://help.sfdmu.com/full-documentation/add-on-api/custom-sfdmu-add-on-object-reference

References a compiled add-on JavaScript file using a local file path for deployment.

```json
{
  "addons": [
    {
      "event": "onBefore",
      "module": "C:/addons/my-addon/dist/index.js"
    }
  ]
}
```

--------------------------------

### Configure beforeUpdateAddons for Update Operations

Source: https://help.sfdmu.com/full-documentation/export-json-file-objects-specification/script-object-object

Specify beforeUpdateAddons to invoke add-ons before each update operation. This example configures a DataValidationModule for specific fields.

```json
{
  "objects": [
    {
      "query": "SELECT all FROM Account",
      "operation": "Update",
      "externalId": "AccountId",
      "beforeUpdateAddons": [
        {
          "module": "DataValidationModule",
          "args": {
            "validateFields": ["Email", "Phone"],
            "errorHandling": "log"
          }
        }
      ]
      // Additional ScriptObject properties        
    }   
  ] 
  // ... other export.json properties    
}
```

--------------------------------

### Clone SFDMU Source Code

Source: https://help.sfdmu.com/installation

Clone the SFDMU plugin's source code repository from GitHub. This is necessary for installing and debugging from source.

```bash
# Clone the latest source code:
$ git clone https://github.com/forcedotcom/SFDX-Data-Move-Utility
```

--------------------------------

### Combined Configuration with Main 'objects' Set and Object Sets

Source: https://help.sfdmu.com/full-documentation/advanced-features/multiple-object-sets

This configuration demonstrates using both the main 'objects' set and 'objectSets' in the same configuration. Operations in the main 'objects' set run before those in 'objectSets'.

```json
{
  "objects": [
    {
      "query": "SELECT Id FROM Account",
      "operation": "DeleteHierarchy"
    },
    {
      "query": "SELECT Id FROM Opportunity",
      "operation": "DeleteHierarchy"
    }
  ],
  "objectSets": [
    {
      "objects": [
        {
          "query": "SELECT Name FROM Account LIMIT 1",
          "operation": "Insert"
        }
      ]
    }
  ]
}
```

--------------------------------

### OnBefore Event Definition

Source: https://help.sfdmu.com/full-documentation/add-on-api/supported-events

Defines the structure for the 'beforeAddons' event, which triggers once per job before the migration starts. No records are accessible for modification at this stage.

```json
"beforeAddons": [
   {
      ...
   }
]
```

--------------------------------

### Migrate FeedItems and FeedComments

Source: https://help.sfdmu.com/examples/advanced-examples

This example shows how to insert FeedItems and FeedComments. It includes a readonly operation to fetch Account IDs first and notes that certain FeedItem types and binary data are not transferred.

```json
{
  "objects": [
    {
        "operation": "Readonly",
        "query": "SELECT Id FROM Account WHERE Name = 'ACC_10000'",
        "externalId": "Name"			
    },
    {
      "query": "SELECT CommentCount, IsRichText, LikeCount, ParentId$Account, Revision, Status, Title, Type, Body, LinkUrl FROM FeedItem WHERE Type IN ('TextPost', 'LinkPost') AND (Parent.Type = 'Account')",
      "operation": "Insert"
    },
    {
      "query": "SELECT CommentType, FeedItemId, IsRichText, Revision, Status, ThreadChildrenCount, ThreadLastUpdatedDate, ThreadLevel, CommentBody FROM FeedComment ",
      "operation": "Insert",
      "master": "false"
    }
  ]
}

```

--------------------------------

### Diagnostic Skipped Records Summary

Source: https://help.sfdmu.com/full-documentation/reports/the-execution-log

Example of a diagnostic log entry detailing the summary of skipped target records during an update/upsert operation, categorized by reason.

```text
[diagnostic] update skipped summary: object=Account total=5 sameData=2 noMatchingTarget=1 other=2

```
Tokens:
Raw