Xrm.DataManager.Framework 2026.0.2

Xrm.DataManager.Framework

Framework for massive Microsoft Dataverse data operations (batch jobs, data migrations, purges, synchronizations...).

You write the query and the processing of a single record : the framework handles paging, multi threading, retries, progress and logging.

Features

• Batching patterns : pick and process, full process (with resume), input file, SQL retrieval
• Multi instance : query an instance and process on another one, synchronize or compare tables between instances
• Performances : multi threading, connection pool, server recommended degree of parallelism displayed at startup
• Errors handling : network errors and service protection limits are retried (Retry-After delay honored)
• Tracing : file, Application Insights or any Microsoft.Extensions.Logging provider
• Configuration : connections and settings in app.config

Only depends on the Dataverse ServiceClient (Microsoft.PowerPlatform.Dataverse.Client).

Getting started

Prerequisites

• Console application targeting .NET Framework 4.8 or .NET 10
• Dataverse connection string in ServiceClient format : OAuth, ClientSecret or Certificate

Configuration

Define connections and settings in app.config :

<configuration>
  <connectionStrings>
    <add name="Dev" connectionString="AuthType=ClientSecret;Url=https://dev.crm4.dynamics.com;ClientId=...;ClientSecret=..." />
  </connectionStrings>
  <appSettings>
    <add key="Target.Connection.Name" value="Dev" />
    <add key="Process.Thread.Number" value="10" />
  </appSettings>
</configuration>

Write a job

using Microsoft.Xrm.Sdk.Query;
using System;
using Xrm.DataManager.Framework;

public class DeleteInactiveContactsJob : PickAndProcessDataJobBase
{
    public DeleteInactiveContactsJob(JobSettings jobSettings, JobProcessParameters parameters) : base(jobSettings, parameters) { }

    public override string GetName() => "Delete inactive contacts";

    // Records are retrieved page by page, as long as the query returns records
    public override QueryExpression GetQuery(Guid callerId)
    {
        var query = new QueryExpression("contact");
        query.Criteria.AddCondition("statecode", ConditionOperator.Equal, 1);
        return query;
    }

    // Called once per record, on several threads
    public override void ProcessRecord(JobExecutionContext context) => context.Proxy.Delete(context.Record.LogicalName, context.Record.Id);
}

Run it

// Default logger : FileLogger ({RunId}.log file in current directory)
using (var processor = new JobProcessor())
{
    processor.Execute<DeleteInactiveContactsJob>();
}

Or select connection and jobs from command line (YourApp.exe Dev DeleteInactiveContactsJob,OtherJob) or Target.Job.Names setting :

using (var processor = new Processor())
{
    processor.Execute(args);
}

Patterns

Overridable methods : PreOperation (before processing, ex : disable audit), PrepareData (ex : groupings), PostOperation (after processing, ex : notification), IsEnabled, OverrideThreadNumber...

Main settings

See the complete settings list.

Additional packages

Documentation

• Complete documentation : logging, SQL retrieval, multi instance processing, synchronization, comparison
• Upgrade guide from 2022.x versions (ServiceClient, connections, renamed settings)

Feedback

Questions, bugs and suggestions : GitHub issues. Community contributions are welcome !