Documentation Index
Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
Use this file to discover all available pages before exploring further.
For a detailed discussion about the differences between SuiteTalk and SuiteQL, see the NetSuite driver documentation.
SuiteQL
SuiteQL is the newer of the two connection methods. This method offers much better performance, especially when you issue large queries. It also supports rich join support, grouping, aggregation, custom list tables, and retrieval of specific columns in your data.
However, SuiteQL only supports SELECT queries. As a result, you cannot issue INSERT, UPDATE, or DELETE queries to NetSuite when you are connected via SuiteQL.
SuiteTalk
SuiteTalk is the older of the two connection methods. This method provides broad entity support and full support for INSERT, UPDATE, and DELETE queries. However, it often performs poorly during large SELECT queries and lacks reliable table joining capabilities. You also cannot group or aggregate data using SuiteTalk.
For performance and reliability reasons, CData recommends using SuiteTalk only if you require access to INSERT, UPDATE, and DELETE queries for your connection to NetSuite.
Setup Guide
To configure your NetSuite connection, follow these steps:
Choose a connection method (SuiteQL/OAuth or SuiteTalk/Token). Note that NetSuite does not support basic authentication through username and password credentials in recent versions. Connect AI recommends using OAuth or Token authorization.
Log in to NetSuite as an administrator. From the navigation bar, select Setup > Users/Roles > Manage Roles.
Choose an existing role or create a new one, depending on your needs.
On the Edit Role page, navigate to the Permissions section.
Expand the Setup () field.
In a blank slot, select SOAP Web Services and click Add to add the permission.
In another blank slot, select REST Web Services and click Add to add the permission.
Add additional permissions.
- If you plan to connect to NetSuite via SuiteQL/OAuth, add the OAuth 2.0 Authorized Applications Management permission.
- If you plan to connect to NetSuite via SuiteTalk/Token add the User Access Token and Access Token Management permissions.
Important: See Permission Configurations in the NetSuite driver documentation for additional permissions that may be needed.
When you finish, return to the top of the page and click Save to save the role.
From the navigation bar, select Lists > Employees > Employees. Select an employee or add a new one.
Scroll to the Access section. In the Roles subsection, add the role that you created.
Scroll to the top and click Save.
Connect to NetSuite
Open the Sources page of the Connect AI navigation menu.
Click + Add Connection in the upper-right corner.
Type NetSuite in the Add Connection dialog that opens. Click the data-source name when it is displayed.
On a separate browser tab, log in to your NetSuite account as an administrator role.
From the top navigation bar, select Setup > Company > Company Information.
Copy the value for Account Id to your clipboard.
Return to Connect AI and enter the copied value into the Account Id field .
For the Schema field, select either SuiteQL or SuiteTalk.
Note: CData recommends SuiteQL for most use cases. Click here for information on the differences between SuiteQL and SuiteTalk. Select the Authentication method, then proceed to the relevant section and follow those instructions. Note that OAuth is only available if SuiteQL is selected, and Basic is only available when Suitetalk is selected.
Authentication Methods
OAuth
Token
OAuthJWT
Basic
OAuth でセキュアに接続するには、Sign in をクリックします。これにより、NetSuite のサインインページが新しいタブで開かれます。
NetSuite アカウントにログインし、リクエストされた権限を設定します（該当する場合）。
Connect AI Add Connection ページ上部の、Save & Test をクリックします。
- 接続テストに成功すると、コネクションが作成されたことを示すConnection successfully saved というメッセージが表示されます。Edit Connection ページのStatus もAuthenticated に変わります。Edit Connection ページの右ペインにあるData Model タブで、成功したコネクションのデータモデルを表示します。
- 接続テストに失敗した場合は、入力したログイン情報に余分なスペースや文字がないかを確認してください。Connect AI は、データが不足している必須フィールドの下にエラーメッセージを表示します。一部のデータソースでは、ソースのWeb サイトに直接サインインする必要があります。サインインしていない場合は、Sign in ボタンの下にエラーメッセージが表示されます。エラーを修正し、もう一度試してください。
- 失敗したコネクションは下書きとして保存され、Status はNot Authenticated になります。後でコネクションに戻って認証することができます。
In NetSuite, navigate to Setup > Company > Enable Features.
Open the SuiteCloud tab and scroll to Manage Authentication. Make sure the checkbox Token-Based Authentication is selected, then scroll to the top and click Save.
Navigate to Setup > Integration > Manage Integrations.
Create a new integration. Under Token-based Authentication, select the Token-Based Authentication and TBA: Authorization Flow checkboxes.
In the Callback URL field, enter https://oauth.cdata.com/oauth/.
In the OAuth 2.0 section, if you do not plan to use OAuth elsewhere with this integration, clear the Authorization Code Grant checkbox.
Copy the values for Consumer Key / Client ID and Consumer Secret / Client Secret from the Client Credentials section. You need these values later. (Note: If you click Save before you copy the consumer key and secret, click Edit then Reset Credentials.)
Click Save to save the integration.
From the navigation bar, select Setup > Users/Roles > Access Tokens.
Create a new access token. For the application name, select the integration you created.
In the User and Role fields, use the same user and role from the Configure Roles section. Click Save. Copy the credentials for Token ID and Token Secret.
Return to Connect AI and enter your OAuth Client Id.
Enter your Client or Consumer secret into OAuth Client Secret.
Enter your OAuth Access Token Id.
Enter your OAuth Access Token Secret.
Connect AI Add Connection ページ上部の、Save & Test をクリックします。
- 接続テストに成功すると、コネクションが作成されたことを示すConnection successfully saved というメッセージが表示されます。Edit Connection ページのStatus もAuthenticated に変わります。Edit Connection ページの右ペインにあるData Model タブで、成功したコネクションのデータモデルを表示します。
- 接続テストに失敗した場合は、入力したログイン情報に余分なスペースや文字がないかを確認してください。Connect AI は、データが不足している必須フィールドの下にエラーメッセージを表示します。一部のデータソースでは、ソースのWeb サイトに直接サインインする必要があります。サインインしていない場合は、Sign in ボタンの下にエラーメッセージが表示されます。エラーを修正し、もう一度試してください。
- 失敗したコネクションは下書きとして保存され、Status はNot Authenticated になります。後でコネクションに戻って認証することができます。
Enter the following information:
- JWT Scope–the level of access the token provides to NetSuite data. Valid values include restlets, rest_webservices, and suite_analytics. You can specify multiple scopes by separating them with commas.
- OAuth JWT Encryption–select from the drop-down list. This is the encryption algorithm to be used in JWT authentication.
- OAuth JWT Headers–a collection of extra headers to include in the JWT. Each header is a name=value pair. Each pair is separated by a comma.
- OAuth JWT Cert–the contents of the client certificate’s JWT certificate store.
- OAuth JWT Cert Type–the type of key store containing the JWT certificate.
- OAuth JWT Issuer–the issuer of the Java Web Token. This is typically either the client Id or email address of the OAuth application.
- OAuth JWT Validity Time–(optional) the length of time the JWT should remain valid, in seconds. The default value is 3600 seconds.
- OAuth JWT Cert Password–(optional) 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 blank.
- OAuth JWT Cert Subject–(optional) the subject of the OAuth JWT certificate used to locate a matching certificate in the store. The wildcard ’*’ selects the first certificate.
This version is only supported on older versions of NetSuite and is not recommended.
In the User field, enter the NetSuite username for authentication.
Connect AI Add Connection ページ上部の、Save & Test をクリックします。
- 接続テストに成功すると、コネクションが作成されたことを示すConnection successfully saved というメッセージが表示されます。Edit Connection ページのStatus もAuthenticated に変わります。Edit Connection ページの右ペインにあるData Model タブで、成功したコネクションのデータモデルを表示します。
- 接続テストに失敗した場合は、入力したログイン情報に余分なスペースや文字がないかを確認してください。Connect AI は、データが不足している必須フィールドの下にエラーメッセージを表示します。一部のデータソースでは、ソースのWeb サイトに直接サインインする必要があります。サインインしていない場合は、Sign in ボタンの下にエラーメッセージが表示されます。エラーを修正し、もう一度試してください。
- 失敗したコネクションは下書きとして保存され、Status はNot Authenticated になります。後でコネクションに戻って認証することができます。
詳細について
For more information about interactions between Connect AI and NetSuite, see this information page.
