Datasets

Note:

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

Datasets are the basis for all workbook visualizations in your account. In a dataset, you combine the fields of a root record type and any joined related record types to create a query. The record types and fields that you can access are based on the features enabled in your account and the permissions assigned to the role you use to log in to NetSuite.

For more information about datasets in SuiteAnalytics Workbook, see Defining a Dataset.

To create a dataset, use dataset.create(options). This method creates a dataset.Dataset object. When you use this method, only the type parameter is required, and it specifies the root record type that the dataset is based on. For this parameter, you can load the N/query module and use values from the query.Type enum:

          var myDataset = dataset.create({
    type: query.Type.CUSTOMER
});

Alternatively, if you do not want to load the N/query module, you can use the string equivalents of the query.Type for this parameter:

          var myDataset = dataset.create({
    type: 'customer'
});

Optionally, you can provide the following parameters for dataset.create(options):

columns – The columns (fields) in the dataset. Use dataset.createColumn(options) to create columns. For more information, see Columns.
condition – A condition (criteria) to be applied to the dataset. Use dataset.createCondition(options) to create conditions. For more information, see Conditions.
description – A description for the dataset. Use this parameter only when you are creating a dataset using the Dataset Builder Plug-in. For more information, see Dataset Builder Plug-in.
id – A script ID for the dataset. If you do not specify one, an ID is created automatically. Use this parameter only when you are creating a dataset using the Dataset Builder Plug-in.
name – A name for the dataset. Use this parameter only when you are creating a dataset using the Dataset Builder Plug-in.

          var myDataset = dataset.create({
    columns: myColumns,
    condition: myCondition,
    type: 'customer'
});

Related Topics