- Introduction
- Getting Started
- Creating an Account in Hevo
- Subscribing to Hevo via AWS Marketplace
-
Connection Options
- Connecting Through SSH
- Connecting Through Reverse SSH Tunnel
- Connecting Through VPN
- Connecting Through Mongo PrivateLink
- Connecting Through AWS Transit Gateway
- Connecting Through AWS VPC Endpoint
- Connecting Through AWS VPC Peering
- Using Google Account Authentication
- How Hevo Authenticates Sources and Destinations using OAuth
- Reauthorizing an OAuth Account
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Data Ingestion
- Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Deduplicating Data in a Data Warehouse Destination
- Manually Triggering the Loading of Events
- Scheduling Data Load for a Destination
- Loading Events in Batches
- Data Loading Statuses
- Data Spike Alerts
- Name Sanitization
- Table and Column Name Compression
- Parsing Nested JSON Fields in Events
- Pipelines
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
- Working with Pipelines
- Managing Objects in Pipelines
- Pipeline Jobs
-
Transformations
-
Python Code-Based Transformations
- Supported Python Modules and Functions
-
Transformation Methods in the Event Class
- Create an Event
- Retrieve the Event Name
- Rename an Event
- Retrieve the Properties of an Event
- Modify the Properties for an Event
- Fetch the Primary Keys of an Event
- Modify the Primary Keys of an Event
- Fetch the Data Type of a Field
- Check if the Field is a String
- Check if the Field is a Number
- Check if the Field is Boolean
- Check if the Field is a Date
- Check if the Field is a Time Value
- Check if the Field is a Timestamp
-
TimeUtils
- Convert Date String to Required Format
- Convert Date to Required Format
- Convert Datetime String to Required Format
- Convert Epoch Time to a Date
- Convert Epoch Time to a Datetime
- Convert Epoch to Required Format
- Convert Epoch to a Time
- Get Time Difference
- Parse Date String to Date
- Parse Date String to Datetime Format
- Parse Date String to Time
- Utils
- Examples of Python Code-based Transformations
-
Drag and Drop Transformations
- Special Keywords
-
Transformation Blocks and Properties
- Add a Field
- Change Datetime Field Values
- Change Field Values
- Drop Events
- Drop Fields
- Find & Replace
- Flatten JSON
- Format Date to String
- Format Number to String
- Hash Fields
- If-Else
- Mask Fields
- Modify Text Casing
- Parse Date from String
- Parse JSON from String
- Parse Number from String
- Rename Events
- Rename Fields
- Round-off Decimal Fields
- Split Fields
- Examples of Drag and Drop Transformations
- Effect of Transformations on the Destination Table Structure
- Transformation Reference
- Transformation FAQs
-
Python Code-Based Transformations
-
Schema Mapper
- Using Schema Mapper
- Mapping Statuses
- Auto Mapping Event Types
- Manually Mapping Event Types
- Modifying Schema Mapping for Event Types
- Schema Mapper Actions
- Fixing Unmapped Fields
- Resolving Incompatible Schema Mappings
- Resizing String Columns in the Destination
- Schema Mapper Compatibility Table
- Limits on the Number of Destination Columns
- File Log
- Troubleshooting Failed Events in a Pipeline
- Mismatch in Events Count in Source and Destination
- Audit Tables
- Activity Log
-
Pipeline FAQs
- Can multiple Sources connect to one Destination?
- What happens if I re-create a deleted Pipeline?
- Why is there a delay in my Pipeline?
- Can I change the Destination post-Pipeline creation?
- Why is my billable Events high with Delta Timestamp mode?
- Can I drop multiple Destination tables in a Pipeline at once?
- How does Run Now affect scheduled ingestion frequency?
- Will pausing some objects increase the ingestion speed?
- Can I see the historical load progress?
- Why is my Historical Load Progress still at 0%?
- Why is historical data not getting ingested?
- How do I set a field as a primary key?
- How do I ensure that records are loaded only once?
- Events Usage
- Sources
- Free Sources
-
Databases and File Systems
- Data Warehouses
-
Databases
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Elasticsearch
-
MongoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
-
Troubleshooting MongoDB
-
Errors During Pipeline Creation
- Error 1001 - Incorrect credentials
- Error 1005 - Connection timeout
- Error 1006 - Invalid database hostname
- Error 1007 - SSH connection failed
- Error 1008 - Database unreachable
- Error 1011 - Insufficient access
- Error 1028 - Primary/Master host needed for OpLog
- Error 1029 - Version not supported for Change Streams
- SSL 1009 - SSL Connection Failure
- Troubleshooting MongoDB Change Streams Connection
- Troubleshooting MongoDB OpLog Connection
-
Errors During Pipeline Creation
- SQL Server
-
MySQL
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Generic MySQL
- Google Cloud MySQL
- MariaDB MySQL
-
Troubleshooting MySQL
-
Errors During Pipeline Creation
- Error 1003 - Connection to host failed
- Error 1006 - Connection to host failed
- Error 1007 - SSH connection failed
- Error 1011 - Access denied
- Error 1012 - Replication access denied
- Error 1017 - Connection to host failed
- Error 1026 - Failed to connect to database
- Error 1027 - Unsupported BinLog format
- Failed to determine binlog filename/position
- Schema 'xyz' is not tracked via bin logs
- Errors Post-Pipeline Creation
-
Errors During Pipeline Creation
- MySQL FAQs
- Oracle
-
PostgreSQL
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Generic PostgreSQL
- Google Cloud PostgreSQL
- Heroku PostgreSQL
-
Troubleshooting PostgreSQL
-
Errors during Pipeline creation
- Error 1003 - Authentication failure
- Error 1006 - Connection settings errors
- Error 1011 - Access role issue for logical replication
- Error 1012 - Access role issue for logical replication
- Error 1014 - Database does not exist
- Error 1017 - Connection settings errors
- Error 1023 - No pg_hba.conf entry
- Error 1024 - Number of requested standby connections
- Errors Post-Pipeline Creation
-
Errors during Pipeline creation
- PostgreSQL FAQs
- Troubleshooting Database Sources
- File Storage
- Engineering Analytics
- Finance & Accounting Analytics
-
Marketing Analytics
- ActiveCampaign
- AdRoll
- Amazon Ads
- Apple Search Ads
- AppsFlyer
- CleverTap
- Criteo
- Drip
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Freshsales
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- HubSpot
- Instagram Business
- Klaviyo v2
- Lemlist
- LinkedIn Ads
- Mailchimp
- Mailshake
- Marketo
- Microsoft Ads
- Onfleet
- Outbrain
- Pardot
- Pinterest Ads
- Pipedrive
- Recharge
- Segment
- SendGrid Webhook
- SendGrid
- Salesforce Marketing Cloud
- Snapchat Ads
- SurveyMonkey
- Taboola
- TikTok Ads
- Twitter Ads
- Typeform
- YouTube Analytics
- Product Analytics
- Sales & Support Analytics
- Source FAQs
- Destinations
- Familiarizing with the Destinations UI
- Cloud Storage-Based
- Databases
-
Data Warehouses
- Amazon Redshift
- Amazon Redshift Serverless
- Azure Synapse Analytics
- Databricks
- Firebolt
- Google BigQuery
- Hevo Managed Google BigQuery
- Snowflake
-
Destination FAQs
- Can I change the primary key in my Destination table?
- How do I change the data type of table columns?
- Can I change the Destination table name after creating the Pipeline?
- How can I change or delete the Destination table prefix?
- Why does my Destination have deleted Source records?
- How do I filter deleted Events from the Destination?
- Does a data load regenerate deleted Hevo metadata columns?
- How do I filter out specific fields before loading data?
- Transform
- Alerts
- Account Management
- Activate
- Glossary
Releases- Release 2.29.3 (Nov 5-11, 2024)
- Release 2.29.1 (Oct 21-28, 2024)
- Release 2.29 (Sep 30-Oct 22, 2024)
-
2024 Releases
- Release 2.28 (Sep 02-30, 2024)
- Release 2.27 (Aug 05-Sep 02, 2024)
- Release 2.26 (Jul 08-Aug 05, 2024)
- Release 2.25 (Jun 10-Jul 08, 2024)
- Release 2.24 (May 06-Jun 10, 2024)
- Release 2.23 (Apr 08-May 06, 2024)
- Release 2.22 (Mar 11-Apr 08, 2024)
- Release 2.21 (Feb 12-Mar 11, 2024)
- Release 2.20 (Jan 15-Feb 12, 2024)
-
2023 Releases
- Release 2.19 (Dec 04, 2023-Jan 15, 2024)
- Release Version 2.18
- Release Version 2.17
- Release Version 2.16 (with breaking changes)
- Release Version 2.15 (with breaking changes)
- Release Version 2.14
- Release Version 2.13
- Release Version 2.12
- Release Version 2.11
- Release Version 2.10
- Release Version 2.09
- Release Version 2.08
- Release Version 2.07
- Release Version 2.06
-
2022 Releases
- Release Version 2.05
- Release Version 2.04
- Release Version 2.03
- Release Version 2.02
- Release Version 2.01
- Release Version 2.00
- Release Version 1.99
- Release Version 1.98
- Release Version 1.97
- Release Version 1.96
- Release Version 1.95
- Release Version 1.93 & 1.94
- Release Version 1.92
- Release Version 1.91
- Release Version 1.90
- Release Version 1.89
- Release Version 1.88
- Release Version 1.87
- Release Version 1.86
- Release Version 1.84 & 1.85
- Release Version 1.83
- Release Version 1.82
- Release Version 1.81
- Release Version 1.80 (Jan-24-2022)
- Release Version 1.79 (Jan-03-2022)
-
2021 Releases
- Release Version 1.78 (Dec-20-2021)
- Release Version 1.77 (Dec-06-2021)
- Release Version 1.76 (Nov-22-2021)
- Release Version 1.75 (Nov-09-2021)
- Release Version 1.74 (Oct-25-2021)
- Release Version 1.73 (Oct-04-2021)
- Release Version 1.72 (Sep-20-2021)
- Release Version 1.71 (Sep-09-2021)
- Release Version 1.70 (Aug-23-2021)
- Release Version 1.69 (Aug-09-2021)
- Release Version 1.68 (Jul-26-2021)
- Release Version 1.67 (Jul-12-2021)
- Release Version 1.66 (Jun-28-2021)
- Release Version 1.65 (Jun-14-2021)
- Release Version 1.64 (Jun-01-2021)
- Release Version 1.63 (May-19-2021)
- Release Version 1.62 (May-05-2021)
- Release Version 1.61 (Apr-20-2021)
- Release Version 1.60 (Apr-06-2021)
- Release Version 1.59 (Mar-23-2021)
- Release Version 1.58 (Mar-09-2021)
- Release Version 1.57 (Feb-22-2021)
- Release Version 1.56 (Feb-09-2021)
- Release Version 1.55 (Jan-25-2021)
- Release Version 1.54 (Jan-12-2021)
-
2020 Releases
- Release Version 1.53 (Dec-22-2020)
- Release Version 1.52 (Dec-03-2020)
- Release Version 1.51 (Nov-10-2020)
- Release Version 1.50 (Oct-19-2020)
- Release Version 1.49 (Sep-28-2020)
- Release Version 1.48 (Sep-01-2020)
- Release Version 1.47 (Aug-06-2020)
- Release Version 1.46 (Jul-21-2020)
- Release Version 1.45 (Jul-02-2020)
- Release Version 1.44 (Jun-11-2020)
- Release Version 1.43 (May-15-2020)
- Release Version 1.42 (Apr-30-2020)
- Release Version 1.41 (Apr-2020)
- Release Version 1.40 (Mar-2020)
- Release Version 1.39 (Feb-2020)
- Release Version 1.38 (Jan-2020)
- Early Access New
- Upcoming Features
NetSuite SuiteAnalytics
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
-
An active Netsuite account from which data is to be ingested exists.
-
You are logged in as an Admin user to create a role and user for Hevo, and obtain the API credentials.
-
The SuiteAnalytics Connect Service is enabled with access to the Netsuite2.com data source.
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.
-
In the NetSuite home page, in the Settings section, click Set Up SuiteAnalytics Connect.
-
In 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.
-
In 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.
-
In the Integrations page, click New.
-
In 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.
4. Create a role for Hevo and configure permissions
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.
-
In 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.
-
In 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.
-
In the Access Tokens page, click New Access Token.
-
In 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.
-
In 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.
-
In the Select Source Type page, select NetSuite SuiteAnalytics.
-
In 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.
Additional Information
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.
Revision History
Refer to the following table for the list of key updates made to this page:
Date | Release | Description of Change |
---|---|---|
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. |