CrmCustomField

Namespace: urn:customization.setup.webservices.netsuite.com

Fields

NameTypeCardinalityLabelRequiredHelp
accessLevel CustomizationAccessLevel 0..1 Set the level of access you want to given to this field by default: * Edit – The field and its contents can be viewed and changed. * View – The field can be seen, but its contents cannot be changed. * None – The field cannot be seen, and its contents cannot be changed. You can set the access level for specific roles, department, and subsidiaries below.
appliesPerKeyword boolean 0..1 Check this box to apply this custom field to individual keyword campaigns.
appliesToCampaign boolean 0..1 Check this box to have your custom field appear on campaign records.
appliesToCase boolean 0..1 Check this box to apply this custom field to case records.
appliesToEvent boolean 0..1 Check this box to apply this custom field to event records.
appliesToIssue boolean 0..1 Check this box to apply this custom field to issue records.
appliesToMfgProjectTask boolean 0..1 Check this box to include this custom field on the record. This field can show on events, project tasks, or manufacturing operation tasks.
appliesToPhoneCall boolean 0..1 Check this box to apply this custom field to phone call records.
appliesToProjectTask boolean 0..1 Check this box to apply this field to project task records.
appliesToSolution boolean 0..1 Check this box to apply this custom field to solution records.
appliesToTask boolean 0..1 Check this box to apply this custom field to task records.
availableExternally boolean 0..1 Check this box to make this custom field available on your external case form.
availableToSso boolean 0..1
checkSpelling boolean 0..1 Check this box to enable the spell check function for this field.
customSegment RecordRef 0..1
defaultChecked boolean 0..1 If this custom field is a check box, check this box to have the field appear checked by default. The field can still be unchecked if it is not locked.
defaultSelection RecordRef 0..1 Choose the selection list to display in the custom field by default. The choices are limited to the list selected in the List/Record field when creating this custom field.
defaultValue string 0..1 Enter a default value to appear in this custom field. This value can still be changed if the field is not locked.
deptAccessList CustomFieldDepartmentAccessList 0..1
description string 0..1 Enter a description of this field.
displayHeight long 0..1 Enter a height in number of lines for the custom field.
displayType CustomizationDisplayType 0..1 Choose the type of display you want this field to have: * Normal - Can be edited. You can use this field with custom code calculations, defaulting and sourcing information. * Disabled - Cannot be edited. You can use this field with custom code calculations, defaulting and sourcing information only. Any field with a display type of disabled that does not have default, sourced or custom code information will not display on forms. Note: You cannot disable a mandatory field unless the field has a default value. * Inline Text - For informational purposes only. The information in this field is the result of custom code calculation, defaulting or sourcing information only. Inline text field of the List/Record or Check Box type are not available for use with custom code. These fields are also not available for transaction column fields. * Hidden - Cannot be seen on the record or transaction you apply it to. You can perform a search to display the value of this field. The information in this field is the result of custom code calculations and defaulting information. You must use custom code or set a default for this field. Note that you can also define a field as shown in its custom field definition, and then selectively hide it on a form-by-form basis. In SuiteScript, only user event, scheduled, and Suitelet scripts can set the value of a custom field that has a display type of hidden. Warning: Hiding a custom field is a display convenience only. This is not field level security. Hidden custom fields are embedded in the page output and can be viewed in the page source.
displayWidth long 0..1 Enter a width in columns for your custom field.
dynamicDefault CustomizationDynamicDefault 0..1 Select a default option for this custom field.
filterList CrmCustomFieldFilterList 0..1
globalSearch boolean 0..1 Check this box to index this custom field for global search, so that this field's values are searched for matches to global search keywords, and records with matches are returned as global search results. If this box is unavailable, ensure that Store Value is checked. If it is still unavailable, global search indexing is not supported for the selected data type.
help string 0..1 Enter a brief explanation of the kind of information you want entered in this field. This help is available when the name of the field is clicked. You can enter HTML in this field, but be sure to begin the code with <html> and end it with </html>.
insertBefore RecordRef 0..1 Select the placement of this field on transactions in relation to other custom fields. This field lists custom CRM fields that have already been created. Note: This only affects the placement of fields on standard forms and on the placement of newly created fields. To change the arrangement of fields on a custom form, you must edit the custom form.
isFormula boolean 0..1 If enabled, the Default Value is set as a formula field. Formula fields use NetSuite Tags and SQL Expressions to dynamically calculate values based on field data in the system.
isMandatory boolean 0..1 Check this box to require this field on the records you applied the field to.
isParent boolean 0..1 If you are creating a List/Record custom field, check this box to indicate that the record type selected is a parent record. This field is used to create a parent-child relationship between two record types. For more information, see the help topic Understanding Parent-Child Record Relationships.
label string 0..1 Enter a name for this field that is meaningful to your users.
linkText string 0..1 Enter the text to display instead of a URL for hyperlink fields. Users will see this text instead of the URL. Clicking the text links to the URL.
maxLength long 0..1 Enter a maximum number of characters for free-form text and text area custom fields.
maxValue double 0..1 Enter a maximum value for decimal, integer number, and percent custom fields. The maximum amounts for percent fields can be greater than 100. If you do not enter a maximum value for a percent field, the maximum is 100.
minValue double 0..1 Enter a minimum value for decimal, integer number, and percent custom fields. The minimum amounts for percent fields can be less than zero. If you do not enter minimum value for a percent field, the minimum is 0.
owner RecordRef 0..1 Select the owner of this field. Only the owner can edit this record.
parentSubtab RecordRef 0..1
roleAccessList CustomFieldRoleAccessList 0..1
searchCompareField RecordRef 0..1 If you want to put the custom field on a form for a record type that is different from the summary search record type and you want values for this custom field to be based on summary search results, you can select a comparison field to join related records.
searchDefault RecordRef 0..1 If you want values for this custom field to be based on search results, select a summary search from the dropdown list.
searchLevel CustomizationSearchLevel 0..1 Choose the level of access you want given by default to this field on reports and search. * Edit – The field and its contents can be viewed and changed. * Run – The field can be seen, but its contents cannot be changed. * None – The field cannot be seen, and its contents cannot be changed. You can set the access level for specific roles, department, and subsidiaries below.
selectRecordType RecordRef 0..1 If you chose List/Record in the Type field, select a custom list or list of records to use with this field. You must choose List/Record in the Type field before you can select a list.
showInList boolean 0..1 Check this box to have this field display in CRM record lists and display as a report component field when customizing a report. The field only displays for the CRM records it is applied to.
showIssueChanges boolean 0..1 Check this box if you want changes to this custom field to be shown in the issue details.
sourceFilterBy RecordRef 0..1 Select the field to filter by. This field must be in the record type selected as the list/record.
sourceFrom RecordRef 0..1 Choose the name of the field you want to copy information from. You must choose a source list before you can choose your source field. The field you choose must match the type you chose in the Type field. For example, if you are sourcing from a Phone Number field, you must choose Phone Number in the Type field.
sourceList RecordRef 0..1 Choose the list you want to copy information from. 1. Company – include information from a field on company records 2. Contact – include information from contact records 3. Item – include information from item records on cases 4. Assigned – include information from the employee record that tasks or case are assigned to
storeValue boolean 0..1 This field is checked by default, meaning that information entered is stored in the custom field. Clear this box to indicate that any changes entered not be stored in the custom field. This enables you to look at data that is stored elsewhere. If you do not store the value, changes will be discarded, so you may want to make the field read-only. If the custom field is used for criteria in duplicate detection, you cannot clear the Store Value box.
subAccessList CustomFieldSubAccessList 0..1
subtab RecordRef 0..1 Choose the subtab where you want this field to appear. You can create new subtabs in the Subtabs section of the custom record type.
translationsList CustomFieldTranslationsList 0..1

Attributes

NameType
internalId string