Connection String Parameters - ODBC Driver for NetSuite

Account ID

Use the parameter, along with your User ID and Password, to authenticate yourself to NetSuite. Refer to the Obtaining Account ID and Application ID section for information about getting an Account ID.

Account Time Zone

Use the parameter to specify the timezone for your account.

Application ID

Use the parameter to specify your User ID, Password and Application ID. To obtain a NetSuite Application ID, refer to the Obtaining Account ID and Application ID section.

Authentication Type

Use the option to specify the autentication type: token-based (TokenBased) or regular authentication (Basic). The default value is TokenBased.

Password

Use the parameter to specify your password.

Role Id

Use the parameter to specify your RoleId, which is the InternalId of a role that is used to log in to NetSuite. If no RoleId is specified, the user's default role will be used. A RoleId may be obtained on the Setup -> Integration -> Web Services Preferences page in your NetSuite account.

Sandbox

Enable the option to connect to NetSuite sandbox.

Token Id

Use the option to specify your Token ID.

Token Secret

Use the option to specify your Token Secret.

User ID

Use the parameter to specify your User ID.

Proxy Settings

Proxy Server

The proxy hostname or IP address.

Proxy Port

The proxy port.

Proxy User

The proxy username.

Proxy Password

The proxy password.

Advanced Settings

Allow NULL strings

To retrieve metadata, not all parameters according to MSDN can accept a null value. If NULL, the driver should return an error. But some 3rd-party tools pass NULL to the parameters. These options should be enabled for compatibility with such tools.

Empty strings as NULL

Cache Metadata

This is a configurable parameter, which allows caching and storing metadata in a temporary database. The parameter settings specify the frequency of resetting cached metadata ranging from 1 hour...to 1 month.

• False - The metadata caching is disabled.
• Hour - Cached metadata is reset one time per hour.
• Day - Cached metadata is reset once a day (i.e. every 24 hours).
• Month - Cached metadata is reset once per month.
• True - Metadata caching won't reset until the driver is unloaded.

Connection Timeout

The time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 60.

ODBC Behavior

Used to set the behavior corresponding to the ODBC specification version that a third-party tool expects. The behavior of ODBC driver can be changed by setting a value for the SQL_ATTR_ODBC_VERSION attribute by calling the SQLSetEnvAttr function. But some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the specified version or pass an incorrect value there. In this case, the required behavior can be explicitly specified in the Connection String by setting the ODBC Behavior parameter. The possible values are:

• Default - default ODBC behavior determined by a third-party tool.
• Ver 2.x - ODBC 2.x behavior is explicitly set.
• Ver 3.x - ODBC 3.x behavior is explicitly set.

Local SQL Engine

Upon disabling the parameter, the SQL queries will be sent and processed in NetSuite as is. Disabling the parameter will improve performance when executing queries with LIMIT from tables with vast amounts of entries. However, disabling the parameter will limit the SQL queries syntax; thus, some queries might be not executed.

RegionalNumberSettings

Enables the use of local regional settings when converting numbers to strings.

RegionalDateTimeSettings

Enables the use of local regional settings when converting dates and times to strings.

ReturnForeignKeys

Use the option to specify whether the driver must return foreign keys. Retrieving metadata about foreign key constraints is a time-consuming operation; many third-party tools request foreign key metadata even whey they do not actually need this information. Note that enabling the option may degrade performance of data access operations. The default value is False.

String Types

Sets the string value types returned by the driver as Default, Ansi or Unicode.

• Default - the driver defines the string types.
• Ansi - all string types will be returned as SQL_CHAR, SQL_VARCHAR and SQL_LONGVARCHAR.
• Unicode - all string types will be returned as SQL_WCHAR, SQL_WVARCHAR and SQL_WLONGVARCHAR.

The parameter value should be changed if any third-party tool supports only Ansi string types or Unicode ones.

Custom Tables

Allows accessing a custom table.

Custom Fields

Allows accessing custom table fields.

QueryTimeout

The time to wait for a query execution result before terminating and generating an error.

UTC Dates

Specifies whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time and whether the date values specified on the application side (e.g., in SQL statements) are considered UTC or local. The default value is false.