On this Page

Overview

Snap type:

Read

Description:

This Snap gets a particular record based on the given internal ID and object type. The object becomes suggestible once the account is defined. The 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. This Snap dispatches one request per incoming document.

Expected upstream Snaps: Any Snap that provides a document output view, such as Mapper or Structure or a JSON Generator Snap.
Expected downstream Snaps: Any Snap that has a document input view, such as Filter or Mapper or JSON Formatter.
Expected input: This Snap provides a 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 get operation for each record on the output view. Errors can be routed to the error view if enabled or cause the Snap to fail during execution.

Prerequisites:

[None]

Support and limitations:

Works in Ultra Pipelines.

Known Issues:

This Snap currently does not support custom records.

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.

Request timeout

Required. The timeout for the web service call (in seconds). A value of 0 indicates no timeout.

Example: 0
Default value: 0

Maximum request attempts

Required. Specifies the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Default value: 3

Retry request interval

Required. Specifies the interval (in seconds) between two successive 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.

This Snap does not currently support custom records.

Examples

Retrieving an Employee Record Using Employee Internal ID

In this example, you search for and retrieve an employee record using employee internal ID.

Understanding the Pipeline

In this pipeline execution:

Mapper Snap maps the employee details to the input fields of NetSuite Create Snap:

NetSuite Create Snap creates a new employee record using the Employee Object:

Mapper Snap maps the output of the NetSuite Create Snap to the input fields of the NetSuite Get Snap:

NetSuite Get Snap retrieves the employee details:

When the NetSuite Get Snap is saved, it generates the input schema automatically. After the pipeline executes, the NetSuite Get Snap responds with the details of an employee with internal ID 112908. The following is the data preview of the NetSuite Get Snap that show the employee details:

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'.