DataMeasure Object Members Reference in SuiteScript

The DataMeasure object in SuiteScript provides a structured way to define data measures used within the workbook functionality of NetSuite. This object allows developers to utilize properties that detail the aggregation method, the expression, and labels associated with these measures.

Overview of DataMeasure Properties

The following table outlines the members of the workbook.DataMeasure object:

Creating a DataMeasure Object

To create a DataMeasure object, the workbook.createDataMeasure(options) method is used. This method requires the following options:

• aggregation: The method of aggregation (e.g., DataCount).
• expression: A previously created workbook.Expression object, denoting the data used for calculations.
• label: A descriptive label for the measure.

Here is a sample syntax for creating a DataMeasure:

1// Add additional code
2...
3// myDataMeasure is a workbook.DataMeasure object
4 
5var myDataMeasure = workbook.createDataMeasure({
6    aggregation: 'DataCount',
7    expression: singleExpression,  // previously created workbook.Expression
8    label: 'MeasureLabel'
9});
10...
11// Add additional code

Supported Module

The DataMeasure object is part of the N/workbook Module, which provides various functionalities for manipulating workbook objects within SuiteScript.

Error Handling

It's important to manage potential errors when interacting with the DataMeasure object. Some common error codes include:

• INVALID_AGGREGATION: Thrown if the specified aggregation value is not part of the workbook.Aggregation enum.
• WRONG_PARAMETER_TYPE: Thrown when the data type provided does not match the expected type (e.g., a string).

Key Considerations

• Ensure that expressions defined in DataMeasure follow the correct formatting and data types to avoid runtime errors.
• Familiarize yourself with the N/workbook Module for effective utilization of the DataMeasure object capabilities.

Key Takeaways

• The DataMeasure object helps define data measures for analytics in SuiteScript.
• Key properties include aggregation, expression, and label.
• Proper error handling is essential for maintaining data integrity and functionality in scripts.