Access Token for NetSuite

Configure an access token to connect to NetSuite.

Figure: NetSuite Access Token Configuration screen

NetSuite Access Token Configuration screen

Background and Setup

Examples

Prerequisites

  • One of these account types:
    • NetSuite Limited Edition
    • NetSuite Mid-Market Edition
    • NetSuite Enterprise Edition

Good to Know

  • In most cases, you can use a global access token or an app level access token:
    • Global access tokens are shared across all users and apps. If you want all process designers and runtime app users in your AgilePoint NX tenant to be able to connect to an external data source, use a global access token. An example is a SharePoint site on an intranet that all employees in a company can access.
    • Application level access tokens are shared with all processes in a process-based app, or restricted to use within a form-based app. Use application level access tokens if only process designers or runtime app users for a particular application should access an external system — for example, a Box account that is only used to share files within a small team.
  • Access tokens are collections of credentials that are used to authenticate communication directly between AgilePoint NX and an external system. Because it is the AgilePoint NX system that uses these credentials, rather than an app, there is no difference between design time and runtime access tokens. Access tokens are never checked in or published, and they do not use version control. If you change an access token in the App Builder or Manage Center, the access token changes immediately everywhere the access token is used. Changes to app level access tokens apply to all versions of an app, including running application instances. Changes to global access tokens apply everywhere they are used in AgilePoint NX. You can not roll back an access token to a previous version.

    For more information, refer to What Data Is Deleted When I Delete an App or Application Resource?

  • OAuth 2.0 access tokens require a 2-way exchange of credentials between AgilePoint NX and the external service. This means that you must get the credentials from the third-party service to paste in the AgilePoint NX access token, and get the redirect URI from AgilePoint NX to paste in the external service. This requires you to open both the AgilePoint NX access token and the third-party service at the same time, so you can copy and paste from one screen to the other.

    This topic shows the suggested procedure for NetSuite. The exact procedure for your access token depends on whether you already have a connection (usually called an app) configured in the external service.

    How To Get the Access Token Credentials from NetSuite.

  • This screen may look different in different places. The UI varies for this screen depending upon how you open it. However, the fields for this screen are the same in all places.
  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Fields

Field NameDefinition

Token Name
Function:
Specifies the unique name for your connection to NetSuite.
Accepted Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description
Function:
A description for your access token.
Accepted Values:
More than one line of text.
Default Value:
None
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Environment
Function:
Specifies if your environment is for development or production.
Accepted Values:
  • Production - The environment uses to contain the production data.
  • Sandbox - The environment uses to create and test your apps.
Default Value:
Production
Example:
Refer to:

Authentication Types
Function:
Specifies the authentication type for NetSuite.
Accepted Values:
  • User Credentials - Uses user credentials authentication to connect to NetSuite.

    This authentication type is not recommended. Refer to the Limitations.

  • Token-Based Authentication - Uses token-based authentication to connect to NetSuite.
Default Value:
User Credentials
Example:
Refer to:
Limitations:
  • AgilePoint recommends you use token-based authentication. User credentials authentication is planned for deprecation from NetSuite.

User Name
Function:
Specifies the user name for NetSuite authentication.
To Open this Field:
  1. On the NetSuite Access Token screen, click User Credentials.
Accepted Values:
The user name for your NetSuite environment.
Default Value:
None
Accepts Process Data Variables:
No
Limitations:
  • AgilePoint recommends you use token-based authentication. User credentials authentication is planned for deprecation from NetSuite.

Password
Function:
The password for the authentication account.
To Open this Field:
  1. On the NetSuite Access Token screen, click User Credentials.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Process Data Variables:
No
Limitations:
  • AgilePoint recommends you use token-based authentication. User credentials authentication is planned for deprecation from NetSuite.

Account ID
Function:
Specifies an account ID from NetSuite.
To Open this Field:
  1. On the NetSuite Access Token screen, click User Credentials or Token Based Authentication.
Accepted Values:
One line of text (a string) that can have letters and numbers, and can not have spaces or special characters.
Default Value:
None
Example:
KMDTSU1590549

Refer to:

Limitations:

Role ID
Function:
Specifies the role ID from NetSuite.
To Open this Field:
  1. On the NetSuite Access Token screen, click User Credentials.
Accepted Values:
An integer.
Default Value:
None
Accepts Process Data Variables:
No
Limitations:

Application ID
Function:
Specifies an application ID from NetSuite.
To Open this Field:
  1. On the NetSuite Access Token screen, click User Credentials.
Accepted Values:
One line of text (a string) that can have letters and numbers, and can not have spaces or special characters.
Default Value:
None
Example:
2B5K28DM-L349-4641-5N77-947FB7062853
Limitations:
  • AgilePoint recommends you use token-based authentication. User credentials authentication is planned for deprecation from NetSuite.

Consumer Key
Function:
Specifies the Consumer Key of the app you created or added in NetSuite.
To Open this Field:
  1. On the NetSuite Access Token screen, click Token Based Authentication.
Accepted Values:
A consumer key from NetSuite.
Default Value:
None
Example:
Refer to:
Limitations:

This field is available in these releases:

Consumer Secret
Function:
Specifies the Consumer Secret of the app you created or added in NetSuite.
To Open this Field:
  1. On the NetSuite Access Token screen, click Token Based Authentication.
Accepted Values:
A consumer secret from NetSuite.
Default Value:
None
Example:
Refer to:
Limitations:

This field is available in these releases:

Token ID
Function:
Specifies the Token ID of the app you created or added in NetSuite.
To Open this Field:
  1. On the NetSuite Access Token screen, click Token Based Authentication.
Accepted Values:
A token ID from NetSuite.
Default Value:
None
Example:
Refer to:
Limitations:

This field is available in these releases:

Token Secret
Function:
Specifies the token secret of the app you created or added in NetSuite.
To Open this Field:
  1. On the NetSuite Access Token screen, click Token Based Authentication.
Accepted Values:
A token secret from NetSuite.
Default Value:
None
Example:
Refer to:
Limitations:

This field is available in these releases:

Test Connection
Function:
Makes sure the specified NetSuite account is correct.
Example:
Refer to:

Encrypt
Function:
Stores the access token in the AgilePoint database as encrypted data.
Note: AgilePoint recommends you to store this access token in the database in encrypted format.
Accepted Values:
  • Deselected - The access token is in plain text in the database.
  • Selected - The access token is encrypted in the database.
Default Value:
Selected
Limitations:
  • This field was removed from the UI in AgilePoint NX OnPremises and Private Cloud v7.0 Software Update 2. Access token credentials are encrypted by default. If you want to store credentials in unencrypted format, contact AgilePoint Customer Support.