Workbooks

Note:

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

Workbooks are where you analyze the results of a dataset query by creating workbook visualizations such as table views and pivots. All workbook visualizations are based on a dataset, and a single dataset can be used in multiple workbooks and workbook visualizations. You can also use a different dataset for each visualization in a workbook. You can only create workbook visualizations using fields that have been added to 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 provide the following optional parameters to workbook.create(options):

description – A description 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. 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]
});

Note that you do not need to specify the underlying dataset when you create a workbook. You specify the dataset when you create workbook visualizations using methods such as workbook.createTable(options) and workbook.createPivot(options).

Related Topics