Skip to end of metadata
Go to start of metadata

NetSuite Endpoint

Overview

The NetSuite connector is accessed from the Connectivity tab of the design component palette:

This connector is used to first configure a NetSuite connection to establish a connection with a NetSuite instance, and then to configure one or more NetSuite activities associated with that connection to use as a source or target within an operation:

  • Search: Retrieves existing records from a NetSuite connection and is used as a source in an operation.
  • Create: Creates new records in a NetSuite connection and is used as a target in an operation.
  • Update: Updates existing records in a NetSuite connection and is used as a target in an operation.
  • Get List: Retrieves a list of existing records based on ID from a NetSuite connection and is used as a target in an operation.
  • Upsert: Both updates existing records and creates new records in a NetSuite connection and is used as a target in an operation.
  • Delete: Deletes records in a NetSuite connection and is used as a target in an operation.

Together, a specific NetSuite connection and its activities are referred to as a NetSuite endpoint. Once a connection is configured, activities associated with the endpoint are available from the Endpoints filter:

Prerequisites

To configure and use a NetSuite endpoint, these prerequisites must be met:

Enabling TBA in NetSuite

This section summarizes how to enable token-based authentication (TBA) in NetSuite and obtain the values needed for configuring a NetSuite connection in Cloud Studio.

Enable TBA

  1. Log in to the NetSuite instance.
  2. From the top menu bar, navigate to Setup > Company > Enable Features.
  3. On the Enable Features screen, go to the SuiteCloud tab.
    1. Under the SuiteScript section, select Client SuiteScript and Server SuiteScript.
    2. Under the Manage Authentication section, select Token-Based Authentication.
    3. Click Save.

Create a New Role

If you already have a role with the appropriate permissions configured, you can skip this step.

For those who do not already have an applicable role set up, we recommend installing a customization bundle to add an Administrator-like role. Another option is to create a new role and add permissions individually. Each of these options is covered below.

Install the Custom Administrator Bundle

We recommend using NetSuite's Administrator-like role that is available as a customization bundle. This will help in making sure that Jitterbit Harmony has the most elevated access to items in the NetSuite instance.

To install the customization bundle and add the role:

  1. From the NetSuite's top menu bar, navigate to Customization > SuiteBundler > Search & Install Bundles. (Do not click on List.)
  2. On the Search & Install Bundles page, in the Keywords search box, enter "1251" and click Search.
  3. From the search results, select the bundle Administrator Role - Customizable.
  4. On the Bundle Details page, click Install. Then from the next page, Preview Bundle Install, click Install Bundle.
  5. On the Installed Bundles page, the Status will show "Pending..." Installation may take awhile. You can click Refresh to see the progress.
  6. When installation is successful, the Status will show a green checkmark:

  7. After installation is successful, from NetSuite's top menu bar, navigate to Setup > Users/Roles > Manage Roles. (Do not click New or Search).

  8. On the Manage Roles page, on the row for the Custom Administrator role, click Edit.
  9. Navigate to the Permissions tab > Setup subtab to review the permissions granted for the role and make any edits if necessary. At a minimum, add permissions for Access Token ManagementUser Access Tokens, and Web Services.

Add a New Role

An alternative to using the customization bundle is to add a new role and permissions individually. Before doing this, you should know which record types you are using in your Harmony integration, including any custom records, fields, or lists, so that you are able to add the appropriate permissions.

To add a new role:

  1. From NetSuite's top menu bar, navigate to Setup > Users/Roles > Manage Roles > New.
  2. On the Role screen, fill out these fields:
    1. Enter a Name, such as "Jitterbit TBA."
    2. Select the desired Center Type. This selection depends on what actions you will be taking. If you don't know which one to select, you can keep the default selection as Accounting Center.
    3. Near the bottom of the Role screen, navigate to the Permissions tab > Setup subtab. Use the Permission dropdown to select each type of record that you will need access to in Jitterbit Harmony and click Add one at a time. At a minimum, add permissions for:
      • Access Token Management
      • User Access Tokens
      • Web Services
      You may also want to add custom fields. For example:
      • Custom Body Fields
      • Custom Column Fields
      • Custom Entity Fields
      • Custom Event Fields
      • Custom Fields
      • Custom Item Fields
      • Custom Item Number Fields
      • Custom Lists
      • Custom Record Types
      • Custom Transaction Fields
      • Other Custom Fields
      • Other Lists
    4. Navigate to the Permissions tab > Lists subtab. Use the Permission dropdown to select each type of custom list that you will need access to in Jitterbit Harmony. Use the Level dropdown to select Full for each and click Add one at a time. For example:
      • Employees
      • Customers
    5. Click Save.

Add a New User to Role

To add a new user:

  1. From NetSuite's top menu bar, navigate to Lists > Employees > Employees > New.
  2. On the Employee screen, fill out these fields:
    1. Under Primary Information, enter a Name, such as "Jitterbit" for the first name and "TBA" for the last name.
    2. Under Email | Phone | Address, provide an Email.
    3. In the Access section, select Give Access and set the Password and Confirm Password.
    4. In the Access section under Roles, use the Role dropdown to select the role you created above. Then click Add.
    5. Click Save.

Gathering Values for Jitterbit Harmony

After TBA is enabled and you know which role and user you are using in Jitterbit Harmony, you can gather the values needed for configuring the NetSuite connection in Harmony.

Consumer Key and Consumer Secret

  1. Log in to the NetSuite instance.
  2. From the top menu bar, navigate to Setup > Integration > Manage Integrations > New.
  3. On the Integration screen, fill out these fields:
    1. Enter a Name, such as "Jitterbit TBA."
    2. From the State dropdown, select Enabled.
    3. Under the Authentication tab, select Token-Based Authentication.

      NOTE: The selection for User Credentials is used only if you want the user to also be able to log in with standard username/password authentication.
    4. Click Save.
  4. A confirmation message will be displayed, along with values for the following fields that you will need later when configuring TBA in Jitterbit Harmony.

    CAUTION: Be sure to copy or save these values, as you will not be able to return to this screen.
    • Application ID: Save this value.
    • Consumer Key: Save this value. It will not be displayed again.
    • Consumer Secret: Save this value. It will not be displayed again.

Token ID and Token Secret

  1. Search for "tokens" using the search bar at the top. You should arrive at the page Access Tokens.
  2. Click the button New Access Token.
  3. On the Access Token screen, fill out these fields:
    1. Enter an Application Name such as "Jitterbit TBA."
    2. From the User dropdown, select the user you created above.
    3. From the Role dropdown, select the role you created above.
    4. Make any edits to the Token Name as desired.
    5. Click Save.
  4. A confirmation message will be displayed, along with the values for the following fields that you will need later when configuring TBA in Jitterbit Harmony.

    CAUTION: Be sure to copy or save these values, as you will not be able to return to this screen.
    • Token ID: Save this value.
    • Token Secret: Save this value.

Account ID

  1. From the top menu bar, navigate to Setup > Integration > Web Services Preferences.
  2. On the Web Services Preferences screen, save the value of the Account ID to use later when configuring TBA in Jitterbit Harmony.

NetSuite Functions

A number of NetSuite functions can be used within scripts to provide login and session information and lookups for NetSuite instances, including these:

For details on using these functions and variables, see NetSuite Functions.

On This Page

Search in This Topic

Last updated:  Aug 06, 2019

  • No labels