Getting started with Devart ODBC Driver for NetSuite

Quick start: Connect to NetSuite with ODBC

To connect to NetSuite using the Devart ODBC Driver:

1. Download and install the Driver for Windows.
2. Activate the Driver using your activation key, or continue with the 30-day trial.
3. Create an ODBC data source (DSN) and select Devart ODBC Driver for NetSuite.
4. Configure the connection with your preferred authentication type (Basic, Token-Based, or OAuth).
5. Use the DSN in your ODBC-compatible application to connect to NetSuite and work with its data.

The following sections provide detailed installation and configuration instructions.

Prerequisites

Before you begin, make sure your environment meets the following requirements:

• Operating system: 32-bit or 64-bit Windows (including Windows Terminal Server). The Driver is compatible with all Windows versions (Windows Vista and later) that support .NET Framework 4.5.
• ODBC driver manager: Included with Windows.
• Connection details: An active NetSuite account with Account ID and application ID; enabled NetSuite authentication with configured roles, integration records, and access tokens if applicable.
• Activation key: A purchased version of the Driver requires an activation key. For evaluation purposes, you can use the trial version, which is valid for 30 days from installation.
• Administrator rights: Required to install the Driver.

For a complete list of supported platforms and third-party tools, see the ODBC Driver for NetSuite compatibility page.

Install the ODBC Driver

Installing the Devart ODBC Driver for NetSuite is straightforward. All you need to do is download the package for your operating system (Windows) and follow the installation instructions.

1. Download the ODBC Driver for NetSuite from the Devart website, open it, and click Next.

2. Read the License Agreement, select I accept the agreement, and click Next.

3. On the Select Destination Location page, keep the default folder or click Browse to choose another one, and click Next.

4. On the Select Components page, select the components to install, then click Next.

5. On the Select Start Menu Folder page, specify the folder for the Driver shortcuts. To skip creating a Start Menu folder, select Don't create a Start Menu folder. Click Next, then click Install.

6. On the License Information page, select Input activation key and enter your key. You can find it in the registration email or your Customer Portal. To open the Customer Portal, click Get Activation Key.

If the activation key is saved on your computer, click Load Activation Key and select the corresponding file.

To evaluate the Driver without a purchased key, select Trial evaluation.

7. Click Next, then click Finish to complete the installation.

Configure an ODBC data source

In this guide, you create a Data Source Name (DSN) for the ODBC connection and verify the connection details. A DSN stores connection settings, such as your credentials that applications use to connect to NetSuite. Applications can also connect without a DSN by passing the same parameters in a connection string.

To configure an ODBC data source, follow the steps outlined below.

1. In Windows Search, enter ODBC Data Sources and open the ODBC Data Source Administrator that matches the bitness of your application.

2. Go to the User DSN, System DSN, or File DSN tab, and click Add:

• User DSN — Available only to the user who creates it.
• System DSN — Available to all users on the computer.
• File DSN — Stores connection settings in a file that can be shared between computers where the required ODBC Driver is installed.

3. In the Create New Data Source dialog, select Devart ODBC Driver for NetSuite, and click Finish.

4. In the Devart ODBC Driver for NetSuite Configuration dialog, enter a Data Source Name and an optional Description.

5. To authenticate, you can use one of the three available authentication options: Basic, Token-Based Authentication, or OAuth.

If you are authenticating via Basic Authentication:

To authenticate, you need the following credentials:

• Account ID
• User ID
• Password
• Application ID
• Role ID

Sign in to your NetSuite account and retrieve these credentials: follow the step-by-step guidelines to do this.

In the Devart ODBC Driver for NetSuite Configuration window, select Basic in the Authentication field and enter the required details. Optionally, select Save Password to store it.

If you are authenticating via Token-Based Authentication (TBA):

You can connect the ODBC Driver for NetSuite by providing your Account ID, Consumer Key, Consumer Secret, Token, and Token Secret. This authentication method ensures secure access without requiring user credentials.

Sign in to your NetSuite account and obtain these credentials: you will need to generate the access values. Follow the step-by-step guidelines to do this.

In the Devart ODBC Driver for NetSuite Configuration window, select Token-Based in the Authentication field and enter the required details into the respective fields. Optionally, select Save Secret to store it.

If you are authenticating via OAuth:

You need to provide your Account ID, Client ID (it is the same as your Consumer Key), Client Secret (the same as Consumer Secret), and Refresh Token.

Sign in to the NetSuite account and obtain these details: follow the step-by-step guidelines to enable the OAuth Authentication and generate the required values.

In the Devart ODBC Driver for NetSuite Configuration window, select OAuth in the Authentication field and enter the required details into the respective fields. Click Sign in to NetSuite to complete the authentication.

The Refresh Token field will be filled automatically. Select Save Token to store it.

6. Optional: Click Test Connection to verify the connection settings.

7. Click OK to save the DSN settings.

To fine-tune metadata, timeout, and compatibility behavior, use the Advanced Settings tab of the same dialog.

Connect to NetSuite using a connection string

In addition to using a DSN, you can connect to NetSuite by specifying the connection parameters directly in an ODBC connection string. This type of connection is known as a DSN-less connection.

The following table summarizes when to use each connection method.

Have a look at the NetSuite ODBC connection string sample below.

DRIVER={Devart ODBC Driver for NetSuite};User [email protected];Password=da85au;Account ID=DTDSVR1809345;Application ID=4B7E39KC-S276-5647-5D88-678GP7972957

For Token-Based authentication (the default authentication type), use the connection string configuration as shown below.

DRIVER={Devart ODBC Driver for NetSuite};Authentication Type=TokenBased;User ID=my_user_id;Account ID=my_account_id;Role ID=my_role_id;Application ID=my_application_id;Consumer Key=my_consumer_id;Consumer Secret=my_consumer_secret;Token Id=my_token_id;Token Secret=my_token_secret

Replace the placeholder values with your actual credentials, depending on the chosen authentication type.

For the complete list of supported options, see the NetSuite ODBC connection string parameters.

Troubleshooting

If you cannot connect to NetSuite through the Devart ODBC Driver, refer to the following list of common connection issues and their solutions to troubleshoot and fix the problem.

You get a "Product is not activated or has been deactivated" error

This error occurs when the Driver has not been activated or its activation is no longer valid. Activation is required for both purchased and trial versions.

Open the DSN configuration dialog, go to the License tab, click Input Activation Key, and enter your activation key. After activation, test the connection again.

The ODBC data source is not found or the Driver is not available

If your application cannot find the DSN or the Devart ODBC Driver for NetSuite, check the application and Driver bitness.

A 32-bit application cannot use a DSN created in the 64-bit ODBC Data Source Administrator, and a 64-bit application cannot use a DSN created in the 32-bit administrator.

Make sure that:

• The DSN is created in the ODBC administrator that matches your application's bitness.
• The corresponding 32-bit or 64-bit version of the Driver is installed.
• The application is configured to use the correct DSN.

Connection fails

If NetSuite is reachable but authentication fails, check the authentication option. The Driver supports three authentication types: Basic, Token-Based, and OAuth; ensure that the required credentials for the selected method are provided.

If you had to re-generate your Consumer Key, Consumer Secret, and tokens, the previous values were deactivated, so you need to re-generate and re-enter all these values for the respective authentication type.

NetSuite connection times out

If the service is available but the connection takes too long to establish, increase Connection Timeout on the Advanced Settings tab. Also, check the network connection.

Additional resources

After you install and configure Devart ODBC Driver for NetSuite, use the following resources to continue setting up and working with your connections:

• Connection string parameters — Browse the complete list of connection options for configuring access, timeouts, ODBC behavior, and other Driver settings.
• Supported ODBC API functions — Explore the currently supported ODBC functions.
• Using in third-party tools — Find step-by-step guides for connecting BI, reporting, analytics, and other ODBC-compatible tools to NetSuite.
• Documentation — Explore installation, configuration, connectivity, and Driver features.