Dynamics 365: explain the execution depth of plug-ins (pluginexecutioncontext.depth)

Depth This property will tell you how deep the plug-in is in a call stack , Is the number of times it is called .

Let's use a piece of code directly to Depth Value ：

1. First of all, let's write a Account Entity plug-ins and use RetrieveMultiple event , When we click in each time Accont This will be called whenever a view of RetrieveMultiple event , But there is only one note in it log nothing more ：

using Microsoft.Xrm.Sdk;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace PluginDepthTest
{
    public class RetrieveMutiple : IPlugin
    {
        public void Execute(IServiceProvider serviceProvider)
        {
            IPluginExecutionContext context = (IPluginExecutionContext)serviceProvider.GetService(typeof(IPluginExecutionContext));
            IOrganizationServiceFactory serviceFactory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));
            IOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);
            ITracingService tracingService = (ITracingService)serviceProvider.GetService(typeof(ITracingService));

            if (context.Depth == 1)
            {
                tracingService.Trace($"The plugin depth is: {context.Depth}");
            }
            else if (context.Depth > 1)
            {
                tracingService.Trace($"The plugin depth is: {context.Depth}");
            }

        }
    }
}

2. Every time we click in Accont This event will be triggered when a view of , We go through Plug-in Trace Log It can be seen that , It only executes once in this transaction , because Depth by 1.

3. We modify the code as follows , Judge Depth Value , Be equal to 1 When , We call again in the code RetrieveMultiple, At this time, the plug-in will be executed again , And its Depth The value of also becomes 2.

using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace PluginDepthTest
{
    public class RetrieveMutiple : IPlugin
    {
        public void Execute(IServiceProvider serviceProvider)
        {
            IPluginExecutionContext context = (IPluginExecutionContext)serviceProvider.GetService(typeof(IPluginExecutionContext));
            IOrganizationServiceFactory serviceFactory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));
            IOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);
            ITracingService tracingService = (ITracingService)serviceProvider.GetService(typeof(ITracingService));

            if (context.Depth == 1)
            {
                QueryExpression query = new QueryExpression("account");
                query.ColumnSet.AddColumns("name");
                EntityCollection result = service.RetrieveMultiple(query);

                tracingService.Trace($"The plugin depth is: {context.Depth}");
            }
            else if (context.Depth > 1)
            {
                tracingService.Trace($"The plugin depth is: {context.Depth}");
            }

        }
    }
}

4. So let's run this Account Attempts by entities , This time through Plug-in Trace Log It can be seen that , This time it came in twice , for the first time Depth by 1, The second time Depth by 2.

  for the first time ：

The second time ：

Notes:

• Depth The most important function is to prevent the plug-in from falling into an infinite loop , Most of the time , We can ignore this value
• Depth The default maximum value for is 8, The time limit is one hour . That is to say if Depth Property increases to its maximum value within the one hour time limit （8）, Then the system will think that the transaction has fallen into an infinite loop , Plug-in or Workflow The execution of will be forcibly suspended , And will report the following errors ：

Message: This workflow job was canceled because the workflow that started it included an infinite loop. Correct the workflow logic and try again. For information about workflow logic, see Help.Detail:

• We can use the following Powershell Script to Depth Modify the default value of

$setting = Get-CrmSetting -SettingType WorkflowSettings
$setting.MaxDepth = 10
Set-CrmSetting -Setting $setting

  Reference documents ：

IExecutionContext.Depth Property (Microsoft.Xrm.Sdk) | Microsoft Docshttps://docs.microsoft.com/zh-cn/dotnet/api/microsoft.xrm.sdk.iexecutioncontext.depth?f1url=%3FappId%3DDev16IDEF1&l=EN-US&k=k(Microsoft.Xrm.Sdk.IExecutionContext.Depth)%3Bk(SolutionItemsProject)%3Bk(TargetFrameworkMoniker-.NETFramework%2CVersion%3Dv4.6.2)%3Bk(DevLang-csharp)&rd=true&view=dataverse-sdk-latestGet-CrmSetting (Microsoft.Crm.PowerShell) | Microsoft Docshttps://docs.microsoft.com/en-us/powershell/module/microsoft.crm.powershell/get-crmsetting?view=dynamics365ce-psWorkflowSettings.MaxDepth Property (Microsoft.Xrm.Sdk.Deployment) | Microsoft Docshttps://docs.microsoft.com/en-us/dotnet/api/microsoft.xrm.sdk.deployment.workflowsettings.maxdepth?view=dataverse-sdk-latest