Creating Search Filters in SuiteScript: Error Handling and Best

TL;DR

This article covers how to create search filters in SuiteScript, emphasizing the importance of using internal IDs rather than text values and how to handle common errors effectively.

How Do You Create Search Filters in SuiteScript?

Creating search filters in SuiteScript involves using the search.createFilter method from the N/search module. This method allows you to specify various parameters such as the name of the search field, the operator, and the values to filter by.

Important Considerations

• Use Internal IDs: When creating a filter for a list or record type field, always use the field's internal ID. Passing in text values directly will lead to errors. If you need to use the field's text value, consider using a formula with name: 'formulatext'.
• Filter Object: The return type of the search.createFilter method is an object of type search.Filter, which encapsulates the filter properties.

Parameters Overview

When creating a filter, it's essential to provide accurate parameters. Below is a summary of the parameters for creating a filter:

Common Errors and Solutions

When working with search filters, it's crucial to handle potential errors gracefully. Here are some of the common error codes you may encounter:

Example Code

Here is a code sample demonstrating the creation of a search filter in SuiteScript. This example lists the first 100 employees who have a custom role:

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

Key Takeaways

• Always use internal IDs for record fields when creating filters.
• Pay attention to error handling to manage incorrect filter setups efficiently.
• Utilize the search.createFilter method effectively for robust search implementations.