Get Current Sublist Value in SuiteScript 2.1

TL;DR

You can obtain the value of a specific sublist field on the currently selected sublist line using the currentRecord module in SuiteScript 2.1. This is particularly useful for client scripts that need to interact with sublists on forms.

Method Description

The getCurrentSublistValue function returns the value of a given sublist field on the active line of a specified sublist. The value returned could be of types: number, date, string, array, or boolean.

Supported Script Types

• Client scripts

Governance

No governance limitations apply to this operation.

Parameters

The options parameter for this function is a JavaScript object that requires specific attributes:

Errors

When using this method, the following errors may occur:

• SSS_INVALID_SUBLIST_OPERATION: Triggered if a required argument is invalid or if the sublist is not editable.
• SSS_MISSING_REQD_ARGUMENT: Occurs when any required argument is missing or undefined.

Syntax

Here is how to correctly implement the getCurrentSublistValue in your SuiteScript:

1//Add additional code 
2...
3var sublistValue = objRecord.getCurrentSublistValue({
4    sublistId: 'item',
5    fieldId: 'item'
6});
7...
8//Add additional code

Make sure to replace 'item' with your actual sublist and field IDs as necessary.

Who This Affects

• Developers: Those writing client scripts that need to interact with sublists on customer forms.
• Administrators: Users managing SuiteScript within their NetSuite environment.

Key Takeaways

• The getCurrentSublistValue method allows you to retrieve field values from sublists.
• Both sublistId and fieldId parameters are mandatory.
• This method is critical for client-side operations in SuiteScript 2.1 scripts.