Workbook API
The Workbook API lets you manage your datasets and workbooks programmatically as part of SuiteAnalytics Workbook. You can do the following:
-
Create new datasets to define your data
-
Create dataset conditions and joins with other record types
-
Create new workbooks
-
Define workbook visualizations, such as pivots and table views
-
Run table views and obtain results
-
Load existing datasets or workbooks and manage them
You must enable the SuiteAnalytics Workbook feature to use the Workbook API.
The Workbook API includes the following components:
-
SuiteScript modules – The N/dataset, N/datasetLink, and N/workbook modules include all of the methods and objects you need to create and manage datasets and workbooks. The N/dataset module lets you define datasets to use for your workbooks. The N/dataset module is similar to the N/query module but is designed to work alongside the N/workbook module. You should use the N/dataset module to create all datasets you plan to use in the Workbook API. The N/datasetLink module lets you link datasets so you can use data from both datasets in workbook visualizations. The N/workbook module lets you create workbooks, define supporting workbook components, and run pivots. For more information, see N/dataset Module, N/datasetLink Module, and N/workbook Module.
-
Granular Workbook elements – The N/dataset and N/workbook modules let you work with granular components that represent different areas in the SuiteAnalytics Workbook UI. For example, when you use the N/workbook module to create a pivot, you can specify pivot-related properties such as name, pivot axes, and sorting behavior. You can also define limiting filters (which filter results based on a limiting number) and conditional filters (which filter results based on simple or complex criteria).
-
Core plug-ins – The new Dataset Builder Plug-in and Workbook Builder Plug-in let you provide custom implementations for creating datasets and workbooks. You can provide your own implementations with custom logic that meets your business needs. For more information, see Dataset Builder Plug-in and Workbook Builder Plug-in.
Getting Started with the Workbook API
The following table lists tasks and links to help you get started with the Workbook API.
|
Task |
Description |
Links |
|---|---|---|
|
Learn about the concepts in the Workbook API |
Several topics are available to help you understand dataset and workbook concepts before you start using the Workbook API. |
|
|
Follow a tutorial to create your first dataset |
A tutorial is available to help you create a basic dataset using the Workbook API. You can use this tutorial as a starting point to explore the features of the Workbook API. |
|
|
Follow a tutorial to create a workbook and visualizations |
A tutorial is available to help you create a workbook using the Workbook API, including a table view and pivot. |
|
|
Explore the objects and methods in the Workbook API |
The N/dataset, N/datasetLink, and N/workbook modules include all of the methods and objects you need to create and manage datasets and workbooks. |