Dataset Builder Plug-in Interface Overview

Important:

The Dataset Builder Plug-in interface uses SuiteScript 2.0 or 2.1, and your entry point and library scripts need to use SuiteScript 2.0 or 2.1, too. For information, see SuiteScript 2.x Script Creation Process, SuiteScript 2.x, and SuiteScript 2.1.

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

Dataset Builder Plug-ins let you create custom datasets that fit your business needs. You can override the createDataset() function and create a dataset that contains a specific subset of data or uses custom logic. For example, you can create a dataset based on user-specific or role-specific information. The default behavior in the N/dataset module doesn’t let you do this. Datasets you make with the N/dataset module are static and can’t use dynamic information like the current role, user, and so on.

You can create custom datasets 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 Dataset Builder Plug-in Interface Definition.

Dataset 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.

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

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

NetSuite Role

Help Topics

Developer

Developing a Dataset Builder Plug-in

Administrator

Administering a Dataset Builder Plug-in

Related Topics

General Notices