Set Sublist Field Values in SuiteScript 2.x

Setting sublist field values is crucial in SuiteScript development as it allows you to manage and modify record data effectively. This article covers the methods and parameters involved in setting sublist field values in SuiteScript 2.x, catering to both standard and dynamic modes.

What Are Sublist Field Values?

Sublist field values represent specific data entries within a sublist of a record in NetSuite. These can include line items in a Sales Order or inventory details in an Item record.

How to Set Sublist Field Values

In SuiteScript, you can set sublist field values using different methods depending on the script mode.

Standard Mode

In standard mode, values are not validated until the record is saved. This allows for easier manipulation but lacks real-time validation.

Dynamic Mode

In dynamic mode, values are validated in real-time akin to user interactions in the NetSuite UI. It’s important to set field values in the correct order to avoid conflicts, as setting certain fields can override others based on dependencies.

Methods to Set Sublist Values

In SuiteScript 2.x, use the setSublistValue method to set a value in a sublist field. Here’s how to use it:

Syntax Example

Here’s a sample syntax to illustrate how to set a sublist field value:

1// Set a sublist field value example
2objRecord.setSublistValue({
3    sublistId: 'item',
4    fieldId: 'item',
5    line: 3,
6    value: true
7});

Parameters

The parameters for setSublistValue include:

Important Notes

• Field Types: Ensure the value type matches the field type you are setting. For instance, text fields accept strings, while checkbox fields require boolean values.
• Validation: If you attempt to set a value that doesn’t match the field type, an error will be thrown.

Errors

Be aware of common errors that may arise:

• INVALID_FLD_VALUE: Thrown when the value type does not match the expected field type.
• SSS_INVALID_SUBLIST_OPERATION: Indicates an invalid argument or an uneditable sublist.
• SSS_MISSING_REQD_ARGUMENT: Occurs when a required argument is absent.

Who This Affects

This functionality primarily impacts:

• SuiteScript Developers who are creating or modifying records.
• NetSuite Administrators managing custom scripts.

Key Takeaways

• Utilize setSublistValue for sublist field manipulations in SuiteScript 2.x.
• Understand the differences between standard and dynamic modes when working with records.
• Ensure matching data types when setting values to prevent runtime errors.