workbook.create(options)

Method Description	Creates a new workbook. Workbooks are where you analyze the results of your dataset queries using different components, such as table views and pivots. All workbooks are based on a dataset, and a single dataset can be used as the basis for multiple workbooks. A workbook can include an ID, a name, a description, pivots, and tables.
Returns	workbook.Workbook
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/workbook Module
Sibling Module Members	N/workbook Module Members
Since	2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.description	string	optional	The description of the workbook.
options.name	string	optional	The name of the workbook.
options.pivots	workbook.Pivot[]	optional	The pivots to include in the workbook.
options.tables	workbook.Table[]	optional	The tables to include in the workbook.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/workbook Module Script Samples. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
var myWorkbook = workbook.create({
    description: 'A sample workbook',
    name: 'My Workbook',
    pivots: [myPivot],
    tables: [myTable]
});
...
// Add additional code 

          

Related Topics

• N/workbook Module
• SuiteScript 2.x Modules
• SuiteScript 2.x

General Notices