VOOZH about

URL: https://www.cdata.com/kb/tech/dynamicscrm-ado-setup.rst

⇱ Getting Started with the CData ADO.NET Provider for Dynamics CRM

Getting Started with the CData ADO.NET Provider for Dynamics CRM

Complete guide to installing, licensing, and connecting with the CData ADO.NET Provider for Dynamics CRM.

This guide explains everything you need to work with the CData ADO.NET Provider for Dynamics CRM. You will learn how to install the provider, set up a connection to your Dynamics CRM data, and run simple commands in your .NET applications using familiar ADO.NET patterns.

Whether you are building desktop apps, web apps, or background services, the provider enables secure, high-performance connectivity to live Dynamics CRM data without needing to manage API details manually.

About Dynamics CRM Data Integration

CData simplifies access and integration of live Microsoft Dynamics CRM data. Our customers leverage CData connectivity to:

  • Read and write data in the Dynamics CRM 2011+ Services and Dynamics CRM Online.
  • Extend the native features of Dynamics CRM with customizable caching and intelligent query aggregation and separation.
  • Authenticate securely with Dynamics CRM in a variety of ways, including Azure Active Directory, Azure Managed Service Identity credentials, and Azure Service Principal using either a client secret or a certificate.

CData customers use our Dynamics CRM connectivity solutions for a variety of reasons, whether they're looking to replicate their data into a data warehouse (alongside other data sources) or analyze live Dynamics CRMa data from their preferred data tools inside the Microsoft ecosystem (Power BI, Excel, etc.) or with external tools (Tableau, Looker, etc.).


Getting Started


Installation and Licensing

System Requirements

  • Windows: Windows 10/11 or Windows Server 2016+
  • .NET Versions: .NET Framework 4.0+, .NET 6+, .NET Standard assemblies
  • IDE: Visual Studio 2017 or later

Installing the ADO.NET Provider

Windows Installation

  1. Download the ADO.NET provider installer from your CData account or the evaluation page.
  2. Run the installer and follow the installation wizard to completion.
  3. The installer registers the provider and places all assemblies in the appropriate CData installation folders.
  4. You will be prompted for your license key during installation:
    XXXX-XXXX-XXXX-XXXX-XXXX
    • Note: If you are using a trial, select Trial Key instead.

Activating your License

Licensing behavior varies depending on whether you are developing with the .NET Framework or .NET Standard. Use the steps below to activate the provider in your environment.

.NET Framework (Windows)

On Windows using the .NET Framework, no extra action is required. The installer or NuGet package automatically installs your development license.

.NET Standard (Windows/Mac/Linux)

For .NET Standard platforms like .NET Core, Mono, or Xamarin, you must install a license manually before using the provider.

Using the Install-License Tool

The toolkit includes an install-license utility in the 

lib/netstandard2.0
folder for applying trial or full licenses.

To install a trial license:

dotnet ./install-license.dll

To activate a full product license:

dotnet ./install-license.dll

After running the tool, your development machine is licensed and ready to use the provider in .NET applications.

Runtime Licensing

When deploying applications, specify the Runtime Key (RTK) in your connection string to enable redistribution.

Property Description
RTK Your Runtime Key used for deployed ADO.NET applications.

Common Licensing Questions

Can I use my license on multiple machines?
Yes, depending on your subscription tier. If unsure, review your order confirmation or contact [email protected].

I lost my license key. How do I retrieve it?
Email [email protected] with your order number.

Can I transfer my license to another machine?
Submit a License Transfer Request:
https://www.cdata.com/lic/transfer/

Once approved, an activation is added to your product key and the previous installation becomes invalid.

For more licensing support, visit portal.cdata.com or email [email protected].

Connection Configuration

Once installed, the next step is to configure a connection to Dynamics CRM. Connections are created using ADO.NET connection strings in your .NET application's code or configuration file.

Creating a connection manager

Configuring Connection Properties

The connection string options meet the authentication and connection requirements of different Dynamics CRM instances. To connect to your instance, set the User and Password properties, under the Authentication section, to valid Dynamics CRM user credentials and set the Url to a valid Dynamics CRM server organization root. Additionally, set the CRMVersion property to 'CRM2011+' or 'CRMOnline'. IFD configurations are supported as well; set InternetFacingDeployment to true.

Additionally, you can provide the security token service (STS) or AD FS endpoint in the STSURL property. This value can be retrieved with the GetSTSUrl stored procedure. Office 365 users can connect to the default STS URL by simply setting CRMVersion.

👁 Add Connection

Test your connection

Common Connection Issues

Authentication Failed

Solution: Verify OAuth settings, client IDs, secrets, or token permissions for your Dynamics CRM. Contact [email protected] for assistance.

Cannot Reach Server

Solution: Check firewall, proxy, and VPN configurations. Contact [email protected] for required port information.

Table Not Found

Solution: Confirm you selected the correct schema or database when querying Dynamics CRM.

What's Next

Now that you have installed, licensed, and configured the ADO.NET provider, here are scenarios you can use to explore our ADO.NET tools:

Get Support

If you need assistance at any point:

FAQs

Installation and Licensing

  • Do I need administrator rights to install the ADO.NET Provider?
    Yes, administrator rights are required to install components for use across Visual Studio.
  • Do I need an RTK to deploy to Azure Data Factory?
    Yes. Set the RTK property in your application's connection string before publishing.

Connecting

  • Can I use multiple Dynamics CRM accounts?
    Create separate Connection =strings for each account.
  • Can I connect through a proxy?
    Yes. Configure proxy settings in the Connection string.
  • How do I test my connection?
    Click Test Connection in the Connection Manager UI.

Performance & Troubleshooting

  • How can I improve query performance
    Apply filters, limit row counts, and leverage server-side paging properties.
  • How do I enable logging?
    Add the following to your connection manager:
    • Logfile: /path/to/logfile.log
    • Verbosity: 3

    Be prepared to securely upload the log file upon request when reaching out to [email protected] for troubleshooting analysis.

    For questions not covered in this FAQ, contact [email protected].

Ready to get started?

Download a free trial of the Dynamics CRM Data Provider to get started:

 Download Now

Learn more:

👁 Dynamics CRM Icon
Dynamics CRM ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Microsoft Dynamics CRM account data including Leads, Contacts, Opportunities, Accounts, and more!