NetSuite REST SuiteQL

Overview

You can use this Snap to execute SuiteQL queries on NetSuite server.


NetSuite REST SuiteQL Overview

Prerequisites

None.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has at the most one document input view. The input data typically includes the SuiteQL query that you want to execute on your database. The specific format of the input data can vary depending on the design of your pipeline and the data source you are using. In addition to the SuiteQL query, you may also need to provide additional parameters that need to be substituted in the query. Mapper
Output This Snap has at the most one document output view and displays the SuiteQL query resultset. Mapper
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when the Snap encounters an error.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (): Indicates that you can add fields in the field set.
  • Remove icon (): Indicates that you can remove fields from the field set.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: NetSuite REST SuiteQL

Example: Execute employees list
Query String/Expression

Required. Specify a valid SuiteQL query.

Default value: N/A

Example: SELECT * from Employee
Write error on no results Checkbox

Select this checkbox to produce an error when no results are returned in response to the request.

Default status: Deselected
Pagination parameters Specify the pagination parameters to control and manage the amount of data to retrieve from the NetSuite server.
Pages Integer/Expression
Specify the number of pages to read from the NetSuite server.
Note: When the value is set to 0, the Snap reads all pages from the endpoint.

Default value: 0

Example: 10
Page size Integer/Expression

Specify the number of records (per page) to return from the SuiteQL query result set.

Default value: 1000

Example: 2000
Snap execution Dropdown list
Select one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.

Default value: Validate & Execute

Example: Execute only

Examples