Workbooks as XML Definitions

Important:

Do not modify the contents of the definition structure or its character data. Modifications may damage the workbook data when you deploy the modified object to a target NetSuite account.

You should use NetSuite to modify custom workbooks rather than using SDF to modify workbook objects. After you save your changes in NetSuite and re-import the workbook into your SuiteCloud project, the workbook object gets updated safely and automatically.

Custom workbooks can be created or modified only by using NetSuite. After the workbooks are created, they can be either imported into a SuiteCloud project or deployed to a target NetSuite account. For more information about creating or modifying a custom workbook, see:

To import a custom workbook into a SuiteCloud project for SuiteCloud Development Framework (SDF), you must import two SDF custom object types that share a common script ID suffix — a workbook and a dataset. Both objects are required to represent a single custom workbook. For more information, see:

Usage Requirements and Prerequisites

You must use the Administrator role to import or deploy custom workbooks with SDF. To use the Administrator role with SDF, install the SuiteCloud Development Integration bundle in a NetSuite account, create an access token, and set your preferred SuiteCloud SDK tool to use token-based authentication. For more information, see:

In addition to using the Administrator role for development, enable the SuiteAnalytics Workbook feature in the target NetSuite account to be able to import and deploy workbooks with SDF. For more information, see Enabling SuiteAnalytics Workbook in Your NetSuite Account.

Related Topics

General Notices