Record.setCurrentSublistValue(options)
Method Description |
Sets the value for the field in the currently selected line. (dynamic mode only — see SuiteScript 2.x Standard and Dynamic Modes) When working in standard mode, set a sublist field using Record.setSublistValue(options).
Important:
When you edit a sublist line with SuiteScript, it triggers an internal validation of the sublist line. If the line validation fails, the script also fails. For example, if your script edits a closed catch up period, the validation fails and prevents SuiteScript from editing the closed catch up period. Sets a numeric value for rate and ratehighprecision fields. |
Returns |
|
Supported Script Types |
Client and server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Object Members |
|
Since |
2015.2 |
Parameters
The options parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
Since |
---|---|---|---|---|
|
string |
required |
The internal ID of the sublist. This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser. |
2015.2 |
|
string |
required |
The internal ID of a standard or custom sublist field. |
2015.2 |
|
number | Date | string | array | boolean |
required |
The value to set the field to. The value type must correspond to the field type being set. For example:
Note:
There may be a few exceptions to value and field type matching in SuiteScript. For example, the Role field on the Resource tab of project records is a multi-select field. However, in SuiteScript, this field can only accept one internal ID and does not accept an array of values. The only workaround to select multiple values for this field is to use the NetSuite UI. |
2015.2 |
|
boolean |
optional |
If set to By default, this value is |
2015.2 |
|
boolean |
optional |
Indicates whether to perform field sourcing synchronously. This parameter can be used to alleviate a timing situation that may occur in some browsers when fields are sourced. For some browsers, some APIs are triggered without waiting for the field sourcing to complete which could cause incorrect results. If set to Defaults to |
2019.1 |
Errors
Error Code |
Thrown If |
---|---|
|
A user tries to edit a read-only sublist field. |
|
The options.value type does not match the field type. |
|
A required argument is missing or undefined. |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/record Module Script Samples.
// Add additional code
...
objRecord.setCurrentSublistValue({
sublistId: 'item',
fieldId: 'item',
value: true,
ignoreFieldChange: true
});
...
// Add additional code