NetSuite REST SuiteQL
Overview
Read-type Snap-
Works in Ultra Pipelines
You can use this Snap to execute SuiteQL queries on NetSuite server.
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:
Learn more about Error handling in Pipelines. |
|
Snap Settings
-
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 there are more than one of the same Snap in the pipeline. Default value: NetSuite REST SuiteQL Example: Execute employees list |
| Query | String/Expression |
Required. Specify a valid SuiteQL query. Default: 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 |
| Timeout options | Specify the properties related to the timeout connections. | |
| Read timeout (seconds) | Integer/Expression |
Specify the number of seconds the Snap must wait before it terminates the request because of a failure to receive data from the target service. Default value: 60 Example: 500 |
| Connection timeout (seconds) | Integer/Expression |
Specify the number of seconds the Snap must wait before it terminates the request because of a failure to establish a connection to the target endpoint or service. Default value: 30 Example: 1000 |
| Retry settings | Specify the properties for handling retry during failures. | |
| Retry on | Dropdown list |
Select the the condition to retry the request.
Available options include:
Default value: Server errors (5xx) Example: Client and server errors (4xx, 5xx) |
| Maximum attempts | Integer/Expression |
Specify the maximum number of retry attempts in case of failure. Default value: 5 Example: 10 |
| Retry interval (seconds) | Integer/Expression |
Specify the intervals between each retry. Default value: 3 Example: 15 |
| Snap Execution | Dropdown list | Select one of the three modes in which the Snap executes.
Available options are:
|