CurrentRecord.setMatrixSublistValue(options)

Method Description

Sets the value for the associated field in the matrix.

Sets a numeric value for rate and ratehighprecision fields.

Returns

currentRecord.CurrentRecord

Supported Script Types

Client scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/currentRecord Module

Since

2016.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
`options.sublistId`	string	required	The internal ID of the sublist that contains the matrix. This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser.	2016.2
`options.fieldId`	string	required	The internal ID of the matrix field. See Finding Internal IDs of Record Fields.	2016.2
`options.column`	number	required	The column number for the field.	2016.2
`options.line`	number	required	The line number for the field. Note that line indexing begins at 0 with SuiteScript 2.0.	2016.2
`options.value`	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: Text, Radio and Select fields accept string values. Checkbox fields accept boolean values. Date and DateTime fields accept Date values. Integer, Float, Currency and Percent fields accept number values.	2016.2

Parameter

Type

Required / Optional

Description

Since

options.sublistId

string

required

The internal ID of the sublist that contains the matrix.

This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser.

2016.2

options.fieldId

string

required

The internal ID of the matrix field.

See Finding Internal IDs of Record Fields.

2016.2

options.column

number

required

The column number for the field.

2016.2

options.line

number

required

The line number for the field. Note that line indexing begins at 0 with SuiteScript 2.0.

2016.2

options.value

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:

Text, Radio and Select fields accept string values.
Checkbox fields accept boolean values.
Date and DateTime fields accept Date values.
Integer, Float, Currency and Percent fields accept number values.

2016.2

Errors

Error Code	Thrown If
`INVALID_FLD_VALUE`	The `options.value` type does not match the field type.
`SSS_MISSING_REQD_ARGUMENT`	A required argument is missing or undefined.

Error Code

Thrown If

INVALID_FLD_VALUE

The options.value type does not match the field type.

SSS_MISSING_REQD_ARGUMENT

A required argument is missing or undefined.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/currentRecord Module Script Samples.

          //Add additional code 
...
objRecord.setMatrixSublistValue({
    sublistId: 'item',
    fieldId: 'item',
    column: 12,
    line: 3,
    value: true
});
... 
//Add additional code

Parameters

Errors

Syntax

Related Topics