Custom Lists as XML Definitions

A custom list is a list of values that you can use in custom fields on your forms and records. Custom lists enable you to set up predefined choices for your employees and customers to select when entering transactions and records. You can create an unlimited number of custom lists and an unlimited number of values for each list.

Create and manage custom lists using SuiteCloud Development Framework (SDF). You can model a custom list in a SuiteCloud project and deploy the project to a target NetSuite account. You can either create new custom lists in your project or import existing lists from a NetSuite account. For more information about working with custom lists in a NetSuite account, see Creating a Custom List.

A custom list object is comprised of the following:

Description – You can enter a description of the custom list in the Description field.
Inactive – You can make the list inactive by setting the isinactive value to T, or make it active by setting the isinactive value to F. An inactive list does not appear on any forms or in global searches, like a deleted list. You also cannot select this list from any lists on entities, items, or transactions.
Matrix option – You can make the list available on matrix items by setting the ismatrixoption value to T, or make it unavailable by setting the ismatrixoption value to F. If you designate the list as a matrix option list, you must create a unique abbreviation for each list value.

Warning:
If this field appears in the project, you must reference the MATRIXITEMS feature in the manifest file to avoid project warnings. In the manifest file, you can specify whether this feature is required in the target account. MATRIXITEMS must be enabled for this field to appear in the target account.
Ordered – You can sort your list by the order in which you enter them by setting the isordered value to T, or sort it by alphabetical order by setting the isordered value to F.
Name – You must have a name for the custom list.

Your custom list appears on custom fields when deployed to an account. The following is an XML definition example of a custom list. When deployed to an account, go to your custom field to select List/Record under Type, and select your custom list under List/Record. Under the Validation & Defaulting subtab, the Default Selection displays the values from your custom list that you can select:

          <customlist scriptid="customlist_accounttype">
      <description>Account type is used to distinguish between primary and secondary accounts.</description>
      <isinactive>F</isinactive>
      <ismatrixoption>F</ismatrixoption>
      <isordered>T</isordered>
      <name>Account Type</name>
      <customvalues>
         <customvalue scriptid="val_53391_399334_433">
            <abbreviation>P</abbreviation>
            <isinactive>F</isinactive>
            <value>Primary</value>
         </customvalue>
         <customvalue scriptid="val_53392_399334_459">
            <abbreviation>S</abbreviation>
            <isinactive>F</isinactive>
            <value>Secondary</value>
         </customvalue>
      </customvalues>
</customlist>

You can create custom values in a custom list. In a custom list object, custom values are grouped within the customvalues structure. In this structure, you can create as many custom values needed by specifying a customvalue structure for each one. For more information, see customvalue.

Your custom list can be used in custom fields on your forms and records. You can create custom fields in both SDF and NetSuite. For more information, see Creating a Custom Field.

For more information about custom lists, see the following topics:

Related Topics