NetSuite SuiteAnalytics is a powerful business intelligence and analytics toolset available within the NetSuite. It is designed to provide users with real-time access to their data and help them make informed business decisions based on insights gathered from that data. SuiteAnalytics includes a variety of features and tools, such as customizable dashboards, reporting and analysis tools, and data exploration capabilities. It allows you to create and view reports, analyze data using a range of metrics, and share insights with others.
Hevo uses the SuiteAnalytics Connect Service to replicate your SuiteAnalytics data and load it to the desired Destination for scalable analysis.
Prerequisites
Obtaining the API Credentials
Hevo uses the Service Host and Port, and Account ID to establish a connection with the SuiteAnalytics Connect service, which enables Hevo to ingest data from NetSuite. To authenticate Hevo on your NetSuite account, various credentials are required, including the Consumer Key and Secret, the Data Warehouse Integrator Role ID, and the Token ID and Secret.
Note: You must log in as an Admin user to perform these steps.
To obtain these credentials, perform the following steps:
1. Obtain your Service Host, Port, and Account ID
Perform the following steps to obtain your SuiteAnalytics Connect credentials:
-
Log in to your NetSuite account.
-
On the NetSuite home page, in the Settings section, click Set Up SuiteAnalytics Connect.
-
On the SuiteAnalytics Connect Driver Download page, from the Your Configuration section, copy the SERVICE HOST, SERVICE PORT, and ACCOUNT ID, and save them securely like any other password.
You can use these credentials while configuring your Hevo Pipeline.
2. Enable web services and token-based authentication
Perform the following steps to generate the access token to authenticate Hevo:
-
Log in to your NetSuite account as an Administrator user.
-
In the NetSuite global search bar, enter page: enable, and select the Page: Enable Features result.
-
On the Enable Features page, click SuiteCloud.
-
In the SuiteCloud tab, SuiteScript section, select the CLIENT SUITESCRIPT check box, and click I Agree in the pop-up dialog displayed.
-
Select the SERVER SUITESCRIPT check box, and click I Agree in the pop-up dialog displayed.
-
In the Manage Authentication section, select the TOKEN-BASED AUTHENTICATION check box, and click I Agree in the pop-up dialog displayed.
-
At the bottom of the page, click Save.
3. Create an integration record for Hevo
An integration record is required to uniquely identify Hevo in your NetSuite account.
-
In the NetSuite global search bar, enter page: integrations, and click the Page: Manage Integrations result.
-
On the Integrations page, click New.
-
On the Integration page, specify the following settings:
-
Name: A unique name for the integration. For example, HEVO.
-
Token-based Authentication: Select this check box to allow Hevo to access your data.
-
Click Save.
-
In the confirmation page that is displayed, from the Consumer key/secret section, copy the consumer key and secret and save them securely like any other password.
You can use these credentials while configuring your Hevo Pipeline.
We recommend that you create a Hevo-specific role and user so that it is easier to assign and manage the permissions required for Hevo to replicate your data.
To do this, perform the following steps:
-
In the NetSuite global search bar, enter Page: New role, and select the Page: New Role result.
-
On the Role page, specify a name for the role in the Name field. For example, HevoRole.
-
In the Permissions tab, click Setup, and do the following:
-
From the drop-down, select Log in using Access Tokens, and click Add.
-
From the drop-down, select SuiteAnalytics Connect, and click Add.
Repeat this step to add permissions according to the data you need to replicate.
-
After permissions for all tabs are added, click Save.
5. Create a Hevo user
-
In the NetSuite global search bar, enter Page: New Employees, and select the Page: New Employees result.
-
On the Employee page, specify the NAME, EMAIL, and SUBSIDIARY.
-
Scroll down and select the Access tab.
-
In the Access tab, do the following:
-
Select the GIVE ACCESS check box.
-
In the Roles section, from the ROLE drop-down, select:
-
The Hevo role that you created in Step 4 above. For example, HevoRole.
-
The system Data Warehouse Integrator role.
-
Click Add.
-
Click Save.
You have successfully created a user for Hevo.
6. Create an access token
Perform the following steps to create an access token for Hevo:
-
In the NetSuite global search bar, enter Page: Access Tokens, and click the Page: Access Tokens result.
-
On the Access Tokens page, click New Access Token.
-
On the Access Token page, specify the following details:
-
APPLICATION NAME: The integration record that you created in Step 3.
-
USER: The Hevo user that you created in Step 5. For example, HevoUser.
-
ROLE: The Hevo role that you created in Step 4. For example, HevoRole.
-
TOKEN NAME: A name for the token. NetSuite creates a name by default, however, you can specify a custom name. For example, HEVO.
-
Click Save.
-
From the confirmation page that is displayed, copy the Token ID and Secret and save them securely like any other password.
You can use these credentials while configuring your Hevo Pipeline.
7. Obtain the data warehouse integrator role ID
-
In the navigation bar at the top of the NetSuite dashboard, click Setup, Users/Roles, and Manage Roles.
-
On the Manage Roles page, copy the INTERNAL ID of the Data Warehouse Integrator role in the role list, and save it securely like any other password. Use this ID while configuring your Hevo Pipeline.
Configuring NetSuite SuiteAnalytics as a Source
Perform the following steps to configure NetSuite SuiteAnalytics as the Source in your Pipeline:
-
Click PIPELINES in the Navigation Bar.
-
Click + CREATE PIPELINE in the Pipelines List View.
-
On the Select Source Type page, select NetSuite SuiteAnalytics.
-
On the Configure your NetSuite SuiteAnalytics Source page, specify the following:
-
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
-
Service Host: The host URL that you obtained in Step 1 above. For example, in https://12345678-sb1.connect.api.netsuite.com, the service host is 12345678-sb1.
-
Server Data Source (Non-editable): The data source that Hevo uses to obtain data from your NetSuite account.
-
Service Port: The port number that you obtained in Step 1 above.
-
Account ID: The unique ID that you obtained in Step 1 above.
-
Consumer Key: The key that you obtained upon creating the integration record for Hevo.
-
Consumer Secret: The consumer secret that you obtained from your Netsuite account upon creating the integration record for Hevo.
-
Token ID: The ID of the access token that you created in Step 6 above, to allow Hevo to access your data.
-
Token Secret: The secret for the token that you created in Step 6 above.
-
Role ID: The data warehouse integrator role ID that you obtained from Step 7 above.
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Data Replication
For Teams Created |
Default Ingestion Frequency |
Minimum Ingestion Frequency |
Maximum Ingestion Frequency |
Custom Frequency Range (in Hrs) |
Before Release 2.21 |
3 Hrs |
5 Mins |
24 Hrs |
1-24 |
After Release 2.21 |
6 Hrs |
30 Mins |
24 Hrs |
1-24 |
Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.
-
Historical Data: In the first run of the Pipeline, Hevo ingests all the existing data for the selected objects from your NetSuite SuiteAnalytics account and loads it to the Destination.
-
Incremental Data: Once the historical load is complete, data is ingested as per the ingestion frequency in Full Load or Incremental mode, as applicable.
Data Model
Hevo allows you to ingest most objects from the Analytics Browser of SuiteAnalytics. Read Analytics Browser to view the list of objects available for ingestion.
Read the detailed Hevo documentation for the following related topics:
Source Considerations
None.
Limitations
-
Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
-
Hevo does not load an Event into the Destination table if its size exceeds 128 MB, which may lead to discrepancies between your Source and Destination data. To avoid such a scenario, ensure that each row in your Source objects contains less than 100 MB of data.
Revision History
Refer to the following table for the list of key updates made to this page:
Date |
Release |
Description of Change |
Jan-07-2025 |
NA |
Updated the Limitations section to add information on Event size. |
Mar-05-2024 |
2.21 |
Updated the ingestion frequency table in the Data Replication section. |
Jun-14-2023 |
NA |
Updated section, Data Replication to add information about Hevo ingesting all available historical data. |
Apr-10-2023 |
2.11 |
New document. |