NetSuite Changelog
SuiteScriptSuiteScriptRecordsNew Feature

Record Object Members in SuiteScript for Effective Data Handling

Learn key Record object members in SuiteScript: name, primary key, properties for efficient data management.

·2 min read·View Oracle Docs

The Record object in SuiteScript provides essential properties for managing data efficiently within NetSuite. It includes crucial members such as the record name, primary key, and its properties, supporting server-side scripts for powerful data manipulation. This article describes these members in detail and explains their significance in SuiteScript development.

What Are Record Object Members?

The Record object members available for a workbook.Record object include:

Member NameTypeDescriptionSupported Script Types
Record.namestringThe name of the record type for the record.Server scripts
Record.primaryKeynumberThe primary key of the record.Server scripts
Record.propertiesObjectThe properties of the record.Server scripts

Detailed Member Descriptions

  • Record.name: This property returns the string value representing the record type's name. It is essential to identify the specific type of record you are working with in your scripts.

  • Record.primaryKey: This numeric property holds the primary key for the record, allowing for unique identification and referencing within operations.

  • Record.properties: This object contains the properties associated with the record, enabling developers to access and manipulate relevant data easily.

Usage Notes

When using these properties, keep in mind:

  • The Record.name property is read-only. Attempting to set its value after the workbook.Record object creation will lead to a READ_ONLY_PROPERTY error.

For more information on SuiteScript and workbook modules, check the SuiteScript 2.x Script Types documentation.

Frequently Asked Questions (4)

Are the Record object members in SuiteScript available for all types of scripts?
The Record object members such as name, primaryKey, and properties are primarily supported within server scripts according to the detailed description in the article.
Can I modify the value of the Record.name property in a SuiteScript?
No, the Record.name property is read-only. Attempting to modify it after the workbook.Record object creation will result in a READ_ONLY_PROPERTY error.
What is the significance of the Record.primaryKey in SuiteScript?
The Record.primaryKey is a numeric property that serves as a unique identifier for the record. It allows for referencing and identification within operations in SuiteScript.
What should developers be aware of when accessing Record.properties in SuiteScript?
The Record.properties object allows developers to access and manipulate record data easily. However, the article doesn't provide specific details on any limitations or additional considerations when using this property.
Source: Record Object Members — Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in SuiteScript

View all SuiteScript articles →