Connection Attributes
You can modify a connection by specifying connection string options.
The basic format of a connection string includes a series of keyword/value pairs separated by semicolons. The following example shows the keywords and values for a simple connection string to connect to the SuiteAnalytics Connect server using the Windows operating system:
DRIVER=NetSuite Drivers 32bit;Host=<ServiceHost>;Port=1708;Encrypted=1;ServerDataSource=NetSuite.com;
Truststore=system;LogonId=test@netsuite.com;Password=<password>;AllowSinglePacketLogout=1;CustomProperties=AccountID=<accountID>;RoleID=<roleID>
The required value of the trust store parameter varies depending on the operating system. For more information, see Authentication Using Server Certificates for ODBC.
These attributes correspond to the following fields in the driver setup dialog:
|
SuiteAnalytics Connect ODBC Driver Setup Window Fields on the General Tab |
Connection Attribute |
|---|---|
|
Name |
DSN |
|
Account ID |
AccountID |
|
Role ID |
RoleID |
|
Service Host |
Host |
|
Service Port |
Port |
|
Service Data Source |
ServiceDataSource |
|
Logon to SuiteAnalytics Connect ODBC Data Source Window |
Connection Attribute |
|---|---|
|
User Name |
LogonID |
|
Password |
Password |
This section describes the ODBC connection attributes supported by the ODBC driver on Linux and Windows, on 32-bit and 64-bit platforms.
Connection attributes are listed alphabetically by their names that appear on the driver setup dialog. The connection string attribute name, along with its short name, is listed immediately underneath the user interface name. The list includes long and short names and provides a description of each attribute. Short names are enclosed in parentheses ( ).
In many cases, the user interface name and the attribute name are the same. However, some connection string attributes may not appear in the user interface at all.
Custom Properties
SuiteAnalytics Connect requires two custom properties attributes: Account ID and Role ID.
AccountID
|
Attribute |
AccountID |
|
Description |
Required. The NetSuite account ID. |
|
Default |
None |
Role ID
|
Attribute |
RoleID |
|
Description |
Required. The NetSuite role ID for the specified account |
|
Default |
None |
The <accountID> and <roleID> variables correspond to your account ID and role ID. The values are 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.
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 |
|
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>
Driver
|
Attribute |
Driver |
|
Description |
Required when DSN-less connection is used. For more details, see DSN-less connection. |
|
Valid Values |
|
|
Default |
None |
DSN
|
Attribute |
DSN (DSN) |
|
Description |
Optional. Specifies the SuiteAnalytics Connect data source configuration name for established connections. |
|
Valid Values |
A string containing the name of the DSN that is used to connect to NetSuite. For example, NetSuite. |
|
Default |
Empty string |
Encrypted (SSL)
|
Attribute |
Encrypted (ENC) |
|
Description |
Required. Enables the use of SSL encryption for data exchanged with the SuiteAnalytics Connect service server. Must be included in the connection string. |
|
Valid Values |
1 The Connect Service works only with encrypted connections. The default value is 0. Therefore, to establish an encrypted connection, you must set the value to 1. When set to 1, the SuiteAnalytics Connect server can establish an encrypted connection and enables users to connect. When set to 0, the SuiteAnalytics Connect server cannot establish an encrypted connection and users cannot connect. |
|
Default |
0 |
Password
|
Attribute |
Password (PWD) |
|
Description |
Required. The password used to log in to NetSuite.
Note:
If you log in to the Connect Service with token-based authentication (TBA), you must use a token password instead of your NetSuite account password. For more information, see Token Password for Connect. |
|
Valid Values |
A string containing a password used to log in to NetSuite. |
|
Default |
None |
Service Data Source
|
Attribute |
ServerDataSource (SDSN) |
|
Description |
Required. The name of the SuiteAnalytics Connect server data source to be used for the connection. |
|
Valid Values |
NetSuite2.com For information about the data source, see Connect Data Source. |
|
Default |
None |
Service Host
|
Attribute |
Host (HST) |
|
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. If the Hostname in Certificate attribute is used, see Authentication Using Server Certificates for ODBC to check which value to use. |
|
Default |
None |
Service Port
|
Attribute |
Port (PRT) |
|
Description |
Required. The TCP/IP port on which the SuiteAnalytics Connect server is listening. |
|
Valid Values |
1708 |
|
Default |
None |
Truststore
|
Attribute |
Truststore (TS) |
|
Description |
Required. Certificate Authorities (CAs) to be used for server authentication. |
|
Valid Values |
Depending on your operating system and the driver type, you may need to update the value manually to ensure that the authentication with server certificates is enabled. For more information, see Authentication Using Server Certificates for ODBC. |
|
Default |
None |
User Name
|
Attribute |
LogonID (UID) |
|
Description |
Required. The string required to log in to your account. |
|
Valid Values |
The email used to log in to NetSuite.
Note:
If you log in to the Connect Service with token-based authentication (TBA), you must use TBA as the username value. For more information, see Token-based Authentication for Connect. |
|
Default |
None |
Validate Server Certificate
|
Attribute |
ValidateServerCertificate (VSC) |
|
Description |
Optional. If you choose to use this connection attribute, make sure it is set to 1. 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). This certificate is validated against the certificate files specified in the Truststore attribute. |
|
Valid Values |
0 or 1 If you use this attribute, it must be set to 1. When set to 1, the driver validates the certificate sent by the SuiteAnalytics Connect server against the certificate files specified in the Truststore attribute. Any certificate from the server must be issued by a trusted CA. When set to 0, the driver does not validate the certificate sent by the database server. The driver ignores any certificates specified in the TrustStore attribute. |
|
Default |
1 |
AllowSinglePacketLogout
|
Attribute |
AllowSinglePacketLogout |
|
Description |
Required. You must add 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 1. You must use For more information, see Connecting Using a Connection String. |
|
Default |
0 |
Related Topics
- Accessing the Connect Service Using an ODBC Driver
- Prerequisites
- Downloading and Installing the ODBC Driver for Windows
- Downloading and Installing the ODBC Driver for Linux
- Configuring the ODBC Driver
- Connecting Using a Connection String
- Authentication Using Server Certificates for ODBC
- Upgrading an ODBC Driver
- Accessing the Connect Service Using Microsoft Excel