Creating Search Columns in SuiteScript for NetSuite

Creating new search columns in SuiteScript allows developers to specify fields that should be represented in the search results. A search column is an object that corresponds to a specific field in a record and is instrumental in customizing search output to business needs.

What is a Search Column?

A search column represents a specific field on a record that you want to include in the returned search results. For instance, if you want to display the Sales Rep field from a customer record in your search results, you would create a column for that field when defining your search criteria.

Important Considerations

When creating search columns, you should be aware of the following:

• Field Internal IDs: Directly referencing the text value of a list/record type field is prohibited. Instead, use the internal ID of the field. If you need to use the text value, you can implement a formula with name: 'formulatext'.
• Sorting Limitations: After a search column has been created, its sort order cannot be changed. If you use the same column in multiple searches, the original sort order specified with options.sort will be retained.

How to Create a Search Column

To create a search column in SuiteScript, you'll use the search.createColumn(options) method. The options object allows you to define various parameters for your search column.

Parameters

Example Code

Here’s a basic example of creating a search column using SuiteScript:

var currencyColumn = search.createColumn({
    name: 'currency',
    sort: search.Sort.ASC
});

This snippet creates a column for the currency field and sets it to sort in ascending order.

Error Handling

While crafting your search column, you might encounter several errors:

• SSS_INVALID_SRCH_COLUMN_SUM: Thrown when an invalid column summary type is used in the options.summary parameter.
• INVALID_SRCH_FUNCTN: Returned if an unrecognized function is provided for the search column.
• SSS_MISSING_REQD_ARGUMENT: Occurs when a required parameter is missing during column creation.

Conclusion

By effectively utilizing the search.createColumn method, developers can tailor their SuiteScript searches to meet specific business requirements, improving the clarity and relevance of search outputs.

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