JDBC Connection Properties
This section lists the JDBC connection properties supported by the SuiteAnalytics Connect service and describes each property. The properties have the form:
property = value
Connection property names are not case sensitive: they may contain both lowercase and uppercase letters.
You must ensure that you have removed the "ciphersuites" parameter from your connection URL. The JDBC server automatically selects the appropriate cipher suite for authentication. If your connection URL contains a cipher suite, you are unable to access the Connect Service.
For information about supported cipher suites in NetSuite, see Supported TLS Protocol and Cipher Suites.
CustomProperties
SuiteAnalytics Connect requires two custom properties: AccountID and RoleID.
AccountID
|
Description |
Required. The NetSuite account ID. |
|
Default |
None |
RoleID
|
Description |
Required. The NetSuite role ID for the specified account. |
|
Default |
None |
Uppercase
|
Attribute |
Uppercase |
|
Description |
Optional. When the record or field definitions are redefined or updated, the NetSuite2.com data source may change the case of the record type and field names. If you use the If you use SuiteAnalytics Connect with applications that are case sensitive and do not support changes to lowercase or uppercase, you can use this attribute to avoid these changes and potential issues with queries.
Note:
The Connect Service is not case sensitive and this change does not affect your queries. The case used in your queries is not considered. For more information about the |
|
Valid Values |
0 or 1 If you use this attribute, you should set it to 1. Then, query results return record type and field names in uppercase. If you set it to 0, names are not changed to uppercase and you may encounter issues if you use applications that are sensitive to case changes. |
|
Default |
None |
StaticSchema
|
Attribute |
StaticSchema |
|
Description |
Optional. The Static Data Model option provides you with the structure and the name of all available record types and fields in the NetSuite2.com data source. To use the Static Data Model in your account, you must add the StaticSchema attribute and set it to 1. For more information, see Working with the Static Data Model. |
|
Valid Values |
0 or 1 If you use this attribute, you must set it to 1. |
|
Default |
Off |
OAuth2Token
|
Attribute |
OAuth2Token |
|
Description |
Optional. The OAuth 2.0 feature is an authentication mechanism that enables you to use a token to access the NetSuite2.com data source. For more information about OAuth 2.0 and Connect, see OAuth 2.0 for Connect. For more information about adding the |
|
Valid Values |
Authentication string |
|
Default |
None |
The list of custom properties attributes should be added in the following order:
CustomProperties=(AccountID=<accountID>;RoleID=<RoleID>;Uppercase=1;StaticSchema=1;OAuth2Token=<connection string value>)
Encrypted
|
Description |
Required. Enables the use of SSL encryption for the data exchanged with the SuiteAnalytics Connect service server. Must be included in the connection URL. |
|
Valid Values |
1 |
|
Example |
|
|
Default |
0 |
|
Data type |
boolean |
The <ServiceHost> variable corresponds to your host name. This value is available on the SuiteAnalytics Connect Driver Download page under Your Configuration. You can access the SuiteAnalytics Connect Driver Download page using the Set Up Analytics Connect link in the Settings portlet when you are logged in to NetSuite. For more information, see Finding Your Settings Portlet.
Password
|
Description |
Required. The password used to log in to NetSuite. |
|
Example |
For examples of using this connection property with the getConnection attribute, see JDBC Code Examples. |
|
Default |
None |
|
Data type |
String. You should use the getConnection() method instead of typing the password directly into the connection string. |
PortNumber
|
Description |
Required. The TCP/IP port on which the SuiteAnalytics Connect server is listening. |
|
Valid Values |
1708 |
|
Default |
None |
|
Data type |
String |
ServerDataSource
|
Description |
Required. The name of the SuiteAnalytics Connect server data source to be used for the connection. |
|
Valid Values |
NetSuite2.com For more information about the data source, see Connect Data Source. |
|
Default |
None |
|
Data type |
String |
ServerName
|
Description |
Required. The TCP/IP address of the SuiteAnalytics Connect server, specified as a host name. |
|
Valid Values |
The Connect Service host name. The host name you should use for your connection is displayed in the Service Host field on the SuiteAnalytics Connect Driver Download page, under Your Configuration. |
|
Default |
None |
|
Data type |
String |
TCPKeepAlive
|
Description |
Optional. If you are using a JDBC driver and have set the The |
|
Valid Values |
true or false If you use this attribute, you must set it to true. |
|
Default |
false |
|
Data type |
String |
TrustStore
|
Description |
Optional. If specified, the property should contain the path to a valid truststore containing the security certificates to be used for server authentication.
Note:
The certificates provided on the SuiteAnalytics Connect driver download page are usually already included in the internal Java truststore. In this case, it is not required to add the TrustStore attribute to the connection string. Specifies the directory of the truststore file to be used when SSL is enabled using the Encrypted property and when service authentication is used. The truststore file contains a list of the Certificate Authorities (CAs) that the client trusts. This value overrides the directory of the Java truststore file specified by the javax.net.ssl.trustStore Java system property. If this property is not specified, the truststore directory is specified by the javax.net.ssl.trustStore Java system property. The truststore file is a Java keystore file, generated by the keytool utility, which is a part of the JDK. For more information on configuring a truststore using the keytool utility, see Authentication Using Server Certificates for JDBC and http://docs.oracle.com/cd/E19509-01/820-3503/6nf1il6er/index.html. The TrustStore property is ignored if the ValidateServerCertificate property is set to false. |
|
Valid Values |
A string containing the path to a truststore file. |
|
Default |
None |
|
Data type |
String |
User
|
Description |
Required. The email used to log in to NetSuite. |
|
Valid Values |
A string containing an email used to log in to NetSuite. |
|
Default |
None |
|
Data type |
String |
ValidateServerCertificate
|
Description |
Optional. If you choose to use this connection property, make sure it is set to true. Determines whether the driver validates the certificate sent by the SuiteAnalytics Connect server. During SSL server authentication, the SuiteAnalytics Connect server sends a certificate issued by a trusted Certificate Authority (CA). The required CAs are usually included in the Java truststore, but you can also specify them using the TrustStore property. |
|
Valid Values |
true or false If you use this property, it must be set to true. When set to true, the driver validates the certificate sent by the SuiteAnalytics Connect server. Any certificate from the server must be issued by a trusted CA in the truststore file. When set to false, the driver does not validate the certificate sent by the SuiteAnalytics Connect server. The driver ignores any truststore information specified by the TrustStore property. |
|
Default |
true |
|
Data type |
Boolean |
NegotiateSSLClose
|
Description |
Required. You must use the attribute value pair
Note:
NetSuite accounts are moved to NetSuite data centers built on the Oracle Cloud Infrastructure (OCI). If you do not add this attribute value pair, you may experience a delay of up to 30 seconds when you log out of your Connect session after the move. For more information, see Required Update of SuiteAnalytics Connect Drivers. |
|
Valid Values |
You must set this attribute to false. You must use |
|
Default |
true |
|
Data type |
String |