Disable Trigger Handlers for NPSP

Disable Trigger Handlers

Review examples of when you can disable trigger handlers.

Note If you need a refresher on the fundamentals of TDTM, read Table-Driven Trigger Management Overview.

• Temporarily disable certain Apex classes when inserting a large volume of records with data that is already structured in its final format.
• Disable Address-related Apex code when inserting or updating Contacts through a scheduled ETL job that always runs as a specific User.
• Temporarily prevent Payment or Opportunity Contact Role records from being created when Opportunities are inserted through a third-party package from the AppExchange.

It's helpful to know what each of the Apex classes do, so that you know which Trigger Handlers to disable. Visit NPSP Codebase Documentation for a description of the Apex classes managed by TDTM (designated by _TDTM extension in the name.) Note that there are some classes that are not managed by TDTM, such as utility and settings classes.

Important Be careful when changing Trigger Handler records. They're designed to work in conjunction, and changing or disabling them can lead to undesirable results. Always test in a Sandbox environment before changing Trigger Handlers in production!

Disable Trigger Handlers for All Users

You typically disable a Trigger Handler for all users if you have a custom process or custom code that replace functionality. You may also disable a Trigger Handler for all users if you have a use case that requires that the standard behavior of an Apex class not occur for all users.

To disable a Trigger Handler:

1. Click the Trigger Handler tab. If you don't see it, find it in the App Launcher .
   

   Note If you still don't see the Trigger Handler tab, make sure the Tab has been properly configured. For more information, read Prerequisites for Managing Trigger Handlers.

2. Click in the row for the Trigger Handler you want to disable, and select Edit.

3. Deselect the Active checkbox.
4. For all NPSP EDA-packaged Trigger Handlers, select the User Managed checkbox.
   

   Important You must select User Managed to prevent the Trigger Handler from being reactivated during the next package update.
   
5. Click Save.

To re-activate a Trigger Handler:

1. Select the Active checkbox.

2. Deselect User Managed.

3. Click Save.

For more information on editing Trigger Handlers, see Edit a Trigger Handler .

Disable Trigger Handlers for Specific Users

In cases where you have a custom integration with another system, or need to perform periodic imports of data where you don't need certain Trigger Handlers to run, you can disable a Trigger Handler for specific users.

For example, let's say you have an external data source that already supplies an Account for Contacts. During the integration, you wouldn't want to run the code that creates Accounts (the ACCT_IndividualAccounts_TDTM class.) To stop that code from executing when the import runs, you would exclude the integration user from the Trigger Handler record for the ACCT_IndividualAccounts_TDTM class.

Note As a best practice, dedicate a user account, called an API User, for your integrations. That way, if an actual user leaves your organization, you'll always have an active user with the correct permissions available for your integration. Read Create a Secure Salesforce API User in Salesforce Help for more information.

To disable Trigger Handlers for specific users:

1. Click the Trigger Handler tab. If you don't see it, find it in the App Launcher.
   

   Note If you still don't see the Trigger Handler tab, make sure the Tab has been properly configured. For more information, read Prerequisites for Managing Trigger Handlers.

2. Click in the row for the Trigger Handler you want to disable, and select Edit.

3. Enter one or more usernames, separating each with a semicolon, in the Usernames to Exclude field. For example, integration@user.org;tester@user.org

   

4. Click Save.

Disable Trigger Handlers with Apex

Sometimes it's necessary to temporarily disable Trigger Handlers only during the execution of Apex code. NPSP offers two ways to achieve this depending on whether you want to disable specific Trigger Handlers or all Trigger Handlers at once.

Note This section is intended for developers and advanced admins who are familiar with Apex. The bottom line is that you can temporarily disable a Trigger Handler with code instead of editing the Trigger Handler records manually. You can't use SandboxPostCopy Interface to disable trigger handlers because the code runs before Salesforce creates the trigger handlers in the sandbox. If the options for disablement discussed earlier in this article don't address your use case, know that you can manage Trigger Handlers with code, too.

// disable trigger that creates a new Household Account for Contacts
List<npsp__Trigger_Handler__c> handlers = npsp.TDTM_Config_API.getCachedRecords();
    for (npsp__Trigger_Handler__c th : handlers) {
        if (th.npsp__Object__c == 'Contact' && th.npsp__Class__c == 'ACCT_IndividualAccounts_TDTM') {
            th.npsp__Active__c = false;
        }
    }

Callable npspApi = (System.Callable)Type.forName('npsp', 'Callable_API').newInstance();
Boolean isNpspTriggerDisabled = (Boolean)npspApi.call('TDTM.DisableAllTriggers', new Map<String, Object>());