Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISfdmuRunCustomAddonModule

The base interface to be implemented in every custom Sfdmu Add-On module.

export
interface

ISfdmuRunCustomAddonModule

Hierarchy

  • ISfdmuRunCustomAddonModule

Index

Properties

Methods

Properties

runtime

The instance of the Custom Add-On module runtime.
Uses the public property ISfdmuRunCustomAddonRuntime.service to share the Custom Add-On module Api with the current module instance.

memberof

ISfdmuRunCustomAddonModule

Methods

onExecute

  • The entry point which is executed by the Plugin when the Add-On event is triggered.

    memberof

    ISfdmuRunCustomAddonModule

    Parameters

    • context: ISfdmuRunCustomAddonContext

      The current Add-On runtime context.

    • args: any

      The JS object passed into the function from the arg property defined in the object/[addons] section of the Script.

      For example, the portion of the json as below:

      "args" : {
      "TEST__c": "Another test, assigning this text to the field TEST__c of each record being processed"
      }

      Will pass to the method the following args:

      args = { 
      TEST__c : "Another test, assigning this text to the field TEST__c of each record being processed"
      }

    Returns Promise<ISfdmuRunCustomAddonResult>

Optional onInit

  • If implemented, this method wil run for each Add-On module (both of core and custom types) immediatelly AFTER the export.json file is parsed but BEFORE the migration job is actually started. Allows to modify the script and to make other necessary prerequisites to get the migration job ready.

    memberof

    ISfdmuRunCustomAddonModule

    Parameters

    • context: ISfdmuRunCustomAddonContext

      The current Add-On runtime context.

    • args: any

      The JS object passed into the function from the arg property defined in the object/[addons] section of the Script.

    Returns Promise<ISfdmuRunCustomAddonResult>

Generated using TypeDoc  |  SFDMU Help Center  |  View on Github