entitycustomfield
For information about developing entitycustomfield SDF custom objects, see Custom Entity Fields as XML Definitions.
Attributes
Name |
Type |
Required / Optional |
Description |
---|---|---|---|
scriptid |
string |
Required |
This attribute value can be up to 40 characters long. The default value is ‘custentity’. |
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 entitycustomfield custom type. For information about other possible values, see generic_standard_field. |
sourcefrom |
single-select list |
Optional |
This field accepts references to the entitycustomfield custom type. For information about other possible values, see generic_standard_field. |
sourcelist |
single-select list |
Optional |
This field accepts references to the entitycustomfield 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_entity_tab. |
appliestocontact |
boolean |
Optional |
The default value is F. |
appliestocustomer |
boolean |
Optional |
The default value is F. |
appliestoemployee |
boolean |
Optional |
The default value is F. |
appliestogenericrsrc |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the ADVANCEDJOBS 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. ADVANCEDJOBS must be enabled for this field to appear in your account. |
appliestogroup |
boolean |
Optional |
The default value is F. |
appliestoothername |
boolean |
Optional |
The default value is F. |
appliestopartner |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the CRM 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. CRM must be enabled for this field to appear in your account. |
appliestopricelist |
boolean |
Optional |
The default value is F. |
appliestoproject |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the JOBS 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. JOBS must be enabled for this field to appear in your account. |
appliestoprojecttemplate |
boolean |
Optional |
The default value is F. |
appliestostatement |
boolean |
Optional |
The default value is F. |
appliestovendor |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the ACCOUNTING 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. ACCOUNTING must be enabled for this field to appear in your account. |
appliestowebsite |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the WEBSITE 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. WEBSITE must be enabled for this field to appear in your account. |
availableexternally |
boolean |
Optional |
The default value is F. |
availabletosso |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the SUITESIGNON 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. SUITESIGNON must be enabled for this field to appear in your account. |
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: