Introduction to the SFDMU Add-On API Engine.


Enjoy the newest SFDMU Add-On API !

We have create the new great feature, which allows you to apply any new customized functionality to the SFDMU by implementing your own Custom Add-On modules.

*THE CUSTOM ADD-ON API HAS ALREADY LAUNCHED, SO YOU CAN START TO USE IT IN YOUR PROJECTS. *

SEE THE REFERENCE GUIDE HOW TO USE


Why you need it ?

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.
  • And much more...

Now you got an amazing option to fill all these gaps thanks to the new SFDMU Add-On API Framework, which allows you to extend the SFDMU Plugin 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 Plugin 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, based on the Custom SFDMU Add-On Api. You can freely create and manage your modules on your behalf. The custom modules are loaded directly from the local file system and executed by the Plugin during the data migration process.

Although the Custom Add-On Api is inherited from the Core Add-On Api, but it not the same thing.

The Custom Api is the short version of the Core Api and exposes only the most important features, which can be usable and helpful for the End Users.

How to create a new 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.

How to run ?

You are declaring the list of the custom Add-On modules that you want to include in the process inside the special section of the export.json, the SFDMU Plugin is loading your modules right after the migration job is started, then it is executing them by triggering the set of Add-On Events (like onBefore, onAfter, onBeforeUpdate).

List of the currently available Core SFDMU Extensions :

  • The ExportFile Core Add-On Module will give you easiest ability to transfer Salesforce Files (ContentVersion, ContentDocument, ContentDocumentLink), attached to the records.

See also:

The Custom Add-On Api reference guide

ExportFile Core Add-On Module

Full export.json format

Last updated on Sa Oct 2022