Tutorial: Creating a Workbook Using the Workbook API

Note:

The content in this help topic applies to SuiteScript 2.x.

In this tutorial, you’ll learn how to:

Load a dataset to use for a workbook
Create a table view with data from the dataset
Define conditional formatting rules
Create a pivot that includes defined axes and a report style
Define data dimensions and dimension items
Create data measures and calculated measures

You can write your script in a text editor of your choice. When the script is complete, you can use the Dataset Builder Plug-in and Workbook Builder Plug-in to create the dataset and workbook in your NetSuite account.

Tip:

If you are new to the Workbook API and want to learn how to create a simple dataset, see Tutorial: Creating a Dataset Using the Workbook API.

Navigating the Tutorial

This tutorial includes navigation links at the bottom of each page. You can use these links to go forward to the next step in the tutorial or go back to the previous step.

Use the following table to go to a specific step in the tutorial.

Step	Description
Prerequisites	This topic lists the prerequisites for this tutorial, including required NetSuite features and permissions.
Full scripts	This topic lists the complete scripts that you will create during the tutorial.
Create the dataset	This topic describes how to create the dataset to use for the workbook.
Set up the workbook	This topic describes how to set up the structure of the workbook and load the dataset.
Create a table view	This topic describes how to create a table view, including conditional formatting rules and table columns.
Create a pivot	This topic describes how to create a pivot, including data dimensions, data and calculated measures, report styles, and pivot axes.

Step

Description

Prerequisites

This topic lists the prerequisites for this tutorial, including required NetSuite features and permissions.

Full scripts

This topic lists the complete scripts that you will create during the tutorial.

Create the dataset

This topic describes how to create the dataset to use for the workbook.

Set up the workbook

This topic describes how to set up the structure of the workbook and load the dataset.

Create a table view

This topic describes how to create a table view, including conditional formatting rules and table columns.