Add-On API Overview.


The SFDMU Add-On Engine is a great feature allowing you to apply any new customized functionality to the SFDMU by implementing your own Custom Add-On modules or by using modules provided by third parties.

See also the Add-On Api Object Reference

Table of Contents



Why do you need the Add-On Api ?

Sometimes, your are not fully satisfied with the OOTB functionality that the SFDMU offers you, for example:

  • You want to trigger custom action on the target records, after the Plugin has completed his data migration process.
  • or you want to send an email message contains report about the failed tasks.
  • or you want to run Apex job or Process Builder / Flow from the Plugin.
  • or you want something else...

With the SFDMU Add-On you have a great option to fill all these gaps and extend the SFDMU Plugin Core with unlimited extra features according to your needs.

Two types of Add-On modules.

  • The 'Core SFDMU Add-On module' is a module which is provided by us.

    • It is built using the standard Core SFDMU Add-On Api.
    • Each Core Module extends the SFDMU with one or more features, which is not included in the original Plugin implementation.
    • We will release new Core Modules from time to time.
  • The 'Custom SFDMU Add-On module' is a module which has written by your own.

    • It is based on the Custom SFDMU Add-On Api.
    • You are free to create and manage your modules on your behalf.
    • The custom modules are loaded by the SFDMU directly from the local file system and executed during the data migration process.

The Custom Add-On Api is inherited from the Core Add-On Api, but it not the exactly same thing, because the Custom Api is the limited version of the Core Add-On Api and exposes only the most important features, which can be usable and helpful for the End User.

How to create and run you own Custom Add-On module ?

All you need is to write a very simple Typescript module by implementing the set of special TS interfaces, which is included in the distributed API package (or just to use an already existing module), then to configure your export.json to call your module at the runtime.

See the quick tutorial here: Creating and running Custom Add-On module

List of the currently available Core SFDMU Add-On modules:

Last updated on 29th Jan 2023