Search Filters Creation in SuiteScript 2.x for NetSuite

Creating search filters in SuiteScript 2.x allows you to enhance data retrieval based on specified criteria. Understanding the correct syntax and method parameters is essential for effective use.

How Do Search Filters Work?

In SuiteScript 2.x, a search filter is created as an object using the search.Filter functionalities. Here’s an important note: you cannot use a field's text value directly to create a filter for a list or record type field. Instead, you must use the field's internal ID. If you absolutely need to filter using the text value, you can create a filter or column by employing a formula with name: 'formulatext'.

Return Value

The method returns a search.Filter object, which can be utilized within your search definitions.

Supported Script Types

Search filters can be leveraged in both client and server scripts. For detailed information about SuiteScript 2.x script types, refer to the relevant documentation.

Parameters for Filter Creation

When creating a filter, an options parameter, structured as a JavaScript object, is essential. It includes the following:

Error Handling

When working with search filters, you might encounter the following error codes:

• SSS_INVALID_SRCH_OPERATOR: This error is reported when the options.operator parameter is invalid or incorrectly formatted.
• SSS_INVALID_SRCH_SUMMARY_TYP: Thrown when the options.summary parameter has an incorrect summary type.
• SSS_MISSING_REQD_ARGUMENT: Signifies a missing required argument in the filter options.

Example Code Sample

The following code demonstrates how you can define and apply a search filter:

1// Create a search filter joined to another record type
2var result = search.create({
3    type: 'employee',
4    columns: ['firstname', 'lastname', 'role'],
5    filters: [
6        search.createFilter({
7            name: 'iscustom',
8            join: 'role',
9            operator: search.Operator.IS,
10            values: true
11        })
12    ]
13}).run().getRange({
14    start: 0,
15    end: 100
16});
17log.debug({
18    title: 'Result',
19    details: result
20});

Additional Considerations

If setting filter conditions on fields with Long Text or Rich Text types, keep in mind that there's a character limit of approximately 500 characters for matching string length, which can vary based on character encoding used.

Key Takeaways

• Search filters in SuiteScript 2.x enhance data retrieval.
• Always use the internal ID for field names in filters.
• Error handling is crucial for successful search filter usage.
• Various parameters control how filters are constructed and applied.
• Code samples illustrate practical use cases for creating filters.