BizTalk Adapter for NetSuite

Build 20.0.7606

Connection Properties

Connection String Options  

The connection string properties describe the various options that can be used to establish a connection.

Adapter

CData.BizTalk.NetSuiteAdapter.dll

Remarks

The connection string can be set to a series of "option=value" pairs separated by semicolons. If a connection string property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.

Connection options are case insensitive.

To specify where the table, view, and stored procedures of the database are located, set the Location property. In addition, you must also set User, Password, and AccountId. Caching Data can be enabled by using the appropriate options.

Connection String Options


The following is the full list of the options you can configure in the connection string for this provider. Click on the links for further details.

Account IdThe company account your username is associated with on NetSuite.
Aggregate Column ModeIndicating how aggregate columns should be treated.
Application IdAs of version 2020.1, requests to NetSuite require an application ID.
Auth KeyThe authentication secret used to request and obtain the OAuth Access Token.
Auth SchemeThe type of authentication to use when connecting to NetSuite.
Auth TokenThe authentication token used to request and obtain the OAuth Access Token.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Cache ConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ProviderThe name of the provider to be used to cache data.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Callback URLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Custom Field PermissionsA comma separated list of custom field permissions. Gives more control than IncludeCustomFieldColumns .
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Include Child TablesA boolean indicating if child tables should be displayed.
Include Custom Field ColumnsA boolean indicating if you would like to include custom field columns.
Include Custom List TablesA boolean indicating if you would like to use tables based on custom lists.
Include Custom Record TablesA boolean indicating if you would like to use tables based on custom record types.
Include Reference ColumnsA comma separated list representing the columns to include when retrieving data from a field representing a record reference.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Maximum Concurrent SessionsThe maximum number of concurrent sessions available for use in the connection.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Netsuite Metadata FolderA path to a directory to download metadata files from NetSuite. Set this for best performance.
OAuth Access TokenThe access token for connecting using OAuth.
OAuth Access Token SecretThe OAuth access token secret for connecting using OAuth.
OAuth Client IdThe client ID assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Expires InThe lifetime in seconds of the OAuth AccessToken.
OAuth Settings LocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuth Token TimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe number of results to return per page from NetSuite.
PasswordThe password of the NetSuite user used to authenticate.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy ExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to NetSuite from the provider.
Report Doubles As DecimalIndicates if doubles should be reported as decimal.
Request Memorized TransactionsA boolean indicating if you would like to request memorized transactions when retrieving transactions from NetSuite.
Role IdThe RoleId is the InternalId of the role that will be used to log in to NetSuite. Leave empty to use the user's default role.
RTKThe runtime key used for licensing.
SchemaThe type of schema to use.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
Use Async ServicesA boolean indicating if you would like to use asynchronous services when inserting, updating, and deleting.
Use Internal Names For CustomizationsA boolean indicating if you would like to use internal names for customizations.
UserThe user of the NetSuite account used to authenticate.
User Timezone OffsetYour user timezone offset as defined in your NetSuite preferences under Home --> Preferences --> Time Zone. Ex: -8:00.
Use Simple NamesBoolean determining if simple names should be used for tables and columns.
Use UpsertsA boolean indicating if you would like to perform an upsert when an insert operation is used.
VersionThe version of the NetSuite API in usage. Defaults to 2020_1.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Web Service HostAn optional override for the web service host such as webservices.na1.netsuite.com.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7606