NetSuite
NetSuite
NetSuite supports two connection methods: SuiteQL and SuiteTalk. Each method has benefits and drawbacks, as outlined below. For most users, CData recommends using SuiteQL.
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:
-
Configure user roles.
-
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. CData Connect Cloud recommends using OAuth or Token authorization.
-
Follow the steps under Connect to NetSuite to establish the connection.
Step 1: Configure Roles
CData Connect Cloud communicates with NetSuite through NetSuite Web services. If the user account that you will use for establishing the connection does not have NetSuite Web services permissions, follow these steps to create them:
-
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. 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.
Next, add this role to an employee:
-
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.
Continue to Connecting to NetSuite below.
Step 2: Connect to NetSuite
-
Open the Connections page of the CData Connect Cloud dashboard.
-
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 CData Connect Cloud 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
-
Click Sign in to connect securely through OAuth. This action opens the NetSuite sign-in page in a new tab.
-
Log in to your NetSuite account and provide the requested permissions (if applicable).
-
At the top of the CData Connect Cloud Add NetSuite Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
-
Token
-
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.
Next, create an access token by following these steps:
-
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 CData Connect Cloud 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.
-
At the top of the CData Connect Cloud Add NetSuite Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
-
Basic
Note: This version is only supported on older versions of NetSuite and is not recommended.
-
In the User field, enter the NetSuite username for authentication.
-
Enter the user password.
-
At the top of the CData Connect Cloud Add NetSuite Connection page, click Save & Test.
-
If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.
-
If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
-
Troubleshooting
When logging in through OAuth, I receive the error “Your role does not support OAuth2 login, please select a different one.”
This error appears when the role that you select during OAuth login is not configured for OAuth. If you have an OAuth-configured role, click Choose another role on the NetSuite authorization page and select that role. If you do not have an OAuth-configured role, follow the steps in the Configure Roles section.
More Information
For more information about interactions between CData Connect Cloud and NetSuite, see this information page.