Sublists as XML Definitions

You can add a custom sublist to custom forms in SuiteCloud Development Framework (SDF). Custom sublists present information related to the record your user is viewing in NetSuite. The sublist is based on results from a saved search of the form record type or a related record type. For more information, see Custom Sublists.

SDF supports the following sublist types: CRM, Entity, Item, Transaction.

The scriptid attribute is required for the sublist root element. The default scriptid value is custsublist.

The following fields are required for custom sublists:

Field	Description
`label`	Specifies the label for the sublist. The label is the text that your users see as the name of the sublist when it is displayed on the form.
`savedsearch`	Specifies the saved search ID. For example: `<savedsearch>[scriptid=customsearch54]</savedsearch>` A field is required to filter the saved search. For example: `<field>STDEVENTCASESTATUS</field>`
`sublisttype`	Specifies the type of sublist. Possible values are CRM, ENTITY, ITEM, TRANSACTION. The sublisttype value cannot be changed after the sublist is created.

Field

Description

label

Specifies the label for the sublist. The label is the text that your users see as the name of the sublist when it is displayed on the form.

savedsearch

Specifies the saved search ID. For example:

                    <savedsearch>[scriptid=customsearch54]</savedsearch>

A field is required to filter the saved search. For example:

                    <field>STDEVENTCASESTATUS</field>

sublisttype

Specifies the type of sublist. Possible values are CRM, ENTITY, ITEM, TRANSACTION.

The sublisttype value cannot be changed after the sublist is created.

For information about all of the available fields, see sublist.

Important:

Each sublist object requires a reference to a savedsearch object and a field to filter the saved search. If the referenced savedsearch object is not included in your SuiteCloud project, ensure the manifest file is updated with the dependency. If your SuiteCloud project is a SuiteApp project, it must include the savedsearch object. Only account customization projects can exclude the savedsearch object from the SuiteCloud project.

If you are including the savedsearch object in your SuiteCloud project, the XML must be generated by NetSuite. Do not edit the savedsearch object in SDF.

CRM Custom Sublist Example

The following is an XML definition example of a custom CRM sublist object. When deployed to an account, a sublist called Cases to Address is displayed on the Related Info tab of forms for case records. The saved search customsearch54 is filtered by the field STDEVENTCASESTATUS.

            <sublist scriptid="custsublist_casesaddress">

  <call>F</call>

  <campaign>F</campaign>

  <case>T</case>

  <event>F</event>

  <field>STDEVENTCASESTATUS</field>

  <issue>F</issue>

  <label>Cases to Address</label>

  <savedsearch>[scriptid=customsearch54]</savedsearch>

  <solution>F</solution>

  <sublisttype>CRM</sublisttype>

  <tab>CRMRELATEDINFO</tab>

  <task>F/task>

/sublist>

Entity Custom Sublist Example

The following is an XML definition example of a custom Entity sublist object. When deployed to an account, a sublist called Customers to Call is displayed on the Marketing tab of forms for customer records. The saved search customsearch20 is filtered by the field STDENTITYCUSTTYPE.

            <sublist scriptid="custsublist_phonecalls">

  <contact>F</contact>

  <customer>T</customer>

  <employee>F</employee>

  <field>STDENTITYCUSTTYPE</field>

  <job>F</job>

  <label>Customers to Call</label>

  <partner>F</partner>

  <savedsearch>[scriptid=customsearch20]</savedsearch>

  <sublisttype>ENTITY</sublisttype>

  <tab>ENTITYMARKETING</tab>

  <vendor>F</vendor>

</sublist>

Item Custom Sublist Example

The following is an XML definition example of a custom Item sublist object. When deployed to an account, a sublist called Open Project Expenses is displayed on the Purchasing/Inventory tab of forms for othercharge records. The saved search customsearch51 is filtered by the field STDITEMPROJECTEXPENSETYPE.

            <sublist scriptid="custsublist_projectexpenses">

  <billofmaterials>F</billofmaterials>

  <field>STDITEMPROJECTEXPENSETYPE</field>

  <inventoryitem>F</inventoryitem>

  <itemgroup>F</itemgroup>

  <kit>F</kit>

  <label>Open Project Expenses</label>

  <noninventoryitem>F</noninventoryitem>

  <othercharge>T</othercharge>

  <savedsearch>[scriptid=customsearch51]</savedsearch>

  <service>F</service>

  <sublisttype>ITEM</sublisttype>

  <tab>ITEMPURCHASINGINVENTORY</tab>

</sublist>

Transaction Custom Sublist Example

The following is an XML definition example of a custom Transaction sublist object. When deployed to an account, a sublist called Recent Payments is displayed on the Payment tab of forms for payment records. The saved search customsearch26 is filtered by the field STDBODYPAYMENTMETHOD.

            <sublist scriptid="custsublist_recentpayments">

  <assemblybuild>F</assemblybuild>

  <deposit>F</deposit>

  <expensereport>F</expensereport>

  <field>STDBODYPAYMENTMETHOD</field>

  <inventoryadjustment>F</inventoryadjustment>

  <itemfulfillment>F</itemfulfillment>

  <itemreceipt>F</itemreceipt>

  <journal>F</journal>

  <label>Recent Payments</label>

  <opportunity>F</opportunity>

  <payment>T</payment>

  <purchase>F</purchase>

  <sale>F</sale>

  <savedsearch>[scriptid=customsearch26]</savedsearch>

  <sublisttype>TRANSACTION</sublisttype>

  <tab>TRANSACTIONPAYMENT</tab>

  <vendorpayment>F</vendorpayment>

</sublist>

For more information about custom sublists in SDF, see the following topics:

CRM Custom Sublist Example

Entity Custom Sublist Example

Item Custom Sublist Example

Transaction Custom Sublist Example

Related Topics