NetSuite Async Search

NetSuite Async Search

On this Page

Description:

This Snap searches records from NetSuite asynchronously. 

This Snap provides the ability to search records of an object in NetSuite by providing criteria. The criteria fields that can be set on the object are provided on the input view of the Snap and can be mapped using an upstream Mapper or Structure Snap. If the Get async results property is selected, the Snap submits a job, checks the job status and gets the results. If the Get async results property is deselected, the Snap submits a job and returns a job ID at the output view.

  • Expected upstream Snaps: Any Snap that provides a document output view, such as Mapper or Structure or a JSON Generator Snap. 

  • Expected downstream Snaps: [None] or any Snap that has a document input view, such as Filter or Mapper or JSON Formatter.

  • Expected input: This Snap provides schema on its input view for the selected object that can then be used in a Mapper Snap to map the required fields.

  • Expected output: This Snap provides the result of the operation for the given criteria on the output view. Errors can be routed to the error view if enabled or cause the Snap to fail during execution.
    Note: Empty number values should be given as 0.0, not as null.

Snap type:

Read

Prerequisites:

Make sure the data to be added maps correctly to the fields where it is being directed and is of the correct data type.

Support and limitations:

Views:

Input

This Snap has exactly one document input view.

Output

This Snap has at most one document output view.

Error

This Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label

 

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Object

 

Required. The NetSuite Object type to update. For example, to search for records of a custom record type, select Custom Record from the available options.

To use the AdvInterCompnayJournalEntry object in NetSuite, particularly in a OneWorld or multi-subsidiary environment, you must configure a custom role with the appropriate permissions, including Transactions Make Journal Entry (Full).

Default value: Account

Custom Record

 

Custom record type

This is required if CustomRecord is selected for Object.

Default value: None

Body fields only

 

Omits sublist values from search results.

 Note: Using the default checked state can significantly improve performance.

Default value: Selected  

Advanced

 

Performs an advanced search. This changes the input schema.
Default value: Deselected

Return Search columns

 

Required. This is relevant only when performing an Advanced search to execute a saved search.  
If selected, executes a saved search, if not selected,  returns full records as opposed to columns. 

NetSuite returns an error when:

  •  selected and the input document does not specify columns

  • not selected and the input does not specify a saved search 

Default value: Selected

Page size

 

Required. The number of records returned on a single page of search results.

Default value: 1000

Get async results

 

Required. If selected, the Snap submits a job, checks the job status and gets the results when finished. If not selected, the Snap submits a job and produces a job ID information at the output view.
Default value: Selected

Pass through

 

If selected, the Snap passes the input document to the output view under the 'original' key.
Default value: Not selected

Request timeout

 

Required. Timeout for the web service call (in seconds). 0 indicates no timeout.
Default value: 0  

Maximum requests attempts

 

Required. The maximum number of requests to attempt in case of failure.

Default value: 3

Retry request interval

 

Required. Specifies the interval between two successive SOAP requests. A retry happens only when the previous attempt resulted in an exception.

Default value: 2

Snap execution

 

 

Select one of the following three modes in which the Snap executes:

  • 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: Execute only
Example: Validate & Execute

 

Troubleshooting

Example


In this pipeline, we search all the records from a NetSuite object asynchronously using the NetSuite Async Search Snap. We provide the inputs in the upstream Mapper Snap.

The upstream Mapper Snap maps the records to be searched on the NetSuite Object. In this example, we gave the input '{ }', which retrieves all the records from the object 'Account'

You may also give your search criteria in the upstream Snap to retrieve a specific record or a set of records.  

The NetSuite Async Snap Searches all the records from the object, 'Account', and displays them in the output preview.

Successful execution of the pipeline displays the below output preview:

The output preview displays all the records under the object 'Account' in this case.