Modules

filter

 

Objects/Functions

module (N/workbook)

SuiteScript 2.0

workbook.Workbook

// Please search https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.Workbook for more information.

N/workbook Module
workbook.Workbook
Object Description: A workbook. Workbooks are where you analyze the results of your dataset queries using different components, such as table views, pivot tables, and charts. All workbooks are based on a dataset, and a single dataset can be used as the basis for multiple workbooks. A workbook can include tables, pivots, and charts. A workbook is created using workbook.create(options).
Supported Script Types: Server scripts For more information, see SuiteScript 2.0 Script Types.
Module: N/workbook Module
Methods and Properties: Workbook Object Members
Since: 2020.2
Search NetSuite - https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.Workbook

Example:

// Code Example 1
/ Add additional code
//...
// Create an empty workbook
var myWorkbook = workbook.create({});

// Create a workbook with just a name and description
var myWorkbook = workbook.create({
name: 'My Workbook',
description: 'My starter workbook'
});

// Create a workbook with a table
var myWorkbook = workbook.create({
tableDefinitions: [myTableDefinition]
});

// Create a workbook with a pivot
var myWorkbook = workbook.create({
pivotDefinitions: [myPivotDefinition]
});

// Create a workbook with a chart
var myWorkbook = workbook.create({
chartDefinitions: [myChartDefinition]
});

// Create a comprehensive workbook
var myWorkbook = workbook.create({
name: 'My Big Workbook',
description: 'My workbook that contains everything',
tableDefinitions: [myTableDefinition],
chartDefinitions: [myChartDefinition],
pivotDefinitions: [myPivotDefinition]
});

// View a workbook.Workbook
var allWorkbooks = workbook.list();

myWorkbookId = allWorkbooks[0].id;

// Note that some workbook contents may be empty/null based on the loaded workbook
var myWorkbook = workbook.load({
id: myWorkbookId
});

log.audit({
title: 'Workbook.id = ',
details: myWorkbook.id
});
log.audit({
title: 'Workbook.name = ',
details: myWorkbook.name
});
log.audit({
title: 'Workbook.description = ',
details: myWorkbook.description
});

log.audit({
title: 'Workbook.tableDefinitions = ',
details: myWorkbook.tableDefinitions
});
log.audit({
title: 'Workbook.chartDefinitions = ',
details: myWorkbook.chartDefinitions
});
log.audit({
title: 'Workbook.pivotDefinitions = ',
details: myWorkbook.pivotDefinitions
});
//...
// Add additional code

//SOURCE: https://system.netsuite.com/app/help/helpcenter.nl?fid=section_159008620913.html