NetSuite Invoke SavedSearch

You can use the NetSuite Invoke SavedSearch activity to retrieve and execute the search queries that are created and saved in the NetSuite system.

This activity supports custom fields, custom records, and custom lists, see Customization for more information. It also supports paging search. This feature can be used when the search criteria is expected to return a large number of records. You can define the maximum number of records for each page and use the group function to iteratively search all the records that match the search conditions. For more information about the group, see TIBCO ActiveMatrix BusinessWorks Concepts.

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) The name of the activity in the process definition.
NetSuite Connection Yes (Required) Specifies 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) Specifies the top level category of the search record type.
Record Subcategory No (Required) Specifies the subcategory of the search record type.
Search Record No (Required) Specifies the search record type.
Saved Searches Yes (Required) The search criteria for searching records.

Click Fetch Saved Searches to fetch available search criteria saved in the NetSuite system. The search criteria is filtered based on the search record type.

Page Size Yes (Required) Specifies the maximum number of records that can be searched on each page.

The value must be an Integer that is greater than or equal to 5. The default value is 100. The recommended value is in the range 100 - 5000.

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
searchRecord
columns N/A Specifies the columns that you want to get in the output. If you do not set any columns, the plug-in outputs the columns specified in NetSuite system SavedSearch; if you set some columns, the plug-in outputs data according to your setting.
criteria N/A Specifies additional search conditions on saved search.

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.
Message String The error messages or warning messages returned from the NetSuite system.
SearchResult The SearchResult element contains the following elements:
  • totalRecords (A String value): The total number of searched records.
  • pageSize (A String value): The maximum number of records that are to be returned on each page. It is the same as the value specified in the General tab.
  • totalPages (A String value): The number of pages.
  • pageIndex (A String value): The index of the current page.
  • searchId (A String value): The search ID of this operation. The value of this element was allocated by the NetSuite system.
  • searchRowList: This element contains the following sub-element:
    • searchRow: The attributes of searchRow. For more information about the meaning of attributes, see NetSuite related documents.

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.