N/search Module Members for SuiteScript Functionality

The N/search module enables on-demand and saved searches in SuiteScript, enhancing data retrieval and analysis capabilities.

·3 min read·View Oracle Docs

The N/search module is a powerful tool that allows developers to create and run both on-demand and saved searches within NetSuite. By utilizing this module, users can efficiently analyze and work through search results. Key functionalities include the ability to search for specific records using keywords, create and save searches, load existing searches, and identify duplicate records. Additionally, it enables users to return sets of records that match specified criteria, while also allowing for pagination to handle larger datasets efficiently.

Important: The N/search module does not operate in unauthenticated client-side contexts; further details can be found in SuiteAnswers.

Overview of N/search Module Members

The module is structured around several core member types and methods, enabling robust search capabilities. Below is an exploration of the key members and types available within the N/search module:

Member Types

Member TypeNameReturn Type / Value TypeSupported Script TypesDescription
Objectsearch.ColumnObjectClient and server scriptsEncapsulates a search column in a search.
Objectsearch.FilterObjectClient and server scriptsEncapsulates a search filter used in a search.
Objectsearch.PageObjectClient and server scriptsEncapsulates a set of search results for a single search page.
Objectsearch.PagedDataObjectClient and server scriptsHolds metadata about a paginated query.
Objectsearch.PageRangeObjectClient and server scriptsDefines the page range for a paginated query.
Objectsearch.ResultObjectClient and server scriptsEncapsulates a single search result row.
Objectsearch.ResultSetObjectClient and server scriptsEncapsulates a set of search results returned by Search.run().
Objectsearch.SearchObjectClient and server scriptsEncapsulates a NetSuite search.
Objectsearch.SettingObjectClient and server scriptsEncapsulates a search setting.

Key Methods

These methods are integral to leveraging the capabilities of the N/search module:

  • search.create(options): Creates a new search and returns a search object.
  • search.load(options): Loads an existing saved search.
  • search.run(): Executes an on-demand search, returning results as a ResultSet object.
  • search.runPaged(options): Runs a search and returns a PagedData object for handling large datasets.
  • search.duplicates(options): Finds duplicate records based on configured settings.

Who This Affects

The following roles and modules are impacted by the N/search module:

  • Developers: Who use SuiteScript to extend functionality and automate tasks.
  • Administrators: Who manage search responsibilities and settings.
  • Accountants and Finance Teams: Who need to analyze financial data effectively.

Key Takeaways

  • The N/search module is essential for conducting complex searches in NetSuite.
  • Provides functionality to create, save, and load searches, enhancing data retrieval.
  • Supports pagination for results, making it suitable for large datasets.

Source: This article is based on Oracle's official NetSuite documentation.

Frequently Asked Questions (4)

Does the N/search module require any specific permissions for use in SuiteScript?
The article does not specify any permissions required to use the N/search module in SuiteScript. It operates within client and server scripts, so standard script permissions may apply.
Can N/search module be used for duplicate record identification?
Yes, the N/search module includes the method 'search.duplicates(options)' which finds duplicate records based on configured settings.
Is the N/search module available for both client-side and server-side scripting?
Yes, the N/search module supports both client and server scripts, as indicated by the member types and methods supporting these script types.
What are the limitations of using the N/search module in client-side scripts?
The N/search module does not operate in unauthenticated client-side contexts, which may limit its use in certain environments or require additional configuration.
Source: N/search Module Members Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in Integration

View all Integration articles →