Workbook Builder Plug-in Interface Overview


The Workbook Builder Plug-in interface uses SuiteScript 2.0 or SuiteScript 2.1. Your entry point scripts and supporting library scripts must also use SuiteScript 2.0 or SuiteScript 2.1. For information, see SuiteScript 2.x Script Creation Process, SuiteScript 2.x, and SuiteScript 2.1.

Use a Workbook Builder Plug-in to customize the creation of workbooks for the Workbook API. For more information about the Workbook API, see the following help topics:

Workbook Builder Plug-ins let you create custom workbooks that fit your business needs. You can override the createWorkbook() function and create a workbook that contains a specific subset of data or uses custom logic. For example, you can create a workbook based on user-specific or role-specific information. The default behavior in the N/workbook module does not permit you to do this. Workbooks you create using the N/workbook module are static and cannot use dynamic information such as the current role, current user, and so on.

You can create custom workbooks that suit your needs by customizing the core plug-in logic. To accommodate this process, NetSuite provides an interface definition that describes the name, parameters, and return type of each function defined in the plug-in’s interface. For details, see Workbook Builder Plug-in Interface Definition.

Workbook Builder Plug-ins are supported by SuiteCloud Development Framework (SDF). SDF enables you to customize your NetSuite account from an integrated development environment (IDE) on your local computer. For details, see SuiteCloud Development Framework Overview.

You can customize a Workbook Builder Plug-in in SDF by defining workbookbuilderplugin objects. For details, see workbookbuilderplugin.

For more information about Workbook Builder Plug-ins, see the following help topics:

NetSuite Role

Help Topics


Developing a Workbook Builder Plug-in


Administering a Workbook Builder Plug-in

Related Topics

Workbook Builder Plug-in Interface Definition

General Notices