Getting Started with the CData ADO.NET Provider for NetSuite

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


This guide explains everything you need to work with the CData ADO.NET Provider for NetSuite. You will learn how to install the provider, set up a connection to your NetSuite 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 NetSuite data without needing to manage API details manually.

About NetSuite Data Integration

CData provides the easiest way to access and integrate live data from Oracle NetSuite. Customers use CData connectivity to:

  • Access all editions of NetSuite, including Standard, CRM, and OneWorld.
  • Connect with all versions of the SuiteTalk API (SOAP-based) and SuiteQL, which functions like SQL, enabling easier data querying and manipulation.
  • Access predefined and custom reports through support for Saved Searches.
  • Securely authenticate with Token-based and OAuth 2.0, ensuring compatibility and security for all use cases.
  • Use SQL stored procedures to perform functional actions like uploading or downloading files, attaching or detaching records or relationships, retrieving roles, getting extra table or column info, getting job results, and more.

Customers use CData solutions to access live NetSuite data from their preferred analytics tools, Power BI and Excel. They also use CData's solutions to integrate their NetSuite data into comprehensive databases and data warehouse using CData Sync directly or leveraging CData's compatibility with other applications like Azure Data Factory. CData also helps Oracle NetSuite customers easily write apps that can pull data from and push data to NetSuite, allowing organizations to integrate data from other sources with NetSuite.

For more information about our Oracle NetSuite solutions, read our blog: Drivers in Focus Part 2: Replicating and Consolidating ... NetSuite Accounting Data.


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 NetSuite. Connections are created using ADO.NET connection strings in your .NET application's code or configuration file.

Creating a connection manager

  • Open Visual Studio.
  • Navigate to View, select Server Explorer.
  • Click Connect to Database from the left sidebar.
  • In the Add Connection dialog, click Change.
  • Choose CData NetSuite data source, then click OK.

Configuring Connection Properties

The User and Password properties, under the Authentication section, must be set to valid NetSuite user credentials. In addition, the AccountId must be set to the ID of a company account that can be used by the specified User. The RoleId can be optionally specified to log in the user with limited permissions.

See the "Getting Started" chapter of the help documentation for more information on connecting to NetSuite.


Test your connection

  • Click Test Connection.
  • Once the connection is successful, you can explore the data inside Visual Studio.

Common Connection Issues

Authentication Failed

Solution: Verify OAuth settings, client IDs, secrets, or token permissions for your NetSuite. 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 NetSuite.


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 NetSuite 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 NetSuite Data Provider to get started:

 Download Now

Learn more:

NetSuite Icon NetSuite ADO.NET Provider

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