Custom Workbook Objects

After importing a custom workbook, the workbook SuiteCloud Development Framework (SDF) custom object contains information about the pivot tables, table views, and charts.

The following is an example of a workbook object that was imported from NetSuite:

          <workbook scriptid="custworkbook_transaction">
    <name>Transaction Workbook</name>
        <pivot scriptid="custpivot3cbabf23b05847429b9994c169200800"></pivot>
        <pivot scriptid="custpivot3cbabf23b05847429b8d84a4c1692008"></pivot>
        <chart scriptid="custchart3224e33738e440089aea8960464b9999"></chart>
        <chart scriptid="custchart3224e33738e440089aea8960464b9740"></chart>
        <table scriptid="custviewfb73a08a7cb94c7e9edc78cb5c508765"></table>
        <table scriptid="custviewfb73a08a7cb94c7e9edc78cb5c507663"></table>


The workbook scriptid attribute and name element are respectively identical to the script ID and name of the custom workbook in the NetSuite account.

The pivots structure contains the script ID references to the pivot tables in the workbook. For information about creating workbook pivot tables in NetSuite, see Workbook Pivot Tables.

The charts structure contains the script ID references for the charts in the workbook. For information about creating workbook charts in NetSuite, see Workbook Charts.

The tables structure contains the script ID references for the tables views in the workbook. For information about creating workbook table views in NetSuite, see Workbook Table Views.

The dependencies structure of the workbook object only supports a single required dependency element. This element must reference the dataset object that is associated with this workbook object. Dataset objects contain additional information about custom workbooks. For more information, see Custom Dataset Objects.

The definition structure contains character data that is related to the pivots and charts from the workbook.


Do not modify the contents of the definition structure or its character data. Modifications may corrupt 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.

For more information about workbook objects, see workbook.

Related Topics

Workbooks as XML Definitions
Custom Dataset Objects

General Notices