Connection String Options
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. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to NetSuite. |
| AccountId | The company account your username is associated with on NetSuite. |
| RoleId | 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. |
| User | The user of the NetSuite account used to authenticate. |
| Password | The password of the NetSuite user used to authenticate. |
| Version | The version of the NetSuite API in usage. Defaults to 2022_2. |
| IncludeChildTables | A boolean indicating if child tables should be displayed. |
| NetsuiteMetadataFolder | A path to a directory to download metadata files from NetSuite. Set this for best performance. |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| OAuthVersion | The version of OAuth being used. |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| Scope | Specify scope to obtain the initial access and refresh token with OAuth 2.0. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
| AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Schema | The type of schema to use. |
| RowScanDepth | The number of rows to scan when dynamically determining columns for the table. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheDriver | The database driver used to cache data. |
| CacheConnection | 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. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| AccountSupportsSuiteAnalyticsConnect | A boolean indicating if Connect Service Feature is enabled for the authenticated account. |
| AggregateColumnMode | Indicating how aggregate columns should be treated. |
| ApplicationId | As of version 2020.1, requests to NetSuite require an application ID. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| ConnectOnOpen | This property specifies whether to connect to the NetSuite when the connection is opened. |
| CustomFieldPermissions | A comma separated list of custom field permissions that gives you more control than IncludeCustomFieldColumns . |
| IncludeCustomFieldColumns | A boolean indicating if you would like to include custom field columns. |
| IncludeCustomListTables | A boolean indicating if you would like to use tables based on custom lists. |
| IncludeCustomRecordTables | A boolean indicating if you would like to use tables based on custom record types. |
| IncludeLongTextColumns | A boolean indicating if you would like to support long or rich text custom fields. |
| IncludeReferenceColumns | A comma separated list representing the columns to include when retrieving data from a field representing a record reference. |
| MaximumConcurrentSessions | The maximum number of concurrent sessions available for use in the connection. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| NetsuiteDateFormat | The preferred date format set in NetSuite UI. |
| NetsuiteLongDateFormat | The preffered long date format set in NetSuite UI. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The number of results to return per page from NetSuite. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| Readonly | You can use this property to enforce read-only access to NetSuite from the provider. |
| ReportDoublesAsDecimal | Indicates if doubles should be reported as decimal. |
| RequestMemorizedTransactions | A boolean indicating if you want to request memorized transactions when retrieving transactions from NetSuite. |
| RTK | The runtime key used for licensing. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseAsyncServices | A boolean indicating if you would like to use asynchronous services when inserting, updating, and deleting. |
| UseConnectionPooling | This property enables connection pooling. |
| UseInternalNamesForCustomizations | A enum indicating whether you want to use internal names or labels for customizations. The default behavior of the NetSuite displays records and columns with their internal names. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UserTimezoneOffset | Your user timezone offset as defined in your NetSuite preferences under Home --> Preferences --> Time Zone. Ex: EST. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
| UseUpserts | A boolean indicating if you would like to perform an upsert when an INSERT operation is used. |
| WebServiceHost | An optional override for the web service host such as webservices.na1.netsuite.com. |