Skip to main content
The NetSuite SuiteAnalytics Load orchestration component uses NetSuite SuiteAnalytics Connect to retrieve data and load it into a table—this stages the data, so the table is reloaded each time. You can then use transformation components to enrich and manage the data in permanent tables. You do not need to set up a Create Table component when using this component.
This component is only available for use with Hybrid SaaS agents.
If the component requires access to a cloud provider (AWS, Azure, or GCP), it will use the cloud credentials associated with your environment to access resources. To stage data to Azure Blob Storage, the Azure credentials associated with your environment must be assigned the Storage Blob Data Contributor role. For more information, read User assigned with the Storage Blob Data Contributor role.
For Snowflake projects, this component supersedes the NetSuite SuiteAnalytics component, which is no longer available for new pipelines.Existing pipelines with the NetSuite SuiteAnalytics component will continue to work as expected.

​
Uploading NetSuite SuiteAnalytics drivers

Drivers for NetSuite SuiteAnalytics are not natively included in Hybrid SaaS agents, but you can upload them to your agent instance using the process in Uploading external drivers to the agent. The required driver file can be obtained from NetSuite as follows:
  1. Log in to your NetSuite account.
  2. On the homepage of your NetSuite account, under the Settings module, click Set Up SuiteAnalytics Connect.
  3. Select Linux 64-bit from the drop-down.
  4. Click the Download button next to JDBC Driver. This will download a zip file that contains a file called NQjc.jar.
    It is also worth making a note of the following account information on this page, as you will need it to configure the connector properties:
    • Account ID
    • Role ID
  5. Unzip the file and place the driver in the storage location you specified as described in Uploading external drivers to the agent. Do not change the driver file names.

​
Properties

Reference material is provided below for the Connect, Configure, Destination, and Advanced Settings properties.
​
Name
string
required
A human-readable name for the component.

​
Connect

​
Authentication Type
drop-down
required
Select Username & Password or OAuth 2.0 Client Credentials, and add the appropriate credentials to the following fields.Read Troubleshooting, below, for possible issues caused by invalid credentials.
​
Username
string
required
Your NetSuite username. Only required if Authentication Type is Username & Password.
​
Password
drop-down
required
Choose the secret definition that represents your credentials for this connector. Only required if Authentication Type is Username & Password.If you have not already saved your credentials for this connector as a secret definition, click Add secret to create a secret definition representing these credentials. Read Secrets and secret definitions for details about creating a secret definition.
​
Account ID
string
required
The ID of your SuiteAnalytics Connect account. You can find this name in the Account ID field of the SuiteAnalytics Connect driver download page, under Your Configuration.Only required if Authentication Type is Username & Password.
​
Role ID
string
required
The ID of your SuiteAnalytics Connect role. You can find this name in the Role ID field of the SuiteAnalytics Connect driver download page, under Your Configuration.Only required if Authentication Type is Username & Password.
​
Authentication
drop-down
required
Choose your OAuth connection from the drop-down menu.Click Manage to navigate to the OAuth connections list to review OAuth connections and to add new connections. Read OAuth to learn how to create an OAuth connection.Only required if Authentication Type is OAuth 2.0 Client Credentials.Read NetSuite SuiteAnalytics authentication guide, which includes specific steps for acquiring NetSuite SuiteAnalytics credentials.
​
Connection Options
column editor
  • Parameter: A JDBC parameter supported by the database driver. The available parameters are explained in the data model. Manual setup is not usually required, since sensible defaults are assumed.
  • Value: A value for the given parameter.
Click the Text Mode toggle at the bottom of the Connection Options dialog to open a multi-line editor that lets you add items in a single block. For more information, read Text mode.

​
Configure

​
Load Type
drop-down
required
  • Full Load: Select this option to load your entire dataset.
  • Incremental Load: Select this option to only load new and updated records from your dataset.
​
Mode
drop-down
required
  • Basic: This mode will build a query for you using settings from the Data Source, Data Selection, Data Source Filter, Combine Filters, and Row Limit parameters. In most cases, this mode will be sufficient.
  • Advanced: This mode will require you to write an SQL-like query to call data from the service you’re connecting to. The available fields and their descriptions are documented in the data model.
    Advanced mode is currently not supported when Incremental Load is selected.
There are some special pseudo columns that can form part of a query filter, but are not returned as data. This is fully described in the data model.
While the query is exposed in an SQL-like language, the exact semantics can be surprising, for example, filtering on a column can return more data than not filtering on it. This is an impossible scenario with regular SQL.
​
Schema
drop-down
required
Select the NetSuite SuiteAnalytics schema to load data from.
​
SQL Query
code editor
required
This is an SQL-like SELECT query. Treat collections as table names, and fields as columns. Only available in Advanced mode.For more information, read the Snowflake SELECT documentation.
​
Data Source
drop-down
required
Select a single data source to be extracted from the source system and loaded into a table in the destination. The source system defines the data sources available. Use multiple components to load multiple data sources.
​
Data Selection
dual listbox
required
Choose one or more columns to return from the query. The columns available are dependent upon the data source selected. Move columns left-to-right to include in the query.To use grid variables, select the Use Grid Variable checkbox at the bottom of the Data Selection dialog.
​
Data Source Filter
column editor
Define one or more filter conditions that each row of data must meet to be included in the load.
  • Input Column: Select an input column. The available input columns vary depending upon the data source.
  • Qualifier:
    • Is: Compares the column to the value using the comparator.
    • Not: Reverses the effect of the comparison, so “Equals” becomes “Not equals”, “Less than” becomes “Greater than or equal to”, etc.
  • Comparator: Choose a method of comparing the column to the value. Possible comparators include: “Equal to”, “Greater than”, “Less than”, “Greater than or equal to”, “Less than or equal to”, “Like”, “Null”. Not all data sources support all comparators.
  • Value: The value to be compared.
Click the Text Mode toggle at the bottom of the dialog to open a multi-line editor. For more information, read Text mode.
​
Combine Filters
drop-down
The data source filters you have defined can be combined using either And or Or logic. If And, then all filter conditions must be satisfied to load the data row. If Or, then only a single filter condition must be satisfied. The default is And.If you have only one filter, or no filters, this parameter is essentially ignored.
​
Row Limit
integer
Set a numeric value to limit the number of rows that are loaded. The default is an empty field, which will load all rows.
​
High-Water Mark Selection
drop-down
When Incremental Load is selected, select a datetime field from your dataset that is always updated when your data changes, such as dateModified. The connector will record the maximum value of this field each time you run this pipeline. On subsequent runs when Incremental Load is selected, only data with a higher value in this field will be loaded.
If no rows in the source have a higher value than the stored high-water mark, the task will complete with a “task is skipped” message. This is expected behavior, indicating that no new or updated data was found since the last successful run.

​
Destination

​
Destination
drop-down
required
Select the destination for your data. This is either in Snowflake as a table or as files in cloud storage.
  • Snowflake: Load your data into a table in Snowflake. The data must first be staged via Snowflake or a cloud storage solution.
  • Cloud Storage: Load your data directly into files in your preferred cloud storage location. The format of these files can differ between source systems and will not have a file extension so we suggest inspecting the output to determine the format of the data.
​
Warehouse
drop-down
required
The Snowflake warehouse used to run the queries. The special value [Environment Default] uses the warehouse defined in the environment. Read Overview of Warehouses to learn more.
​
Database
drop-down
required
The Snowflake database to access. The special value [Environment Default] uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.
​
Schema
drop-down
required
The Snowflake schema. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
​
Table Name
string
required
The name of the table to be created in your Snowflake database. You can use a Table Input component in a transformation pipeline to access and transform this data after it has been loaded.
​
Load Strategy
drop-down
required
Define what happens if the table name already exists in the specified Snowflake database and schema. Only available when Full Load is selected.
  • Replace: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
  • Truncate and Insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
  • Fail if Exists: If the specified table name already exists, this pipeline will fail to run.
  • Append: If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It’s appended onto the end of the existing data in the table. If the specified table name doesn’t exist, then the table will be created, and your data will be inserted into the table.
​
Primary Keys
dual listbox
Choose one or more columns to be designated as the table’s primary key.When Incremental Load is selected, if a primary key is selected, the loaded data will be merged with your existing data. If no primary key is selected, the loaded data will be appended to your existing data.
​
Clean Staged files
boolean
required
  • Yes: Staged files will be destroyed after data is loaded. This is the default setting.
  • No: Staged files are retained in the staging area after data is loaded.
​
Stage Access Strategy
drop-down
Select the stage access strategy. The strategies available depend on the cloud platform you select in Stage Platform.
  • Credentials: Connects to the external stage (AWS, Azure) using your configured cloud provider credentials. Not available for Google Cloud Storage.
  • Storage Integration: Use a Snowflake storage integration to grant access to Snowflake to read data from and write to a cloud storage location. This will reveal the Storage Integration property, through which you can select any of your existing Snowflake storage integrations.
​
Stage Platform
drop-down
required
Use the drop-down menu to choose where the data is staged before being loaded into your Snowflake table.
  • Amazon S3: Stage your data on an AWS S3 bucket.
  • Snowflake: Stage your data on a Snowflake internal stage.
  • Azure Storage: Stage your data in an Azure Blob Storage container.
  • Google Cloud Storage: Stage your data in a Google Cloud Storage bucket.

​
Advanced Settings

​
Parse 'Null' & Empty Strings as NULL
boolean
required
Converts common strings that represent null into a null value. This is case-sensitive and works with the following strings: "", “NULL”, “NUL”, “Null”, “null”. The default is No.
Currently, this property is only applicable when using Snowflake as your destination.
​
Trim String Columns
boolean
required
When Yes, remove leading and trailing characters from a string column. The default is No.

​
Troubleshooting

​
Validation failed

You may receive the following error when validating this component: NetSuite Input Connector failed to validate: Internal network error, connection closed. This error is typically caused by invalid credentials. Check your NetSuite SuiteAnalytics credentials (either Username/password or OAuth), and correct if necessary.