Connection String Parameters for NetSuite
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
|The company account your username is associated with on NetSuite.
|Indicating how aggregate columns should be treated.
|As of version 2015.2, requests to NetSuite require an application ID or token-based authentication details.
|Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
|The 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.
|Specifies the path to the cache when caching to a file.
|This property determines whether or not to cache the table metadata to a file store.
|The name of the provider to be used to cache data.
|The tolerance for stale data in the cache specified in seconds when using AutoCache .
|The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
|The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
|A comma separated list of custom field permissions. Gives more control than IncludeCustomFieldColumns .
|A password used to authenticate to a proxy-based firewall.
|The TCP port for a proxy-based firewall.
|The name or IP address of a proxy-based firewall.
|The protocol used by a proxy-based firewall.
|The user name to use to authenticate with a proxy-based firewall.
|A boolean indicating if child tables should be displayed.
|A boolean indicating if you would like to include custom field columns.
|A boolean indicating if you would like to use tables based on custom lists.
|A boolean indicating if you would like to use tables based on custom record types.
|A comma separated list representing the columns to include when retrieving data from a field representing a record reference.
|Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
|A path to the directory that contains the schema files defining tables, views, and stored procedures.
|A path to the log file.
|Boolean indicating if unknown sessions already established to the user account should be removed.
|The maximum number of concurrent sessions available for use by the username specified in the connection.
|A 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.
|A 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.
|Limits 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.
|A path to a directory to download metadata files from NetSuite. Set this for best performance.
|The access token for connecting using OAuth.
|The OAuth access token secret for connecting using OAuth.
|The client ID assigned when you register your application with an OAuth authorization server.
|The client secret assigned when you register your application with an OAuth authorization server.
|The 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://.
|The verifier code returned from the OAuth authorization URL.
|Use offline mode to get the data from the cache instead of the live source.
|These hidden properties are used only in specific use cases.
|The number of results to return per page from NetSuite.
|The password of the NetSuite user used to authenticate.
|The allowed idle time for a connection before it is closed.
|The maximum connections in the pool.
|The minimum number of connections in the pool.
|The max seconds to wait for an available connection.
|The authentication type to use to authenticate to the ProxyServer proxy.
|This 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.
|A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
|A password to be used to authenticate to the ProxyServer proxy.
|The TCP port the ProxyServer proxy is running on.
|The hostname or IP address of a proxy to route HTTP traffic through.
|The SSL type to use when connecting to the ProxyServer proxy.
|A user name to be used to authenticate to the ProxyServer proxy.
|This property indicates whether or not to include pseudo columns as columns to the table.
|You can use this property to enforce read-only access to NetSuite from the provider.
|Indicates if doubles should be reported as decimal.
|A boolean indicating if you would like to request memorized transactions when retrieving transactions from NetSuite.
|The 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.
|The runtime key used for licensing.
|The certificate to be accepted from the server when connecting using TLS/SSL.
|This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
|This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
|The value in seconds until the timeout error is thrown, canceling the operation.
|A boolean indicating if you would like to use asynchronous services when inserting, updating, and deleting.
|This property enables connection pooling.
|A boolean indicating if you would like to use internal names for customizations.
|The user of the NetSuite account used to authenticate.
|Your user timezone offset as defined in your NetSuite preferences under Home --> Preferences --> Time Zone. Ex: -8:00.
|Establish sessions with NetSuite, or instead submit user credentials on each request.
|A boolean indicating if you want to use simple names for the tables.
|A boolean indicating if you would like to perform an upsert when an insert operation is used.
|The verbosity level that determines the amount of detail included in the log file.
|The version of the NetSuite API in usage. Defaults to 2019_2.
|Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
|An optional override for the web service host such as webservices.na1.netsuite.com.