Skip to end of metadata
Go to start of metadata

Introduction

A NetSuite Search activity retrieves existing records from NetSuite and is intended to be used as a source in an operation. After configuring a NetSuite connection, you can configure as many NetSuite activities as you like for each NetSuite connection.

In a NetSuite Search activity, you can configure these types of searches:

  • Basic Search: Filters on all available fields for a selected object.
  • Expanded Search: Filters on all available fields for a selected object and related objects. The selected object must have related objects.
  • Advanced Search: Filters on a specific column for a selected object and related objects, and is faster than a basic or expanded search. The selected object must have related objects.
  • Saved Search: Uses a reusable search that you have already defined in NetSuite.

Creating a NetSuite Activity

From the design canvas, open the Connectivity tab of the design component palette:

Use the Show dropdown to filter on Endpoints, and then click the NetSuite connection block to display activities that are available to be used with a NetSuite connection:

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring a NetSuite Search Activity

Follow these steps to configure a NetSuite Search activity:

Step 1: Enter a Name and Select an Object

  • Name: Enter a name to use to identify the NetSuite Search activity. The name must be unique for each NetSuite Search activity and must not contain forward slashes (/) or colons (:).
  • Select an Object: This section displays objects available in the NetSuite endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.
    • Selected NetSuite Object: After an object is selected, it is listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon  or the word Refresh to reload objects from the NetSuite endpoint. This may be useful if you have recently added objects or fields to NetSuite. This action refreshes all metadata used to build the table of objects displayed in the configuration.
    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the NetSuite endpoint:

      • Name: The object name from NetSuite.

        NOTE: If selecting the Transaction or Item object directly, you can specify sub-types in step 2. This applies only to the objects with a Name of Transaction or Item and does not apply generally across all objects with a Type of transaction (tran) or item.

      • Type: The object type from NetSuite. This includes all standard, transaction (tran), item, and custom objects that are available to search within the NetSuite endpoint.

      • Object Description: The object description from NetSuite.

      TIP: If the table does not populate with available objects, the NetSuite connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
  • Next: Click to continue to the next step and temporarily store the configuration. The configuration is not saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a Search Type

  • Select Search Type: Select the type of search to perform:
    • Basic Search: Filters only on the selected object. This type of search always returns all available fields for the selected object. For example, a basic search for the Transaction object queries all fields in the Transaction object. For details, see Basic Search below.
    • Expanded Search: Filters on the selected object and related objects. This type of search always returns all available fields for the selected object and related objects, and can be selected only for objects that have related objects in NetSuite. For example, an expanded search for the Transaction object also includes additional related objects in NetSuite such as accountJoin, caseJoin, opportunityJoin, purchaseOrderJoin, userJoin, etc. For details, see Expanded Search below.

    • Advanced Search: Filters on the selected object and related objects. This type of search returns results only for a specific column, and can be selected only for objects that have related objects in NetSuite. An advanced search can be much faster than a basic search or expanded search, even if you do not want to query related objects, because it allows you to limit the query to specific fields in NetSuite. For details, see Advanced Search below.

      WARNING: In an advanced search, custom segments of the type List/Record as defined in NetSuite are not supported. However, the Multiple Select type is supported in an advanced search. This limitation does not apply to other types of NetSuite searches (basic, expanded, and saved searches), which support both the List/Record and Multiple Select types. For more information, see NetSuite Custom Segments.
    • Saved Search: Filters using a reusable search that you have already defined in NetSuite. This type of search can be selected only for objects that support NetSuite saved searches. Instead of building the search within Jitterbit, the search is already set up within NetSuite and can then be pulled into Jitterbit Harmony. For additional information on NetSuite saved searches, see NetSuite documentation on Using Saved Searches (login to NetSuite required). For details, see Saved Search below.
  • Select Sub-types for Item or Transaction Search. You Must Select at Least One When Applicable: This section is displayed only when the object selected in the previous step is the Transaction or Item object. This applies only to the objects with a Name of Transaction or Item and does not apply generally across all objects with a Type of transaction (tran) or item.
    If this section is displayed, use the Select All Objects checkbox to select all sub-types to include in the search, or select each sub-type individually.

  • Back: Click to return to the previous step and temporarily store the configuration.
  • Next: Click to continue to the next step and temporarily store the configuration. The configuration is not be saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Select Fields and Create Conditions

The interface used in this step of the configuration of a NetSuite Search activity depends on the search type selected in the previous step:

Basic Search

If a Basic Search was selected in step 2, this interface is presented:

  • Search: Enter any part of the field name into the search box to filter the list of fields for the selected object. The search is not case-sensitive. The listed results are filtered in real time with each keystroke.
  • Specify Criteria to Narrow Down Your Search: One at a time, click a field available within the selected object to select the field. When you select a field, the Add Condition area becomes populated with the object and field information.
  • Add Condition: After selecting a field to populate this area, click to open a prompt for any appropriate selections or user input for the selected field. The presented options vary depending on the selected field. When ready, click the Add Condition button within the prompt to add the field to the Current Conditions table.

    TIP: If searching within an object's status field, the search values that correspond to internal statuses within NetSuite are provided for your convenience in a list under Searching by Status in NetSuite. For search values to enter for other fields, refer to NetSuite's documentation.
  • Current Conditions: As you select fields and add conditions using the methods described above, this table becomes populated with a summary of the selected objects and fields. These columns are displayed in the table:
    • Object: The selected NetSuite object.
    • Field: The selected NetSuite field.
    • Operator: The operator used for the search, if any.
    • Search Value: The first search value entered as input while adding the condition, if any.
    • Search Value 2: The second search value entered as input while adding the condition, if any.
    • Actions: In the column with an actions menu icon , hover over any row to show icons for any actions you can take on the row:
      • Edit: Click the edit icon  to reopen the Add Condition prompt where you can edit any selections for the condition.
      • Delete: Click the trash icon  to remove a condition from the Current Conditions table.
    TIP: You can add any number of conditions to your search. In this way you can effectively create any combination of multiple record searches.
  • Test Query: Click to validate the query. If the query is valid, a summary of the search results is displayed in an informational message similar to that shown below. If the query is not valid, relevant error messages are displayed.

  • Back: Click to return to the previous step and temporary store the configuration.
  • Next: Click to continue to the next step and temporarily store the configuration. The configuration is not saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Expanded Search

If an Expanded Search was selected in step 2, this interface is presented:

  • Search: Enter any part of the field name into the search box to filter the list of fields for the selected object and any related objects. The search is not case-sensitive. The listed results are filtered in real time with each keystroke.
  • Specify Criteria to Narrow Down Your Search: One at a time, click a field available within the selected object or related objects to select the field. When you select a field, the Add Condition area becomes populated with the object and field information.
  • Add Condition: After selecting a field to populate this area, click to open a prompt for any appropriate selections or user input for the selected field. The presented options vary depending on the selected field. When ready, click the Add Condition button within the prompt to add the field to the Current Conditions table. (See the documentation on basic search for a screenshot of this prompt.)

    TIP: If searching within an object's status field, the search values that correspond to internal statuses within NetSuite are provided for your convenience in a list under Searching by Status in NetSuite. For search values to enter for other fields, refer to NetSuite's documentation.
  • Current Conditions: As you select fields and add conditions using the methods described above, this table becomes populated with a summary of the selected objects and fields. These columns are displayed in the table:
    • Object: The selected NetSuite object.
    • Field: The selected NetSuite field.
    • Operator: The operator used for the search, if any.
    • Search Value: The first search value entered as input while adding the condition, if any.
    • Search Value 2: The second search value entered as input while adding the condition, if any.
    • Actions: In the column with an actions menu icon , hover over any row to show icons for any actions you can take on the row:
      • Edit: Click the edit icon  to reopen the Add Condition prompt where you can edit any selections for the condition.
      • Delete: Click the trash icon  to remove a condition from the Current Conditions table.
    TIP: You can add any number of conditions to your search. In this way you can effectively create any combination of multiple record searches.
  • Test Query: Click to validate the query. If the query is valid, a summary of the search results is displayed. If the query is not valid, relevant error messages are displayed. (See the documentation on basic search for a screenshot of query results.)

    CAUTION: Expanded searches must include a query on a related object, or the Test Query button is disabled. If the search is on the same object, please use a basic search.
  • Back: Click to return to the previous step and temporarily store the configuration.
  • Next: Click to continue to the next step and temporarily store the configuration. The configuration is not saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Advanced Search

If an Advanced Search was selected in step 2, this interface is presented:

On this step, different configuration options are shown depending on whether Selected Columns to Return or Define Filter Criteria is selected. Although these radio buttons might make it seem like you should select either one option or the other, they are actually two different specifications, both of which need to be reviewed and configured. Be sure to select each one to configure the options on each screen.

  • Select Columns to Return: When this option is selected, the columns to be returned can be specified:

    • Search: Enter any part of the field name into the search box to filter the list of fields for the selected object and any related objects. The search is not case-sensitive. The listed results are filtered in real time with each keystroke.
    • Select Columns to Return: Select the checkboxes of the specific fields to include in the search. You can also select an entire object to select all of its fields at once.
  • Define Filter Criteria: When this option is selected, the filter criteria to be used in the search can be specified:

    • Search: Enter any part of the field name into the search box to filter the list of fields for the selected object and any related objects. The search is not case-sensitive. The listed results are filtered in real time with each keystroke.
    • Specify Criteria to Narrow Down Your Search: One at a time, click a field available within the selected object or related objects to select the field. When you select a field, the Add Condition area becomes populated with the object and field information.
    • Add Condition: After selecting a field to populate this area, click to open a prompt for any appropriate selections or user input for the selected field. The presented options vary depending on the selected field. When ready, click the Add Condition button within the prompt to add the field to the Current Conditions table. (See the documentation on basic search for a screenshot of this prompt.)

      TIP: If searching within an object's status field, the search values that correspond to internal statuses within NetSuite are provided for your convenience in a list under Searching by Status in NetSuite. For search values to enter for other fields, refer to NetSuite's documentation.
    • Current Conditions: As you select fields and add conditions using the methods described above, this table becomes populated with a summary of the selected objects and fields. These columns are displayed in the table:
      • Object: The selected NetSuite object.
      • Field: The selected NetSuite field.
      • Operator: The operator used for the search, if any.
      • Search Value: The first search value entered as input while adding the condition, if any.
      • Search Value 2: The second search value entered as input while adding the condition, if any.
      • Actions: In the column with an actions menu icon , hover over any row to show icons for any actions you can take on the row:
        • Edit: Click the edit icon  to reopen the Add Condition prompt where you can edit any selections for the condition.
        • Delete: Click the trash icon  to remove a condition from the Current Conditions table.
      TIP: You can add any number of conditions to your search. In this way you can effectively create any combination of multiple record searches.
    • Test Query: Click to validate the query. If the query is valid, a summary of the search results is displayed. If the query is not valid, relevant error messages are displayed. (See the documentation on basic search for a screenshot of query results.)

  • Back: Click to return to the previous step and temporarily store the configuration.
  • Next: Click to continue to the next step and temporarily store the configuration. The configuration is not saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Saved Search

If a Saved Search was selected in step 2, this interface is presented:

  • Select a Saved Search: Use the dropdown to select a NetSuite saved search that already exists within the NetSuite endpoint for the selected object.

    WARNING: If searching on an object with more than 1,000 saved searches, it may appear as if there are no saved searches available on the object. For more information including a workaround, see NetSuite Saved Search Limits.
  • Test Query: Click to validate the query. If the query is valid, a summary of the search results is displayed. If the query is not valid, relevant error messages are displayed.

  • Back: Click to return to the previous step and temporarily store the configuration.
  • Next: Click to continue to the next step and temporarily store the configuration. The configuration is not saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 4: Review the Data Schemas

  • Data Schema: The response data schema for NetSuite is displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The NetSuite connector uses the SOAP web services API of the version of the NetSuite WSDL you have configured. This is specified during configuration of the NetSuite connectionRefer to documentation provided in the NetSuite Help Center (login to NetSuite required) for information on the schema fields.

  • Back: Click to return to the previous step and temporarily store the configuration.
  • Finished: Click to save the configuration for all steps and close the activity configuration.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a NetSuite Search activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After a NetSuite Search activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.

NetSuite Search activities can be used as a source with these operation patterns:

Operations that contain a NetSuite activity can have only one NetSuite activity and cannot also contain any Salesforce, SAP, ServiceMax, or SOAP activities.

Other patterns are not valid using NetSuite Search activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a NetSuite Search activity in the Transformation Pattern. In this example, the NetSuite Search activity (Transaction Search) generates a response structure that is received by the transformation (Transaction Search Response), which is then written to an FTP server by an FTP Write activity (Write Search Response to FTP) and a message is then logged by the Write to Operation Log script.

This example setup depicts one common operation setup using a NetSuite Search activity:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Jun 23, 2020

  • No labels