Get Current Sublist Value in SuiteScript 2.0

TL;DR Opening

This article covers how to leverage the getCurrentSublistValue method in SuiteScript 2.0 to access values from sublist fields effectively. Understanding this method is vital for SuiteScript developers working with dynamic record management.

What is the getCurrentSublistValue Method?

The getCurrentSublistValue method allows you to return the value of a specified field on the currently selected line of a sublist in a record. This is particularly useful in client scripts where user interaction involves sublists, such as items in a sales order.

Method Description

The method returns a value that can be one of several types, including number, Date, string, array, or boolean.

Supported Script Types

• Client scripts

Governance

• None

Module

• N/currentRecord Module

Parameters

The method accepts an options object as a parameter, which contains the following properties:

Error Codes

When using this method, the following errors may occur:

• SSS_INVALID_SUBLIST_OPERATION: This error is thrown if a required argument is invalid or the sublist is not editable.
• SSS_MISSING_REQD_ARGUMENT: This indicates that a required argument is missing or undefined.

Code Sample

Here’s a syntax example of how to use the getCurrentSublistValue method:

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

For a complete script example, refer to the N/currentRecord Module Script Samples.

Related Topics

• currentRecord.CurrentRecord
• N/currentRecord Module
• SuiteScript 2.x Modules

Key Takeaways:

• The getCurrentSublistValue method retrieves field values from active sublist lines.
• It requires parameters specifying the sublistId and fieldId.
• Common error codes include usage of invalid or missing arguments.