NetSuite SuiteAnalytics Connect

This connector captures data from Oracle NetSuite into Flow collections. It relies on the SuiteAnalytics Connect feature in order to both load large amounts of data quickly, as well as introspect the available tables, their schemas, keys, and cursor fields.

If you don't have SuiteAnalytics Connect, check out our SuiteTalk REST connector.

Supported data resources

Flow discovers all of the tables to which you grant access during setup, including Transactions, Reports, Lists, and Setup.

Prerequisites

Oracle NetSuite account
Allowed access to all Account permissions options
A new integration with token-based authentication
A custom role with access to objects you want to capture. See setup.
A new user assigned to the custom role
Access token generated for the custom role

Setup

Create a NetSuite account

Create an account on the Oracle NetSuite portal.
Confirm your email address.

Set up your NetSuite account

Find your Realm, or Account ID. You'll use this to connect with Flow.
1. In your NetSuite portal, go to Setup > Company > Company Information.
2. Copy your Account ID.
  
  If you have a production account, it will look like 2345678. If you're using a sandbox, it'll look like 2345678_SB2.
Create a NetSuite integration to obtain a Consumer Key and Consumer Secret.
1. Navigate to Setup > Integration > Manage Integrations > New.
2. Give the integration a name, for example, estuary-rest-integration.
3. Make sure the State option is enabled.
4. In the Authentication section, check the Token-Based Authentication checkbox.
5. Save your changes.
Your Consumer Key and Consumer Secret will be shown once. Copy them to a safe place.
Set up a role for use with Flow.
1. Go to Setup > Users/Roles > Manage Roles > New.
2. Give the role a name, for example, estuary-integration-role.
3. Scroll to the Permissions section.
4. (IMPORTANT) Click Transactions and add all the dropdown entities with either full or view access level.
5. (IMPORTANT) Click Reports and add all the dropdown entities with either full or view access level.
6. (IMPORTANT) Click Lists and add all the dropdown entities with either full or view access level.
7. (IMPORTANT) Click Setup an add all the dropdown entities with either full or view access level.
To allow your custom role to reflect future changes, be sure to edit these parameters again when you rename or customize any NetSuite object.
Set up user for use with Flow.
1. Go to Setup > Users/Roles > Manage Users.
2. Find the user you want to give access to use with Flow. In the Name column, click the user's name. Then, click the Edit button.
3. Find the Access tab.
4. From the dropdown list, select role you created previously; for example, estuary-integration-role.
5. Save your changes.
Generate an access token.
1. Go to Setup > Users/Roles > Access Tokens > New.
2. Select an Application Name.
3. Under User, select the user you assigned the role previously.
4. Under Role, select the role you assigned to the user previously.
5. Under Token Name, give a descriptive name to the token you are creating, for example estuary-rest-integration-token.
6. Save your changes.
Your Token ID and Token Secret will be shown once. Copy them to a safe place.

You now have a properly configured account with the correct permissions and all the information you need to connect with Flow:

Realm (Account ID)
Consumer Key
Consumer Secret
Token ID
Token Secret

info

You can also authenticate with a username and password, but a consumer/token is recommended for security.

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the NetSuite source connector.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
`/account	Netsuite Account ID	Netsuite realm/Account ID e.g. 2344535, as for `production` or 2344535_SB1, as for the `sandbox`	string	Required
`/role_id`	Role ID	The ID of the role you created. Defaults to 3, which is the ID of the administrator role.	int	3
`/suiteanalytics_data_source`	Data Source	Which NetSuite data source to use. Options are `NetSuite.com`, or `NetSuite2.com`	string	Required
`/authentication`	Authentication Details	Credentials to access your NetSuite account	object	Required

Token/Consumer Authentication

Property	Title	Description	Type	Required/Default
`/authentication/consumer_key`	Consumer Key	Consumer key associated with your integration.	string	Required
`/authentication/consumer_secret`	Consumer Secret	Consumer secret associated with your integration.	string	Required
`/authentication/token_key`	Token Key	Access token key	string	Required
`/authentication/token_secret`	Token Secret	Access token secret	string	Required

Username/Password Authentication

Property	Title	Description	Type	Required/Default
`/authentication/username`	Username	Your NetSuite account's email/username	string	Required
`/authentication/password`	Password	Your NetSuite account's password.	string	Required

Advanced Config options

Property	Title	Description	Type	Required/Default
`/advanced/connection_limit`	Connection Limit	The maximum number of concurrent data streams to attempt at once.	int	10 Connections
`/advanced/task_limit`	Task Limit	The maximum number of concurrent tasks to run at once. A task is either a backfill or incremental load. Backfills can load multiple chunks in parallel, so this must be strictly <= `/advanced/connection_limit`	int	5 Tasks
`/advanced/start_date`	Start Date	The date that we should attempt to start backfilling from. If not provided, backfill from the beginning.	date	Not Required

Bindings

Property	Title	Description	Type	Required/Default
`/name`	Name	The name of the table this binding refers to	string	Required
`/interval`	Interval	How frequently to check for incremental changes	`ISO8601` Duration	`PT1H` (1 Hour)
`/log_cursor`	Log Cursor	A date-time column to use for incremental capture of modifications.	String	Required (Automatically Discovered)
`/page_cursor`	Page Cursor	An indexed, non-NULL integer column to use for ordered table backfills. Does not need to be unique, but should have high cardinality.	String	Required (Automatically Discovered)
`/concurrency`	Concurrency	Maximum number of concurrent connections to use for backfilling.	int	1 Connection
`/query_limit`	Query Limit	Maximum number of rows to fetch in a query. Will be divided between all connections if `/concurrency` > 1	int	100,000 Rows
`/query_timeout`	Query Timeout	Timeout for queries. Typically left as the default as some tables just take a very long time to respond.	`ISO8601` Duration	`PT10M` (10 Minutes)
`/associations`	Associations	List of associated tables for which related data should be loaded.	Array[TableAssociation]	[]
`/associations/[n]/child_table_name`	Foreign Table Name	The name of the "foreign" table that should be associated with the "parent" binding containing this association	String	Required
`/associations/[n]/parent_join_column_name`	Parent Join Column	The name of the column on the "parent" table to be used as the join key	String	Required
`/associations/[n]/child_join_column_name`	Foreign Join Column	The name of the column on the "foreign" table to be used as the join key	String	Required
`/associations/[n]/load_during_backfill`	Load During Backfill	Whether or not to load associated documents during backfill	Boolean	False
`/associations/[n]/load_during_incremental`	Load During Incremental	Whether or not to load associated documents during incremental loads	Boolean	True

Sample

captures:
   ${PREFIX}/${CAPTURE_NAME}:
      endpoint:
         connector:
            image: ghcr.io/estuary/source-netsuite-v2:v3
               config:
                  account: "12345678"
                  authentication:
                     auth_type: token
                     consumer_key: xxx
                     consumer_secret_sops: xxx
                     token_id: xxx
                     token_secret_sops: xxx
                  connection_type: suiteanalytics
                  role_id: 3
                  suiteanalytics_data_source: NetSuite2.com
                  advanced:
                     connection_limit: 20
                     cursor_fields: []
                     enable_auto_cursor: false
                     resource_tracing: false
                     start_date: null
                     task_limit: 10
      bindings:
         - resource:
            associations:
               -  child_join_column_name: transaction
                  child_table_name: TransactionAccountingLine
                  parent_join_column_name: id
                  load_during_backfill: false
                  load_during_incremental: true
            interval: PT5M
            name: transaction
            page_cursor: id
            query_limit: 100000
            concurrency: 1
            query_timeout: PT10M
            log_cursor: lastmodifieddate
         target: ${PREFIX}/${CAPTURE_NAME}/transaction
    {...}

NetSuite SuiteAnalytics Connect

Supported data resources​

Prerequisites​

Setup​

Configuration​

Properties​

Endpoint​

Token/Consumer Authentication​

Username/Password Authentication​

Advanced Config options​

Bindings​

Sample​