Custom List Body Fields

The following custom list body fields are available for mapping:

ID

The field labeled “ID” on the Import Assistant mapping page corresponds to the scriptId element in customization.xsd. It is neither the Internal ID nor an External ID.

Important:

The Custom List record does not support the External ID field.

Custom List ID field.

The ID field is available only if Client SuiteScript and Server SuiteScript have been enabled at Setup > Company > Enable Features, on the SuiteCloud tab.

The value entered for the ID field must be unique.

Note:

The system adds the prefix customlist to whatever value you enter. For example, if you enter _listColors, the system saves the ID as customlist_listColors. This value can be used as an identifier for the record.

Inactive

A value of Yes makes the list unavailable to be selected as the List/Record of a new custom field. The default is No.

Internal ID

This field is available for mapping only if the import has a data handling option of Update, or Add or Update.

Matrix Option List

This field is available only if the Accounting Matrix Items feature has been enabled at Setup > Company > Enable Features, on the Items & Inventory tab. When the value is Yes, the system can display abbreviations for each value in the list. The default is No.

Name

The value for Name shows up in the form you use to create a new custom field, as a choice in the List/Record dropdown list (unless you have chosen a value of Yes for the custom list's Inactive field, which hides the list name from this view). The Name is not the user-facing label that ultimately appears on the custom form next to the list. (That label is the value you enter for the Label field on the custom field record.)

The illustration below shows where the name of the custom list appears when you create a new custom field, in this example, “List of days” in the List/Record dropdown list.

List of days highlighted on the Custom Entity Field page.

The Name field is required, and its value must be unique.

Owner

If you do not create a mapping for Owner, the system identifies you as the owner. The mapping page does not indicate you are mapped as owner, but the import sets you as the owner for all imported records. If you do not want to be set as owner, create a mapping that sets the Owner field to another user or to null.

Show options in order entered

A value of Yes places your custom list's values (which are defined by the Custom List Values sublist) in the order they are listed in the CSV import file. A value of No places the values in alphabetical order.

If you do not create a mapping for this field, the import sets the value to Yes. The mapping page does not indicate that this default is being chosen, but you can see it on the resulting record after the import.

For more details

For further details about fields that can be mapped, see the SOAP Schema Browser’s custom list reference page. However, note that the Convert to Custom Record field is not currently supported in the Import Assistant. With that exception, you can use the field definitions in the SOAP Schema Browser as a basis for creating your own CSV import template file. For information about working with the SOAP Schema Browser, see SOAP Schema Browser.

The Import Assistant is available at Setup > Import/Export > Import Tasks > Import CSV Records. After you select the record type for import, you choose the import character encoding. For more information, see Select a Record Type for Import and Choose Import Character Encoding.

Additional Information

Importing CSV Files with the Import Assistant
Guidelines for CSV Import Files
Tips for Successful CSV Imports
Custom Lists

Related Topics

Custom List Import
Custom List Sublist Data
Custom List CSV Multiple File Examples
Custom List CSV Single File Examples
Common Errors When Importing Custom Lists

General Notices