itemcustomfield
For information about developing itemcustomfield SDF custom objects, see Custom Item Fields as XML Definitions.
Attributes
Name |
Type |
Required / Optional |
Description |
---|---|---|---|
scriptid |
string |
Required |
This attribute value can be up to 38 characters long. The default value is ‘custitem’. |
Fields
Name |
Type |
Required / Optional |
Description |
---|---|---|---|
fieldtype |
single-select list |
Required |
For information about possible values, see generic_customfield_fieldtype. The default value is 'TEXT'. |
label |
single-select list |
Required |
This field value can be up to 200 characters long. This field accepts references to the string custom type. |
selectrecordtype |
single-select list |
Required (conditionally) |
This field is mandatory when the fieldtype value is equal to any of the following lists or values: SELECT, MULTISELECT. This field accepts references to the following custom types: For information about other possible values, see generic_customfield_selectrecordtype. |
applyformatting |
boolean |
Optional |
The default value is T. |
defaultchecked |
boolean |
Optional |
The default value is F. |
defaultselection |
single-select list |
Optional |
This field accepts references to the following custom types: |
defaultvalue |
string |
Optional |
|
description |
string |
Optional |
|
displaytype |
single-select list |
Optional |
For information about possible values, see generic_customfield_displaytype. The default value is 'NORMAL'. |
dynamicdefault |
single-select list |
Optional |
For information about possible values, see generic_customfield_dynamicdefault. |
help |
single-select list |
Optional |
This field accepts references to the string custom type. |
linktext |
string |
Optional |
|
minvalue |
string |
Optional |
|
maxvalue |
string |
Optional |
|
storevalue |
boolean |
Optional |
The default value is T. |
accesslevel |
single-select list |
Optional |
For information about possible values, see generic_accesslevel_searchlevel. The default value is '2'. |
checkspelling |
boolean |
Optional |
The default value is F. |
encryptatrest |
boolean |
Optional |
The default value is F. |
displayheight |
integer |
Optional |
This field value must be greater than or equal to 0. |
displaywidth |
integer |
Optional |
This field value must be greater than or equal to 0. |
globalsearch |
boolean |
Optional |
The default value is F. |
isformula |
boolean |
Optional |
The default value is F. |
ismandatory |
boolean |
Optional |
The default value is F. |
maxlength |
string |
Optional |
|
onparentdelete |
single-select list |
Optional |
For information about possible values, see generic_customfield_onparentdelete. |
searchcomparefield |
single-select list |
Optional |
For information about possible values, see generic_standard_field. |
searchdefault |
single-select list |
Optional |
This field accepts references to the savedsearch custom type. |
searchlevel |
single-select list |
Optional |
For information about possible values, see generic_accesslevel_searchlevel. The default value is '2'. |
showhierarchy |
boolean |
Optional |
The default value is F. |
showinlist |
boolean |
Optional |
The default value is F. |
sourcefilterby |
single-select list |
Optional |
This field accepts references to the itemcustomfield custom type. For information about other possible values, see generic_standard_field. |
sourcefrom |
single-select list |
Optional |
This field accepts references to the itemcustomfield custom type. For information about other possible values, see generic_standard_field. |
sourcelist |
single-select list |
Optional |
This field accepts references to the itemcustomfield custom type. For information about other possible values, see generic_standard_field. |
isparent |
boolean |
Optional |
The default value is F. |
parentsubtab |
single-select list |
Optional |
This field accepts references to the following custom types: For information about other possible values, see generic_tab_parent. |
subtab |
single-select list |
Optional |
This field accepts references to the subtab custom type. For information about other possible values, see generic_item_tab. |
appliestogroup |
boolean |
Optional |
The default value is F. |
appliestokit |
boolean |
Optional |
The default value is F. |
appliestoinventory |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the INVENTORY feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. INVENTORY must be enabled for this field to appear in your account. |
appliestoitemassembly |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the ASSEMBLIES feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. ASSEMBLIES must be enabled for this field to appear in your account. |
appliestononinventory |
boolean |
Optional |
The default value is F. |
appliestoothercharge |
boolean |
Optional |
The default value is F. |
appliestopricelist |
boolean |
Optional |
The default value is F. |
appliestoservice |
boolean |
Optional |
The default value is F. |
appliestospecificitems |
boolean |
Optional |
The default value is F. |
appliestosubplan |
boolean |
Optional |
The default value is F. |
appliestoexpense |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the CHARGEBASEDBILLING feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. CHARGEBASEDBILLING must be enabled for this field to appear in your account. |
includechilditems |
boolean |
Optional |
The default value is F. |
itemmatrix |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the MATRIXITEMS feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. MATRIXITEMS must be enabled for this field to appear in your account. |
ismhitemattribute |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the MERCHANDISEHIERARCHY feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. MERCHANDISEHIERARCHY must be enabled for this field to appear in your account. |
itemsubtype |
single-select list |
Optional |
For information about possible values, see itemcustomfield_itemsubtype. |
Structured Fields
Structured fields are elements that usually contain subfields or groups of fields. They are similar to regular fields but have their own embedded structure. The following structured fields are supported: