NetSuite Async Upsert

On this Page

Snap type:

Write

Description:

This Snap asynchronously inserts or updates a list of record(s) in NetSuite database.

If the Get async results property is selected, the Snap submits a job, checks the job status and gets the results. Individual records in the results will be routed to the output view or the error view depending on whether or not they are upserted successfully. Input documents are passed through if the Pass through property is selected. Input documents are always routed the error view if the results contain any error.

If the Get async results property is deselected, the Snap submits a job and returns a job ID at the output view. This job ID information may be supplied to NetSuite Check Async Status and NetSuite Get Async Results Snaps to check the submitted job status and to download the results.

The input document data cannot be passed through to the output view or the error view, and may be lost if the Get async results is not selected and the upsert job processing fails.

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.

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:

Works in Ultra Pipelines.
Supports only NetSuite Web Services-supported objects.
For information on the supported objects, see https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2019_2/schema/record/account.html.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See NetSuite Account for information on setting up this type of account.

Error rendering macro 'excerpt-include' : No link could be created for 'Configuring NetSuite Accounts'.

Views:

Input	This Snap has exactly one document input view.
Output	This Snap has exactly 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.

Batch size

Required. The maximum number of input documents to batch in a single request. Set to 1 to make a separate request for each input document.

Default value: 1000

Object

Required. NetSuite record type.

Default value: Account

Custom Record

Custom record type (required if CustomRecord is selected for Object).

Default value: None

Get async results

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

Required. If selected, the Snap passes the input document to the output view under the 'original' key.

Default value: Selected

Request time out

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

Default value: 0

Maximum request attempts

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

Default value: 3

Retry requests 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 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.

Example

This pipeline inserts and updates the records into the NetSuite object 'Account'.

The JSON Generator Snap passes the values to be inserted into the records.

The Mapper Snap maps the values to be inserted and updated to the records on the NetSuite object.

The NetSuite Async Upsert Snap inserts and updates the records on the NestSuite object 'Account'.

Successful execution of the pipeline displays the below output preview:

Creating and Updating Customer Records in NetSuite Using Custom Objects

NetSuite enables you to create custom objects, and you can use the NetSuite Create Snap to update these records. This example demonstrates how you can do so.

Download this pipeline.

Understanding the pipeline

We design the pipeline as shown above.

Mapper

The Mapper Snap retrieves the NetSuite object's schema from the NetSuite Create Snap and maps the data to be uploaded to the appropriate custom fields in the target schema.

The Mapper offers the following output:

As you can see, the Mapper has mapped custom fields in the NetSuite object schema to values that we listed in the Expression field in the Mapper Snap Settings screen, above. We now need to update a NetSuite record using these custom values.

NetSuite Create

We configure the NetSuite Create Snap as shown below. We select Job as the object that we want to update. This is the schema from which the Mapper Snap picks the custom fields that must be updated.

The NetSuite Create Snap now updates the concerned record based on the object that we selected in the NetSuite Create Settings screen above, and lists out the internal ID of the updated record.

Mapper 1

We can now check whether the record was updated. To do so, we extract the internal ID of the record that was updated from the output of the NetSuite Create Snap using a Mapper Snap:

The Mapper Snap captures the internal ID of the concerned record and makes it available to the NetSuite Get Snap.

NetSuite Get

We now use the internal ID received from the Mapper Snap to check whether the record concerned is actually updated.

We review the output of the NetSuite Get Snap and check whether the new data reflects the latest updates, and find that it does.

Error rendering macro 'excerpt-include' : No link could be created for 'NetSuite Snap Pack'.