Workbooks
Workbooks are for analyzing dataset query results using visualizations like table views and pivots. Every workbook visualization is based on a dataset, and you can use one dataset across multiple workbooks and visualizations. You can also use a different dataset for each visualization in a workbook. To create workbook visualizations, you need to use fields that are already part of the underlying dataset.
For more information about workbooks in SuiteAnalytics Workbook, see Creating a Workbook.
To create a workbook, use workbook.create(options). This method creates a workbook.Workbook object. You can also provide these optional parameters to : workbook.create(options):
-
description– A description that will show up in the SuiteAnalytics Workbook UI. Use this parameter only when you are creating a workbook using the Workbook Builder Plug-in. For more information, see Workbook Builder Plug-in. -
name– A name for the workbook, which will appear in the SuiteAnalytics Workbook UI. Use this parameter only when you are creating a workbook using the Workbook Builder Plug-in. -
pivots– The pivots for the workbook. Use workbook.createPivot(options) to create pivots. For more information, see Pivots. -
tables– The table views for the workbook. Use workbook.createTable(options) to create table views. For more information, see Table Views.
var myWorkbook = workbook.create({
description: 'A sample workbook',
name: 'My Workbook',
pivots: [myFirstPivot, mySecondPivot],
tables: [myFirstTable, mySecondTable]
});
You don't need to specify the dataset when creating a workbook. You specify the dataset when you create workbook visualizations using methods such as workbook.createTable(options) and workbook.createPivot(options).