ADO.NET Connection Options
You can modify a connection by specifying connection string options.
The basic format of a connection string includes a series of option/value pairs separated by semicolons. The following example shows the connection options and values for a simple connection string to connect to the SuiteAnalytics Connect service:
Host=<ServiceHost>;Port=1708;EncryptionMethod=SSL;ServerDataSource=NetSuite.com; UserID=test@netsuite.com;Password=<password>;CustomProperties='AccountID=<accountID>;RoleID=<roleID>';
The <ServiceHost>, <accountID>, and <roleID> variables correspond to your host name, account ID, and role ID.
The connection options used in this connection string correspond to the following fields 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.
|
SuiteAnalytics Connect Driver Download Page |
Connection Attribute |
|---|---|
|
Service Host |
ServerName |
|
Service Port |
PortNumber |
|
Service Data Source |
ServiceDataSource |
|
Account ID |
CustomProperties (AccountID) |
|
Role ID |
CustomProperties (RoleID) |
Use the following guidelines when specifying a connection string:
-
Connection string option names are not case-sensitive. For example, you can use Password or password as the connection option name. However, the values for the User ID and Password connection options may be case-sensitive.
-
Special characters can be used in the value of the connection string option. If a value contains special characters, enclose it in single quotation marks ('example').
CustomProperties
SuiteAnalytics Connect requires two custom properties connection options:
-
Account ID – your NetSuite account ID.
-
Role ID – the NetSuite role ID for the specified account.
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>'
EncryptionMethod
|
Property |
EncryptionMethod |
|
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 |
SSL |
|
Default |
None |
Host
|
Property |
Host |
|
Description |
Required. The TCP/IP address of the SuiteAnalytics Connect server, specified as a host name. |
|
Valid Values |
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 |
Password
|
Property |
Password |
|
Description |
Required. The password used to log in to NetSuite. |
|
Valid Values |
A string containing a password used to log in to NetSuite. |
|
Default |
None |
Port
|
Property |
Port |
|
Description |
Required. The TCP/IP port on which the SuiteAnalytics Connect server is listening. |
|
Valid Values |
1708 |
|
Default |
None |
Server Data Source
|
Property |
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 |
User ID
|
Property |
UserID |
|
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 |
Validate Server Certificate
|
Property |
ValidateServerCertificate |
|
Description |
Optional. If you choose to use this connection option, 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). |
|
Valid Values |
0 or 1 If you use this option, it must be set to 1. When set to 1, the driver validates the certificate sent by the SuiteAnalytics Connect server. 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. |
|
Default |
1 |