Build Windows client applications using the XRM tools

Note

Effective November 2020:

  • Common Data Service has been renamed to Microsoft Dataverse. Learn more
  • Some terminology in Microsoft Dataverse has been updated. For example, entity is now table and field is now column. Learn more

This article will be updated soon to reflect the latest terminology.

XRM tooling is a set of APIs built on top of the Microsoft Dataverse assembly APIs (Organization service and Discovery service) that provide support for building Windows client applications for Dataverse. It provides the following capabilities:

  • Supports all the authentication modes to sign in to Dataverse instance.
  • Provides PowerShell support for authentication and connection to Dataverse instance.
  • Provides thread safety for actions performed in Dataverse in a multithreaded environment. More information Multithreading in Components, Thread-Safe Components
  • Provides a common Windows Presentation Foundation login control for Dataverse for consistent sign-in experience to Dataverse from your Windows client applications.
  • Supports secure storage of the sign-in credentials and reuse of the stored credentials to automatically sign in to Dataverse after initial sign in.
  • Provides built-in diagnostic tracing and performance reporting of the actions performed in Dataverse, which you can configure based on your organization’s requirements.

Components of XRM tooling

XRM tooling has the following three components:

  • Interface for developers: This provides the low-level interaction and wrapper methods for the Dataverse SDK assembly APIs. It is an instrumented API that provides a thread safe environment for making calls to Dataverse with built-in diagnostic capabilities to help you determine the performance of individual calls. It also provides a standard set of trace listeners for debugging support. The namespace for this component is Microsoft.Xrm.Tooling.Connector.

  • Common login control: This is a WPF user control that provides a common user interface for the sign in experience to Dataverse. The login control provides support for all the authentication modes that are supported by Dataverse. The common login control has built-in encryption for securely storing your credentials/profile, and then reusing it at runtime to automatically sign in to Dataverse. The namespace for this component is Microsoft.Xrm.Tooling.CrmConnectControl.

  • Web resource utility: This provides support for accessing information from the following two types of web resources in Dataverse: Image and XML. You can access an image from a Dataverse web resource and return it as WPF BitmapImage objects. Similarly, you can return an XML web resource as a string. The namespace for this component is Microsoft.Xrm.Tooling.WebResourceUtility.

Client applications that use XRM tooling

The following applications in the current version of Dataverse use the common WPF login control for authenticating users while signing in to Dataverse from the client application:

See also

Sample: Quick start for XRM Tooling API

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).