Workbook API Concepts

Note:

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

This section describes the main concepts in the Workbook API and how to use them to create datasets and workbooks.

Use the following quick reference table for links to topics with more information.

Area

Concepts

Description

Datasets

Columns

Columns represent the record fields in a dataset that you want to include in the dataset query results.

Conditions

Conditions let you filter the dataset query results based on criteria that you specify.

Dataset Linking

You can link two datasets to use data from both datasets in a workbook.

Joins

Datasets often join a root record type with other related record types to use data from the joined record types in a workbook.

Workbooks

Table Views

Table views let you explore your dataset query results in a simple tabular format.

Pivots

Pivots let you analyze different subsets of your dataset query results using advanced analytical features.

Related Topics

Tutorial: Creating a Dataset Using the Workbook API
Tutorial: Creating a Workbook Using the Workbook API
Workbook API Limitations
Workbook API

General Notices