PathSelector Object Members in SuiteScript for Data Filtering

The PathSelector object in SuiteScript is an essential component for developers aiming to create sorting definitions or filters within workbooks. This object allows you to specify criteria for viewing and managing data effectively, critical for advanced data manipulation tasks in SuiteScript.

What is the PathSelector Object?

The PathSelector object is designed to be utilized in methods such as workbook.createConditionalFilter(options), workbook.createLimitingFilter(options), workbook.createSortDefinition(options), and workbook.createSortByMeasure(options). It simplifies data interactions by providing a pathway for developers to define how data is filtered or sorted.

PathSelector Object Members

The following member is available for a workbook.PathSelector object:

Supported Script Types: This object is primarily used in server scripts, making it crucial for backend operations within the NetSuite environment.

How to Create a PathSelector

To instantiate a PathSelector, use the workbook.createPathSelector(options) method. Below are examples of how this can be implemented:

1// Create an AllSubNodesSelector PathSelector
2var myPathSelector = workbook.createPathSelector({
3    elements: [workbook.createAllSubNodesSelector()]
4});
5 
6// Create a DimensionSelector PathSelector
7var myPathSelector = workbook.createPathSelector({
8    elements: [myDimensionSelector]
9});

Usage in Workbook Definitions

The PathSelector is also utilized when loading workbook data. Below is a sample code snippet demonstrating how to access the PathSelector elements in a pivot definition:

1var myWorkbook = workbook.load({
2    id: myWorkbookId
3});
4 
5var myPathSelector = myWorkbook.pivots[0].aggregationFilters[0].filteredNodesSelector.elements;
6log.audit({
7    title: 'PathSelector.elements = ',
8    details: myPathSelector.elements
9});

Important Notes

• The elements member must return a value of type workbook.DimensionSelector. If an incorrect type is supplied, the code will throw a WRONG_PARAMETER_TYPE error.

Good Practices: Always ensure that the types of members in your PathSelector are correctly specified to avoid runtime errors, and utilize the built-in logging functionality to aid in debugging.

Who This Affects

• Developers: Those creating and managing scripts using SuiteScript.

Key Takeaways

• The PathSelector object simplifies the development of sort definitions and filters in SuiteScript.
• Key member is the elements, which requires a specific type for successful execution.
• Use the PathSelector in conjunction with other workbook methods for enhanced data management capabilities.