NetSuite Upsert Record

You can use the NetSuite Upsert Record to add or update records to the NetSuite system.

If the external ID of the new record exists in the NetSuite system, the new record updates the existing record that has the same external ID. Otherwise, a new record is created in the NetSuite system.

This activity supports batch operations. You can upsert multiple records at a time. If you want to upsert a data collection in the NetSuite system in a batch, you can use the For-Each statement to map the data collection to the elements in the Input fields in the NetSuite Upsert Record activity. It also supports custom fields, custom records, and custom lists, see Customization for more information.

General

In the General tab, you can specify a NetSuite connection and record category. The General tab contains the following fields:

Field Module Property? Description
Name No (Required) Specify a name for the activity in the process definition.
NetSuite Connection Yes (Required) Select a shared connection resource.

Click the icon to select a space connection. If no matching NetSuite connections are found, click Create Shared Resource in the Select NetSuiteConnectionResource Resource Template dialog to create one. See Creating a NetSuite Connection Shared Resource for more details.

Record Category No (Required) Select the top level category of the record type.
Record Subcategory No (Required) Select the subcategory of the record type.
Record No (Required) Select the record type.

Description

In the Description tab, you can enter a short description for the activity.

Input

In the Input tab, you can specify the fields that you require. The Input tab contains the following fields:

Field Data Type Description
Record
@externalId String (Required) The external ID of the new record to be upserted.
items N/A The attributes of the record. It varies in record type.
Note:
  • Values for the lastModifiedDate and createdDate elements are generated by the NetSuite system. Values input in these two fields do not take effect.
  • In the General tab, if you select Transactions from the Record Category list, select Customers from the Record Subcategory list, and select Charge from the Record list, this activity cannot be executed if you assign values to the chargeType, stage, or use elements.

Output

In the Output tab, you can check the response information. The Output tab contains the following fields:

Output Item Data Type Description
Success Boolean This property indicates the status of all of the operations. If no error occurs when adding one or more records, the status true is returned.
Results
Result The Result element contains the status and baseRef elements.
status The status element contains the following elements:
  • @isSuccess (A Boolean value): This property indicates the status of the current operation. If no error occurs when adding a record, the status true is returned.
  • statusDetail: This element contains the following sub-elements:
    • @type (A String value): The type of the message returned from the NetSuite system, which includes ERROR, WARN, and INFO.
    • code (A String value): The code of the message returned from the NetSuite system.
    • message (A String value): The message returned from the NetSuite system.
baseRef The baseRef element contains the following elements:
  • @internalId (A String value): The internal ID of the upserted records.
  • @externalId (A String value): The external ID of the upserted records.
  • @type (A String value): The type of the upserted records.

Fault

The Fault tab lists exceptions that are thrown by this activity. For more detailed information, see Error Codes.

Error Schema Element Data Type Description
NetSuitePluginException
msg String The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite error message.
msgCode String The TIBCO ActiveMatrix BusinessWorks Plug-in for NetSuite error code.
NetSuiteServerException
msg String The NetSuite system error message when processing a request from the plug-in.
msgCode String The NetSuite system error code when processing a request from the plug-in.
NetSuiteMSG String The NetSuite server error message when processing a request from the plug-in.