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 |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2020.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
string |
optional |
The description of the workbook. |
|
string |
optional |
The name of the workbook. |
|
optional |
The pivots to include in the workbook. |
|
|
optional |
The tables to include in the workbook. |
Syntax
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