2022

Page tree
Skip to end of metadata
Go to start of metadata

Introduction

This page summarizes how to enable token-based authentication (TBA) in NetSuite and obtain the values needed for configuring DBSync NetSuite connector to authenticate with NetSuite user login.

Note: If you are using username/password authentication or two-factor authentication (2FA or TFA) in  NetSuite, change the configuration to TBA to ensure the netsuite connector is validated.

There are 3 options to configure/setup the authentication for TBA in NetSuite

  • TBA for Existing Role / Existing User
  • TBA for New Role / Existing User
  • TBA for New Role / New User

Option 1: TBA for Existing Role / Existing User

This involves enabling TBA on the role used by your existing NetSuite user account that is used to configure within DBSync. This is the recommended approach, except in cases where your existing NetSuite account used for  DBSync is assigned an Administrator role (if you are using an Administrator role, we recommend creating a new role with Options 2 or 3). With Option 1, follow these steps on this page:

  1. Enable Token-Based Authentication (TBA

  2. Collect keys for Configuring TBA in DBSync NS Connector

Option 2: TBA for New Role / Existing User

Involves creating a new TBA-enabled role and assigning it to your existing NetSuite account in DBSync. This is an alternative to Option 1 if you do not want to enable TBA on an existing role held by the existing NetSuite user configured within DBSync. With Option 2, follow these steps on this page:

  1. Enable Token-Based Authentication (TBA)

  2. Create a New Role

  3. Assign a Role Create a New Role To an Existing User

  4. Collect keys for Configuring TBA in DBSync NS Connector


Option 3: TBA for New Role / New User

Option 3 involves creating a new TBA-enabled role and a new NetSuite user account to be used by DBSync. This is an alternative if neither Option 1 or Option 2 is possible or desired. With Option 3, follow these steps on this page:

  1. Enable Token-Based Authentication (TBA)

  2. Create a New Role

  3. Add a New User to Role

  4. Collect keys for Configuring TBA in DBSync NS Connector


Enable Token-Based Authentication (TBA)

Enabling TBA for NetSuite is the first step, and is applicable to all options (Options 1, 2, and 3). This is done at the organization level.

  • Log in to your NetSuite Org / instance.
  • From the menu bar at the top, navigate to 

Setup > Company > Enable Features.

On the Enable Features screen, go to SuiteCloud tab.

  • Under the SuiteScript section, select Client SuiteScript and Server SuiteScript.
  • Under the Manage Authentication section, select Token-Based Authentication.
  • Click Save when done

Enable Token-Based Authentication (TBA)

Enabling TBA for NetSuite is the first step, and is applicable to all options (Options 1, 2, and 3). This is done at the organization level.

  1. Log in to your NetSuite Org / instance.

  2. From the menu bar at the top, navigate to 

Setup > Company > Enable Features.

  1. On the Enable Features screen, go to 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 when done

Create a New Role

This step is applicable only for Options 2 and 3. If you are using Option 1, you can skip this step, as you will be using your existing role assigned to the DBSync NetSuite user.

Add a New Role

To add a new role and permissions individually. Before doing this, you should know which record types you are using in your DBSync 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 "DBSync_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 the 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 DBSync and click Add one at a time. At a minimum, add permissions for:

      • Access Token Management

      • User Access Tokens

      • Web Services

    4. 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

    5. 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 DBSync. Use the Level dropdown to select Full for each and click Add one at a time. For example:

      • Employees

      • Customers

    6. Click Save when done.

Add a New User to Role

This step is applicable only for Option 3. If you are using Options 1 or 2, you can skip this step, as you will be using your existing NetSuite user that you are currently using in DBSync.

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 "DBSync" 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.

Assign a Role to an Existing User

This step is applicable only for Option 2. If you are using Option 1, you can skip this step, as you will be using your existing role assigned to the DBSync NetSuite user. If you are using Option 3, you should have already assigned the role when you created the new user, as described above.

To assign a role to an existing user:

  1. From NetSuite's top menu bar, navigate to Lists > Employees > Employees.

  2. On the Employees page, on the row for the user you are currently using for your DBSync integration, click Edit.

  3. On the Employee page, in the Access section under Roles, use the Role dropdown to select the role you created above. Then click Add.

  4. Click Save.

Collect Keys for Configuring TBA in DBSync NS Connector

After TBA is enabled and you know which role and user you are using in DBSync, you can gather the values needed for configuring TBA in DBSync. This is required for all options (Options 1, 2, and 3).

Consumer Key and Consumer Secret

  1. From the top menu bar, navigate to Setup > Integration > Manage Integrations > New.

  2. On the Integration screen, fill out these fields:

    • Enter a Name, such as "DBSync_TBA."

    • From the State dropdown, select Enabled.

    • Under the Authentication tab, select Token-Based Authentication.

    • Click Save.

  3. A confirmation message will be displayed, along with values for the following fields that you will need later when configuring TBA in DBSync NS Connector.
    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 or Setup > Users/Role > Access Tokens.

  2. Click the button New Access Token.

  3. On the Access Token screen, fill out these fields:

    • Enter an Application Name such as "DBSync_TBA."

    • From the User dropdown, select the user you created above.

    • From the Role dropdown, select the role you created above.

    • Make any edits to the Token Name as desired.

    • 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 DBSync NS Connector.
    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 DBSync.

DBSync NetSuite Connector Properties :

Based on the new NetSuite’s authentication update in DBSync’s connector it required only 6 parameters as shown in above screenshot:

  1. UserName - EmailId of the NetSuite username

  2. AccountId - NetSuite Company Id

  3. Client Id - CONSUMER KEY / CLIENT ID from the Integration setup

  4. Client Secret - CONSUMER SECRET / CLIENT SECRET from the Integration setup

  5. TBA Access Token - TOKEN ID from the Access Token page

  6. TBA Access Token Secret - TOKEN SECRET from the Access Token page

  • No labels