NetSuite Changelog
PlatformSuiteScriptNew Feature

N/workbook Module Members

Learn about N/workbook module members, which support various objects and methods for effective SuiteScript development.

·3 min read·View Oracle Docs

TL;DR Opening

The N/workbook module provides essential members for SuiteScript development, enabling developers to create and manipulate various workbook components effectively. This module plays a critical role in data analysis and visualization within NetSuite, allowing users to work with datasets through charts, tables, and other graphical representations.

What are N/workbook Module Members?

The N/workbook module encompasses a variety of objects and methods that facilitate the creation and management of workbooks in NetSuite. Below is a detailed breakdown of the members available in this module, including their types, return values, and descriptions.

Workbook Module Members Overview

The following table summarizes the members of the N/workbook module:

Member NameTypeReturn Type / Value TypeSupported Script TypesDescription
workbook.AspectObjectServer scriptsAn aspect.
workbook.CalculatedMeasureObjectServer scriptsA calculated measure.
workbook.CategoryObjectServer scriptsA chart category.
workbook.ChartObjectServer scriptsA chart.
workbook.ChartAxisObjectServer scriptsA chart axis object used when creating a category or legend.
workbook.ChildNodesSelectorObjectServer scriptsA selector for child nodes.
workbook.ColorObjectServer scriptsA color.
workbook.ConditionalFilterObjectServer scriptsA conditional filter.
workbook.ConditionalFormatObjectServer scriptsA conditional format.
workbook.ConditionalFormatRuleObjectServer scriptsA conditional format rule.
...............
workbook.createTableColumnFilter(options)ObjectServer scriptsCreates a table filter.
workbook.list()Object[]Server scriptsLists all existing workbooks.
workbook.loadWorkbook(options)workbook.WorkbookServer scriptsLoads an existing workbook.

Key Methods in N/workbook Module

Here are some of the significant methods available in the N/workbook module:

Creating a Workbook

You can create a workbook using the following code:

suitescript
var myWorkbook = workbook.create({
    id: "workbookId"
});

Creating an Aspect

To create an aspect for a chart series, use:

suitescript
var myAspect = workbook.createAspect({
    measure: myMeasure,
    type: workbook.AspectType.COLOR
});

Listing Workbooks

To list all existing workbooks:

suitescript
var workbooks = workbook.list();

Who This Affects

The following roles may find the N/workbook module members especially useful:

  • Developers: To create custom reports and visualizations.
  • Administrators: For managing data analytics solutions.
  • Analysts: To ensure robust reporting functionalities.

Key Takeaways

  • The N/workbook module supports various objects crucial for data analysis.
  • Several member methods exist for creating, listing, and manipulating workbooks.
  • This module is invaluable for developers seeking to enhance reporting capabilities within NetSuite.

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

Frequently Asked Questions (4)

Do I need any specific permissions to use the N/workbook module members?
The article does not specify permissions, but typically, using SuiteScript modules like N/workbook would require appropriate scripting and data access permissions in NetSuite.
Is the N/workbook module available for client scripts or just server scripts?
According to the article, the N/workbook module members, including methods and objects, are supported only for server scripts.
How can I load an existing workbook using the N/workbook module?
You can load an existing workbook with the N/workbook module by using the `workbook.loadWorkbook(options)` method, where you pass the appropriate options to load the desired workbook.
Can I use N/workbook module members to create conditional formats in my workbooks?
Yes, the N/workbook module includes members such as `workbook.ConditionalFormat` and `workbook.ConditionalFormatRule`, which allow you to create and manage conditional formats within workbooks.
Source: N/workbook Module 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 Platform

View all Platform articles →