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 | Specifies the authentication method to use when connecting to NetSuite. |
| AccountId | Specifies the company Account ID associated with your username on NetSuite. |
| RoleId | Specifies the InternalId of the NetSuite role used for authentication. Leave this property empty to use the user's default role. |
| User | Specifies the username for the NetSuite account used for authentication. |
| Password | Specifies the password for the NetSuite user used for authentication. |
| Version | Specifies the NetSuite API version to use. |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthVersion | Specifies the OAuth version used for authentication. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| CallbackURL | Identifies the URL users return to after authenticating to NetSuite via OAuth (Custom OAuth applications only). |
| Scope | Specifies the OAuth 2.0 scope required to obtain the initial access and refresh token. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| 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 | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTEncryptionKey | The key used used for HMAC signatures with JWT tokens. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| JWTScope | Specifies the scope of the JWT, which defines the level of access the token provides to NetSuite data. |
| OAuthJWTEncryption | The encryption algorithm to be used in JWT authentication. |
| OAuthJWTHeaders | A collection of extra headers to include in the JWT. |
| OAuthJWTValidityTime | How long the JWT should remain valid, in seconds. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Schema | Specifies the type of schema to use for the connection. |
| RowScanDepth | Specifies the number of rows to scan when dynamically determining column metadata for a table. |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live NetSuite data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AccountSupportsSuiteAnalyticsConnect | Specifies whether SuiteAnalytics Connect is enabled for the authenticated account. |
| AggregateColumnMode | Specifies how aggregate columns, which consolidate data from child collections, are handled. This property applies only when Schema is set to SuiteTalk. |
| ApplicationId | Specifies the Application ID required by NetSuite for API requests as of version 2020.1. |
| CustomFieldPermissions | Specifies a comma-separated list of custom field permissions to use when retrieving metadata. Overrides the binary behavior of IncludeCustomFieldColumns , allowing selective inclusion of custom fields based on permissions. |
| IncludeChildTables | Specifies whether to display child tables. |
| IncludeCustomFieldColumns | Specifies whether to include custom fields as columns in tables. |
| IncludeCustomListTables | Specifies whether to include tables based on custom lists. |
| IncludeCustomRecordTables | Specifies whether to include tables based on custom record types. |
| IncludeLongTextColumns | Specifies whether long or rich text custom fields should be included in the schema. |
| IncludeReferenceColumns | Specifies a comma-separated list of columns to include when retrieving data from fields that reference other records. |
| MaximumConcurrentSessions | Specifies the maximum number of concurrent sessions available for use in the connection. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| NetsuiteDateFormat | The preferred date format set in NetSuite UI. |
| NetsuiteLongDateFormat | The preffered long date format set in NetSuite UI. |
| NetsuiteMetadataFolder | Specifies the directory path for downloading metadata files from NetSuite. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | Specifies the number of results to return per page from NetSuite. |
| PreferredDateFormats | A semicolon separated string containing a list of DateTime formats which should be tried when parsing DateTime values. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Readonly | Toggles read-only access to NetSuite from the provider. |
| ReportDoublesAsDecimal | Specifies whether double values should be reported as decimals. |
| RequestMemorizedTransactions | Specifies whether to include memorized transactions when retrieving transactions from NetSuite. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| SuiteQLDateFormat | Specifies an optional override for the default Date format. |
| SuiteQLDatetimeFormat | Specifies an optional override for the default Datetime format when retrieving data with SuiteQL. |
| SuiteQLDatetimeFormula | Specifies an optional override for the formula used when filtering on date fields in SuiteQL queries. |
| Timeout | Specifies the number of seconds an operation can run before it times out and is canceled. |
| UseAsyncServices | Specifies whether to use asynchronous services for inserting, updating, and deleting records. |
| UseInternalNamesForCustomizations | Specifies the mode used to control whether internal names or label names are used for custom records and fields. By default, internal names are used for both tables and columns. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UserTimezoneOffset | Specifies the user's timezone offset as configured in NetSuite. This setting ensures that Date and Time values are displayed correctly based on the user's NetSuite preferences. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |
| UseUpserts | Specifies whether an INSERT operation should perform an upsert by checking the ExternalId. |
| WebServiceHost | Specifies an optional override for the NetSuite web service host, such as webservices.na1.netsuite.com. |