CurrentRecord Object Members in...

The CurrentRecord object is crucial for SuiteScript developers as it allows access to the active record in the current client context. This dynamic object operates in real-time and is essential for client-side scripting.

How Does the CurrentRecord Module Work?

The N/currentRecord module is utilized in various client scripts to interact with the record currently active on the user's interface. It's important to note that while in view mode, the current record becomes read-only, and any set APIs will not function.

You can access the currentRecord module in two types of scripts:

Entry Point Client Scripts: These scripts automatically receive a currentRecord object without needing explicit loading of the N/currentRecord module. To access it, you simply create a variable initialized to scriptContext.currentRecord in your script.
Client Custom Modules: Unlike entry point scripts, these require you to manually load the N/currentRecord module and retrieve the currentRecord object with methods like currentRecord.get() or currentRecord.get.promise().

Members of the CurrentRecord Module

Below are the key members of the currentRecord module, categorized as methods and properties:

Methods

Method	Return Type	Supported Script Types	Description
`cancelLine(options)`	`currentRecord.CurrentRecord`	Client scripts	Cancels changes to the selected line in the sublist.
`commitLine(options)`	`currentRecord.CurrentRecord`	Client scripts	Commits changes for the selected line.
`getCurrentSublistValue(options)`	`number	Date	string
`setValue(options)`	`currentRecord.CurrentRecord`	Client scripts	Sets the value of a specified field.
`getField(options)`	`currentRecord.Field`	Client scripts	Retrieves a field object from the record.

Properties

Property	Return Type	Description
`id`	`number` (read-only)	Returns the internal record ID.
`type`	`string` (read-only)	Indicates the record type.
`isDynamic`	`boolean` (read-only)	Indicates if the record is dynamic.

Best Practices for Using the CurrentRecord Module

Use in Client Scripts: The currentRecord module is designed specifically for client scripts. Use the N/record module for server-side scripts or if you need to manipulate other records.
Handle Read-Only Mode Carefully: When the current record is viewed in read-only mode, ensure your script accounts for this to avoid errors.
Dynamic Mode Awareness: Familiarize yourself with dynamic scripting behaviors to properly sequence setting field values, as these can affect how values are processed in real-time.

Who This Affects

Developers: Those implementing or maintaining SuiteScript client scripts.
Administrators: Professionals configuring SuiteScript for business processes.

Key Takeaways

The currentRecord module is vital for managing the active record in client scripts.
Always consider the mode (view/edit) for effective script execution.
Utilize the appropriate methods and properties to interact with record data efficiently.

Frequently Asked Questions (4)

Does the CurrentRecord object allow modifications when the record is in view mode?

No, when the record is in view mode, it becomes read-only, and set APIs will not function.

What are the supported script types for the commitLine method in the CurrentRecord module?

The commitLine method is supported in client scripts.

How can I access the currentRecord object in a client custom module?

In a client custom module, you need to manually load the N/currentRecord module and retrieve the currentRecord object using methods like currentRecord.get() or currentRecord.get.promise().

Is the dynamic mode property of CurrentRecord always available?

Yes, the isDynamic property is a read-only indicator available on the CurrentRecord object, showing if the record is dynamic.

CurrentRecord Object Members in SuiteScript 2.1 Reference