Configure a NetSuite Catalog for Parent-Child Business Objects

Before you can create a layout or layouts from a NetSuite service that references parent and child business objects, you'll first need to import the catalog and manually add the required child business objects. The NetSuite service metadata document does not provide child paths.

You'll need to complete this task if you want to create a Form-over-Table layout or a Table layout with one or more dependent layouts at the child level.

Suppose you want to create a Form-over-Table layout with a "Sales Order" business object in the form and the child business object, "Items", in the table. Because the NetSuite service metadata document doesn't provide the child path, you won't see the Items child object in the New Layout Setup wizard when you try to create your Form-over-Table layout.

Instead, you need to start by importing the catalog, then adding the child object. When you do this, you'll provide the collection and item paths as well as configure path parameters. You'll also need to add all required fields for the child object.

For more information about parent and child path requirements, see Requirements for Dependent Layouts.

Note:

This task covers adding a child business object, configuring it, and then adding fields. Before you begin, import your catalog as described in Import a Business Object Catalog.

To configure a child business object for a NetSuite catalog:

  1. Add a child business object to the catalog:
    1. Open your new catalog, then open the Business Object Editor for the parent object, "Sales Order".
    2. From the Children tab, click Add Child Business Object (Add Child Business Object icon).
  2. Configure your new child object:
    1. Open the new child business object in the Business Object Editor, then provide details such as a title and description for the business object.
    2. Enter the collection and item paths for the child object.

      The collection and item paths may look like this for an Item object.



    3. Click the Edit buttons for each path, then edit the path parameters from the Path Editor.

      Add all REST request methods that are supported by the services. This image shows the GET method configured for the collection path.



    4. From Download tab, make these changes:
      • Leave the Offset Parameter Name and Limit Parameter Name fields empty.
      • Enter "items" in the Response Payload Items Member Name" field.
  3. Add fields for the child object from the Fields tab of the editor. For information about available fields, see NetSuite REST API Browser.

    This image shows configured fields for the Items child object.



When you are finished, create your layouts in the usual way. You'll see the nearly-added child business object in the New Layout Setup wizard when prompted to choose a child business object for the table part of a Form-over-Table layout or for a dependent layout. See Create a Table Layout in an Excel Workbook or Create a Form-over-Table Layout in an Excel Workbook.

Note:

When the business user edits the form, the downloaded data may be marked as invalid. If these two conditions are met, then clear the value and upload changes:

  • The cell value is not changed after download but is still marked as invalid.
  • The field's Omit from payload if value is empty check box is selected.