The NetSuite SuiteAnalytics connector differs from our other NetSuite (Oracle NetSuite) connector in that the NetSuite (Oracle NetSuite) connector uses the NetSuite REST API based web services and requires you to deploy an integration application in your NetSuite instance on your own behalf.
There are differences in the NetSuite REST API web services connection so we recommend incorporating both connectors for your production instance especially during a migration or integration effort so that you can assertain what data from your NetSuite instance you are able to attain in your pipeline(s).
This NetSuite SuiteAnalytics connector is focused on using the NetSuite2.com connectivity feature of NetSuite, which has also become known as the analytics data source, or SuiteAnalytics Connect. If your NetSuite instance currently only supports the older NetSuite.com option we highly suggest you work with your NetSuite success team to switch to the newer version since the older version 2018.2 will not receive any new development as of October 2021.
Pre-Requisites for NetSuite SuiteAnalytics Connector:
- A NetSuite SuiteAnalytics license
- NetSuite Administrator access to setup the integration
- Tokens and Keys from the integration
- Ability to assign the Data Warehouse Integrator (DWI) role
- Set your Service Data Source connection attribute to NetSuite2.com
Below are the setup instructions for this connector broken into sections with ordered steps for ease of navigation and follow along details.
- Access your NetSuite account by logging in to the NetSuite portal
- Click the home icon, or view the left menu for Settings and click the Set up SuiteAnalytics Connect option
- View the details under the Your Configuration area to see the service Service Host, Service Port, and Account Id values and write them down for later retrieval
- Begin configuring the NetSuite2.com data source by clicking Setup from the main header menu and click on the path Setup > Company > Enable Features in order to access the SuiteAnalytics enablement area.
- Click on the SuiteCloud tab
- Check the box for Client SuiteScript in the SuiteScript section
- Click on I Agree to accept the terms of service that opens
- Check the Server SuiteScript option in the SuiteScript section
- Click on I Agree to accept the terms of service that opens
- (Optional) If using the DLH.io standard NetSuite (Oracle NetSuite) connector you will also check the checkbox for OAUTH 2.0, which allows different entities to be retrieved (Optional for this connector)
- Click the Save button which is visibile when you scroll to the bottom of the page.
- Navigate to create a new integration by accessing the main header and selecting Setup > Integration > Manage Integrations > New
- In the create new integration page you will need to update the following items by updating the following form fields with the values:
- Name = DataLakeHouse.io Integration
- Description = Integrate DLH.io with NetSuite
- State = Enabled
- Token-Based Authentication = Check the checkbox to enable this option All other Token-based Authentication area and OAuth 2.0 checkboxes should be unchecked
- Click the Save button to save the integration The Client Credentials area will appear above the Save button area and underneath the User Credentials section. Please copy these as they will be used in your connection settings for DLH.io NOTE: These keys, and secrets will not be visible once you leave this page. So, please copy them somewhere to be safely stored and used when creating the connector.
A new role is highly recommended to be created in order to assign the necessary permissions for SuiteAnalytics. With NetSuite2.com source connectivity a new role called Data Warehouse Integration (DWI) is available, and we recommend also creating a new role which will be specific to the DataLakeHouse.io and NetSuite integration.
- Navigate to Setup > Users/Roles > Manage Roles > New
- In the name field, enter a unique name for the role, ex: DLH_NS_ROLE
- Scroll down the page to find the Permissions tab
- Click the Setup sub-tab
- From the permissions dropdown select the following and click the Add button to add these permissions:
- Log in Using Access Tokens
- SuiteAnalytics Connect
- Click the Save button to save the new role you created
- Next, we need to specify which user will connect to SuiteAnalytics when configured in DLH.io, so navigate to Setup > Users/Roles > Manage Users
- Click the name of the user which you've identified to be the user profile that will connect to NetSuite SuiteAnalytics
- In the resulting page click the Edit button
- Scroll down to the bottom and click on the Access sub-tab
- Click the Roles sub-tab
- From the dropdown select the Data Warehouse Integrator role
- Click Add
- Click the Save button to save the changes for the user
The role Data Warehouse Integrator is required when connecting to SuiteAnalytics. This role id differs across all NetSuite account, so find yours using the following steps and save it for when you create the connector in DLH.io.
- Access the roles are by navigating to Setup > User/Roles > Manage Roles
- Locate the Internal ID for the Data Warehouse Integrator role by view the Internal ID column for the Data Warehouse Integrator role from the list
NB: If you do not see the Internal ID column in the roles table list, then you must click on the Customize View option then in the resulting page find the Intenral Id field in the field dropdown and click Add then click save to add it to the role search list. You may need to give the custom view unique name in order to save.
- Take note of this value and save it for when configuring your NetSuite SuiteAnalytics connector in DLH.io
The access token is used in combination with the consumer key and secret from when you created the integration in a prior step. A token id and token secret will be generated in the following steps prior to you being able to successfully configure the DLH.io integration to your NetSuite SuiteAnalytics instance.
- Log in with either a user having the Administrator (not System Administrator) or the Access Token Management permission via Setup > Users/Roles > Access Tokens > New
- Choose the Application Name from the dropdown, for example, DataLakeHouse.io Integration
- Select the User that was assigned the DWI role
- Select the Data Warehouse Integrator option from the Role menu
- Enter in the Token Name field, DLH_INTEGRATION_NON_SVC_ACCT
- We use this term so that administrators understand that this token authorization is associated with a user and is usually not a service account. If you are using a service account users specifically for the integration then you can leave this field blank.
- Click the Save button NOTE: Immediately take note of the Token ID and Token Secret shown as they will not be displayed once you leave the page
- Get ready to enter the information from this step and any captured above into the DLH.io NetSuite SuiteAnalytics connector to integrate the two systems.
Now that you have completed the setup steps in NetSuite for the integrator and the SuiteAnalytics configuration, etc. you should have all the information required to create the DLH.io connector that points to your NetSuite SuiteAnalytics account. Conduct the following steps:
- Navigate to DLH.io and your account
- Click on the Source connector and select the NetSuite SuiteAnalytics source connector
- Enter the unique Name/Alias for this connection
- Enter the Target Schema name that will be created in your Cloud Data Warehouse destination target
- Enter in the Account ID (this is just the numbers at the start of your NetSuite account URL, not the entire URL string)
- Enter the Port number found in the previous configuration section (Default: 1708)
- Enter the Consumer Key
- Enter the Consumer Secret
- Enter the Token Id
- Enter the Token Secret
- Enter the Role Id
- Leave Allow Non-PK Tables as Yes (default) unless otherwise instructed by support
- Click Save & Test to save the connector.
- At this point DLH.io will attempt to reach your SuiteAnalytics account instance and confirm connection success. The synchronization will be available to start once you create or confirm your destination target and Create a Sync Bridge
This section provides information on how data is replicated, at what frequency and which replication/synchronization details are worth noting from DLH.io.
Replication Frequency Configurations
Default Replication Frequency
1 Hour (lower on Business Critical plan)
The following types of replication happen between this source and your target destination cloud data warehouse of choice when a Sync Bridge runs:
- Historical Data Load (also First Time Sync)
- Occurs during the first/initial data sync of the sync bridge pipeline and any time you need to or are requested to conduct a historical re-sync process for your data.
- Here, DLH.io ingests all available data for the objects/tables you've selected or are available to you from the source based on your authentication access on that source.
- This can take a relative elongated time to retrieve all data from the source and replicated to the target, as the name suggest it is retrieval all data, so if the source contains large amounts of data even in our parallel processing capability a customer could expect more than an hour for large data system. If there are any concerns that a historical load or first time sync has not completed within a reasonable amount of time please contact DLH.io Support.
- Incremental (aka Deltas) Data Load
- After a first time synchronization/replication or a historical data load, all subsequent processes of replicating the data for a Sync Bridge (source to target) are referred to as delta or incremental loads
- Here, DLH.io captures the latest/newest records and/or events and any changes/updates to existing records and/or events in the source connector based on the frequency set in the Sync Bridge.
None at this time.