Skip to Content

NetSuite connection guide for Jitterbit App Builder

Overview

This guide describes the system requirements and gives instructions for connecting App Builder to an Oracle NetSuite cloud database server.

System requirements

These are the minimum browser versions necessary:

  • Chrome: 84+

  • Firefox: 73+

  • Safari: 13.0.1+

  • Edge: 84+

  • Internet Explorer: 11+

Connection instructions

To connect App Builder with NetSuite, you must configure an integration in NetSuite and obtain tokens from it, which you will use to establish the connection. The following sections describe how to do each of those things.

Configure a new NetSuite integration

Follow these steps to create a new integration in NetSuite that App Builder can connect with. You will need administrative access to NetSuite.

  1. Log in to NetSuite as an administrator.

    attachment

  2. Navigate to Setup > Integration > Manage Integration > New.

    attachment

  3. Enter the required information and click the Save button. When the integration is configured, NetSuite generates a unique Client ID and Secret. Make a note of these values. You will use them to set up the App Builder connection.

    Important

    The Client ID and the Secret are only shown once. Make sure to copy their values before proceeding.

Generate access tokens

After you've configured the NetSuite integration, you must generate access tokens to allow App Builder to connect to it.

Follow the steps in the NetSuite documentation to generate tokens. You will need both the Token ID and the Token Secret.

Add a data server

Now that you've configured a NetSuite integration and obtained its access tokens, you are ready to connect App Builder to it. Open App Builder and follow these steps:

  1. Select IDE > Data Servers.

  2. Click the + Server button.

  3. The following fields are shown:

    1. In the Server Settings section:

      1. Server Name: Enter a name for this server.

      2. Type: Click to open the menu, then find and select NetSuite.

      3. Instance Name: Enter the ID contained in your unique NetSuite URL. For example, if your URL is https://1234567.app.netsuite.com/ then your instance name is 1234567.

    2. In the Security Settings section:

      1. Security Provider: (Optional) Select a security provider from the menu.

    3. In the Testing section:

      1. Test Connection: Click to check your connection credentials. Note that the test will fail if you still haven't completed the Advanced Settings below. Complete the configuration first, then return to this dialog and test the connection.

      2. Allow Challenge: Select this checkbox to let App Builder redirect the browser when it gets an OAuth challenge.

  4. Click the Save button.

  5. Click the Advanced Settings button in the Server Settings section. The Server (Advanced Settings) dialog opens.

  6. Click the Edit button. The following fields are shown:

    1. Advanced: In this field, enter the following information:

      Schema={{ Schema }};
OAuthClientId={{ OauthClientID }};
OAuthClientSecret={{ OauthClientSecret }};
OAuthAccessToken={{ AccessToken }};
OAuthAccessTokenSecret={{ AccessSecret }};
IncludeChildTables=true;

      Make the following replacements:

      1. Replace Schema with either SuiteQL or SuiteTalk. See SuiteQL and SuiteTalk for help picking one.

      2. Replace OauthClientID with the Client ID you noted down during integration configuration (see Configure a new NetSuite integration).

      3. Replace OauthClientSecret with the Secret you noted down during integration configuration (see Configure a new NetSuite integration).

      4. Replace AccessToken with the Token ID you generated previously (see Generate access tokens).

      5. Replace AccessSecret with the Token Secret you generated previously (see Generate access tokens).

      6. The IncludeChildTables parameter is only required if you've picked SuiteTalk as your schema and you need to write to tables with relationships to see the sub tables.

      Note

      Other parameters are supported, if you need them. See the NetSuite documentation to learn more.

    2. Ping Timeout: The amount of time (in seconds) that App Builder will wait for a ping back from the server before timing out. The default value is 10.

    3. Escape Query Parameter Name: Select to use parameters with reserved name values. This checkbox is enabled by default.

  7. Click Save to confirm and save all your settings.

Add a data source

After the server has been added, it needs to be added in App Builder as a data source. To do this, follow these steps:

  1. Navigate to IDE > Data Servers.

  2. In the Data Servers table, locate the server you've added (see Add a data server above) and select its row. The Data Sources panel on the right will display the new data source, which will have been added automatically. Click Details.

    Note

    Clicking the Details button on the row of the server in the Data Servers table does not display the same options.

  3. The top section will have the name you typed under Server Name when you added the server. Click the Edit button if you want to alter the Data Source Name, and have a unique display name. (By default, it has the same name as the server.)

  4. In the Data Storage Layer section, click Import. The Import Schema dialog opens.

  5. In the Import From Pattern field, enter the subset of tables you want to import from the database using mvSQL syntax. If this field is left blank, all tables will be imported.

  6. Click Import, then Proceed. The import will be scheduled to run in the background. Once you get a successful confirmation message, the tables imported will be displayed below.

NetSuite SuiteQL vs. SuiteTalk Web Services

When you add NetSuite as a data server in App Builder, you need to choose whether to use SuiteQL or SuiteTalk Web Services as your schema. The information below can help you determine which one best suits your needs.

SuiteQL is a query language based on the SQL database query language and used to query data from NetSuite. The default service supported in SuiteTalk is designed using a number of SOAP requests to retrieve data in a format more closely associated with the saved searching in NetSuite. This means that SuiteQL can be used to handle much more complicated queries than SuiteTalk. For instance, joins, aggregations, group by, order by, and formulas can all be handled server side using SuiteQL. Within App Builder itself, SuiteQL will allow you to display Objects as Views.

attachment

SuiteTalk Web Services is a SOAP-based web service used for integration with external systems, in this case App Builder. By design, SuiteTalk will only support some joins and predicates. SuiteTalk will provide you with table endpoints based on SOAP endpoints in NetSuite.

attachment

In general, SuiteQL is a more powerful option for executing queries faster against NetSuite due to its advanced support for handling SQL. Our recommendation is to use Suite QL for reading and object building and SuiteTalk for writing and updating data.

Limitations

  • NetSuite limits concurrency of queries that run against it by connection and licenses by connection pool, which impacts read performance.

  • NetSuite has some custom rules on filters that you will need to manipulate your data format to be able to properly filter.

  • NetSuite does not support the use of parentheses in object names.