NetSuite Changelog
SuiteScriptNew FeatureReference

SortByDataDimensionItem Object Members in SuiteScript

The SortByDataDimensionItem object in SuiteScript provides members to sort data using specific dimension items for effective data management.

·2 min read·View Oracle Docs

TL;DR Opening

The SortByDataDimensionItem object in SuiteScript enables developers to sort datasets using specific data dimension items, enhancing data organization and query capabilities. This object simplifies sorting through defined criteria, which is essential for efficient data management within NetSuite.

Overview of SortByDataDimensionItem Object Members

The SortByDataDimensionItem object includes the following members:

Member NameReturn Type / Value TypeDescriptionSupported Script Types
itemworkbook.DataDimensionItemThe data dimension item to use for the sort.Server scripts
sortworkbook.SortThe sort to apply.Server scripts

Object Description

The SortByDataDimensionItem allows users to create a sorting criterion based on a specified data dimension item. You can create this object by utilizing the workbook.createSortByDataDimensionItem(options) method.

Supported Script Types

This object is compatible with Server scripts. For more information on supported SuiteScript types, refer to SuiteScript 2.x Script Types.

Error Handling

When using the SortByDataDimensionItem, you may encounter the following error:

  • Error Code: WRONG_PARAMETER_TYPE
    • Thrown If: The specified value for the item property is not a valid workbook.DataDimensionItem object.

Related Topics

Key Takeaways

  • The SortByDataDimensionItem object is essential for sorting data efficiently in SuiteScript.
  • It consists of properties like item and sort that define the criteria for sorting.
  • Error handling is crucial to ensure valid data dimension items are used.

Frequently Asked Questions (4)

Can the SortByDataDimensionItem object be used in client scripts?
No, the SortByDataDimensionItem object is only supported in server scripts. Client scripts are not compatible with this object.
How do I create a SortByDataDimensionItem object in SuiteScript?
You can create a SortByDataDimensionItem object by using the workbook.createSortByDataDimensionItem(options) method.
What error might occur if I use an invalid data dimension item with SortByDataDimensionItem?
If you specify a value for the item property that is not a valid workbook.DataDimensionItem object, you will encounter the error code WRONG_PARAMETER_TYPE.
What are the fundamental properties of the SortByDataDimensionItem object?
The SortByDataDimensionItem object includes the properties 'item', a workbook.DataDimensionItem used for sorting, and 'sort', a workbook.Sort defining the sorting operation.
Source: SortByDataDimensionItem Object 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 SuiteScript

View all SuiteScript articles →