Oracle NetSuite (SuiteTalk REST Web Services) – Setup

Introduction

This guide takes you through setting up Oracle NetSuite for use with Cyclr, as well as how to install an Oracle NetSuite (SuiteTalk REST Web Services) Connector.

See Oracle’s own documentation for more information on this setup.

Setup & Authentication

Overview

Cyclr Partner setup:

Usually no external setup is required by you, the Cyclr Partner, as configuration and retrieval of any credentials for this Connector are performed by your customer within their system.

As a result, the Client ID and Client Secret fields within your Cyclr Partner Console’s Oracle NetSuite (SuiteTalk REST Web Services) Connector Library entry should be left blank so that they’re displayed each time the Connector is installed and provided by your customer to access their data.

Your customer’s setup:

The details below are typically for your customer to setup within their Oracle NetSuite account.

Remote Setup in Oracle NetSuite – performed by customer

Create an Integration

Firstly log in to your NetSuite account.

  1. From the top navigation bar go to Setup > Integration > Manage Integrations > New
  2. Enter a name for the integration
  3. State should be Enabled
  4. From the Authentication section select Token-Based Authentication
  5. Scroll down and click Save

Make a note of the Consumer Key and Consumer Secret.

Finding Your Account ID

  • From the top navigation bar go to Setup > Company > Company Information

If the NetSuite Account ID contains an underscore character (“_”), replace it with a dash character (“-“) when populating the field during Connector setup.

Enable Features

  1. From the top navigation bar go to Setup > Company > Enable Features
  2. Click the SuiteCloud subtab
  3. In the SuiteScript section check Client SuiteScript and Server SuiteScript
  4. In the SuiteTalk (Web Services) check REST Web Services
  5. In the Manage Authentication section check Token-Based Authentication
  6. Scroll to the bottom of the page and click Save

Create a Role

If you haven’t done so already you will need to create a custom role which includes the appropriate permissions to make the desired API calls.

  1. From the top navigation bar go to Setup > Users/Roles > Manage Roles > New
  2. Give the role a name
  3. For Authentication check Web Services Only Role
  4. From Permissions > Transactions add Find Transaction, Invoice and Sales Order.
    Each with Level: Full
  5. From Permissions > Reports add SuiteAnalytics Workbook
  6. From Permissions > Lists add any/all of the following: Accounts, Contacts, Currency, Customers, Employees, Phonecalls, Projects, Subsidiaries.
    Each with Level: Full
  7. From Permissions > Setup add Access Token Management, User Access Tokens and REST Web Services.
    Each with Level: Full
  8. Scroll to the bottom of the page and click Save

Assign Role to User

  1. From the top navigation bar go to Setup > Users/Roles > Manage Users
  2. Select the user who should be assigned the role
  3. From the user’s profile page navigate to Access > Roles
  4. Add the role created above
  5. Scroll to the bottom of the page and click Save

Create an Access Token

  1. From the top navigation bar go to Setup > Users/Roles > Access Tokens > New
  2. Enter the Application Name (previously created integration), User and Role
  3. Give the token a name and click Save

Make a note of the Token ID and Token Secret.

Cyclr Connector Installation

When installing an Oracle NetSuite (SuiteTalk REST Web Services) Connector, the following values are used:

PropertyDescription
Disable Custom Field Look UpWhether Cyclr should look up Custom Fields or not.
Account IDThe ID of the NetSuite account being accessed.
Consumer KeyThe Consumer Key of the integration.
Consumer SecretThe Consumer Secret.
Token IDThe token ID of the access token to authenticate with.
Token SecretThe token secret of the access token to authenticate with.
Date FormatThe format that dates are expected in by the NetSuite account.

Troubleshooting Authentication Errors

The authentication error messages returned by NetSuite do not always give a full description of the error’s details. To find more information you can view the “Login Audit Trail”:

  1. Go to Setup > Users/Roles > User Management > View Login Audit Trail
  2. Check the Use Advanced Search box
  3. Click the Results subtab
  4. Add the following fields: Detail, Token-based Access Token Name, and Token-based Application Name
  5. Click Submit

The Detail column displays error messages for any token-based authentication logins with a status of Failure.