Add-On API Overview.

The SFDMU Add-On Engine is a powerful feature that allows you to enhance SFDMU by implementing your own custom Add-On modules or using third-party modules.

See also the Add-On API Object Reference

Table of Contents

Why Do You Need the Add-On API?

Sometimes, you may find the out-of-the-box (OOTB) functionality of SFDMU insufficient for your needs. For example:

  • You want to trigger custom actions on the target records after the plugin has completed its data migration process.
  • You want to send an email message containing a report about the failed tasks.
  • You want to run an Apex job or a Process Builder / Flow from the plugin.
  • You have other specific requirements...

With the SFDMU Add-On, you have a great opportunity to bridge these gaps and extend the SFDMU Plugin Core with unlimited additional features according to your needs.

Two Types of Add-On Modules

  • 'Core SFDMU Add-On module':

    • Provided by us and built using the standard Core SFDMU Add-On API.
    • Each Core Module extends SFDMU with features not included in the original plugin implementation.
    • New Core Modules will be released periodically.
  • 'Custom SFDMU Add-On module':

    • Written by you, based on the Custom SFDMU Add-On API.
    • You have the freedom to create and manage your modules.
    • Custom modules are loaded directly from the local file system and executed during the data migration process.

The Custom Add-On API is derived from the Core Add-On API but is not exactly the same. The Custom API is a limited version of the Core API and exposes only the most crucial features that are useful and helpful for the end user.

How to Create and Run Your Own Custom Add-On Module

All you need is to write a simple TypeScript module by implementing the set of special TS interfaces included in the distributed API package, or use an existing module. Then, configure your export.json to call your module at runtime.

See the quick tutorial here: Creating and Running a Custom Add-On Module

List of Currently Available Core SFDMU Add-On Modules

Last updated on 20th Apr 2024