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 further information on this setup.

Setup & Authentication

Overview

The Oracle NetSuite (SuiteTalk REST Web Services) Connector can be installed with the following authentication types:

• OAuth 1.0
• OAuth 2.0 (Authorization Code)

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 NetSuite account.

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

Locate the Account ID

1. From the top navigation bar select Setup > Company > Company Information
2. Make note of the Account ID.

Create a Role

If your customer has not done so already, they will need to create a custom role within their NetSuite account which includes the appropriate permissions to make the desired API calls:

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

Assign Role to User

This is the user your customer should login as when setting up the Connector:

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

Enable Features

Your customer only needs to complete this step if you are using Methods from the RESTlet Method Category on the Connector:

1. From the top navigation bar select Setup > Company > Enable Features.
2. Select the SuiteCloud subtab.
3. In the SuiteScript section, check Client SuiteScript and Server SuiteScript.
4. Scroll to the bottom of the page and select Save.

Your customer can decide whether to use OAuth 1.0 or OAuth 2.0 (Authorization Code) when authenticating a Oracle NetSuite (SuiteTalk REST Web Services) Connector.

Depending on their choice, follow the appropriate section below:

OAuth 1.0

Your customer should first log in to their NetSuite account.

Enable Features

1. From the top navigation bar select Setup > Company > Enable Features.
2. Select the SuiteCloud subtab.
3. In the SuiteTalk (Web Services) section, check REST Web Services.
4. In the Manage Authentication section, check Token-Based Authentication.
5. Scroll to the bottom of the page and select Save.

Create an Integration

1. From the top navigation bar select Setup > Integration > Manage Integrations > New.
2. Enter a name for the integration.
3. Set State to Enabled.
4. From the Authentication section select Token-Based Authentication.
5. Scroll down and select Save.
6. Make a note of the Consumer Key and Consumer Secret.

Create an Access Token

1. From the top navigation bar select Setup > Users/Roles > Access Tokens > New.
2. Enter the Application Name (previously created integration), User and Role.
3. Give the token a name and select Save.
4. Make a note of the Token ID and Token Secret.

OAuth 2.0 (Authorization Code)

Your customer should first log in to their NetSuite account.

Enable Features

1. From the top navigation bar select Setup > Company > Enable Features.
2. Select the SuiteCloud subtab.
3. In the SuiteTalk (Web Services) section, check REST Web Services.
4. Scroll to the bottom of the page and select Save.

Create an Integration

1. From the top navigation bar select Setup > Integration > Manage Integrations > New.
2. Enter a name for the integration.
3. Set State to Enabled.
4. From the Authentication section select Authorization Code Grant.
5. Set the Callback URL to the Callback URL of your Cyclr Partner Console.
6. Set Refresh token validity (in hours) to 720 or less depending on your requirements.
7. Set Maximum time for token rotation (in hours) to 720 or less depending on your requirements.
8. Enable REST Web Services.
9. Scroll down and select Save.
10. Make a note of the Consumer Key and Consumer Secret.

Cyclr Connector Installation

OAuth 1.0

When installing an Oracle NetSuite (SuiteTalk REST Web Services) Connector with the OAuth 1.0 authentication type, the following values are used:

Property	Description
Account ID	The ID of the NetSuite account being accessed.
Date Format	The format that dates are expected in by the NetSuite account.
Consumer Key	The Consumer Key of the integration.
Consumer Secret	The Consumer Secret of the integration.
Token ID	The token ID of the access token to authenticate with.
Token Secret	The token secret of the access token to authenticate with.
Disable Custom Field Look Up?	Whether Cyclr should look up Custom Fields or not.

OAuth 2.0 (Authorization Code)

When installing an Oracle NetSuite (SuiteTalk REST Web Services) Connector with the OAuth 2.0 (Authorization Code) authentication type, the following values are used:

Property	Description
Client ID	The Consumer Key of the integration.
Client Secret	The Consumer Secret of the integration.
Account ID	The ID of the NetSuite account being accessed.
Date Format	The format that dates are expected in by the NetSuite account.
Disable Custom Field Look Up?	Whether Cyclr should look up Custom Fields or not.

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. Select the “Results” subtab.
4. Add the following fields:
   • Detail
   • Token-based Access Token Name
   • Token-based Application Name
5. Select Submit.

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