Locking Custom Objects with SDF in NetSuite

Learn how to lock custom objects using SDF in NetSuite, enhancing security and control over SuiteApp deployments.

·2 min read·6 views·View Oracle Docs

Locking custom objects in SuiteCloud Development Framework (SDF) enhances security and control for SuiteApp deployments. This article explains how to implement locking preferences in your locking.xml file and discusses the implications for various custom object types. Understanding these aspects is vital for developers looking to manage custom objects effectively.

How to Lock a Custom Object Using SDF

To lock a custom object in an SDF project, you can define locking preferences in a locking.xml file. Below is an example of how to lock a custom object, specifically a custom list.

XML Example

The following code snippet illustrates the locking setup for the customlist_example1 object:

xml
<preference type="LOCKING" defaultAction="UNLOCK">
<apply action="LOCK">
<object>customlist_example1</object>
</apply>
</preference>

Lockable SDF Custom Objects

Certain custom objects can be locked within SDF. The following table summarizes the various SDF custom object types that can be locked along with the impact of locking:

Object TypeNotes
customlistValues cannot be added, edited, or deleted in locked custom lists in target accounts.
customrecordtype- ID of a locked custom record cannot be changed or deleted.
  • Original custom field IDs cannot be changed or deleted.
  • Custom fields cannot be added. | | customsegment | Locking requires applying the lock to both the custom segment and its associated record type. | | Custom Fields | Administrators can control access via form customization. | | Forms | New instances can be created and customized. | | Plug-ins | Locked plug-ins can be configured; original custom field IDs on scripts cannot be deleted. | | prompt | Locked prompts show a Customize link instead of Edit; changes are restricted. | | savedsearch | Users can create copies and customize filters and columns. | | Workflows | Basic information can be edited, but definitions and states cannot be altered. |

Who This Affects

  • Developers: Understanding locking practices is essential to ensuring functionality and security of SuiteApps.
  • Administrators: Will need to manage permissions regarding locked objects effectively.

Key Takeaways

  • Locking custom objects enhances security in SuiteCloud Development Framework deployments.
  • The locking.xml file is crucial for implementing object locks effectively.
  • Different custom objects have varying restrictions when locked, affecting how they can be managed across deployments.

Source: This article is based on Oracle's official NetSuite documentation.

Frequently Asked Questions (4)

Do I need to enable a feature flag for locking custom objects in SDF in NetSuite 2026.1?
The article doesn't specify a need for enabling a feature flag, but it discusses the use of an XML configuration file to lock custom objects.
What permissions are required to lock custom objects in SuiteCloud Development Framework?
The article does not provide specific information about the permissions required to lock custom objects. It focuses on the XML configuration process.
How does locking custom objects in SDF interact with existing custom list setups?
Locking custom objects ensures that unauthorized changes are prevented, meaning that existing custom lists can be protected from modifications through this configuration.
Will configuring custom object locking settings affect existing workflows in NetSuite?
The article does not explicitly address how this will affect existing workflows. It primarily explains how to set locking preferences to enhance security and control over custom objects.

Weekly Update History (1)

SuiteCloud Development Frameworkupdated

Updated the Lockable SDF Custom Objects section in Locking SDF Custom Objects in the SuiteApp Type of SuiteCloud Project to add prompt and textenhanceaction object types to the list of lockable object types in SuiteApps.

View Oracle Docs
Source: Locking a Custom Object using SDF Example 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 SuiteCloud Development Framework

View all SuiteCloud Development Framework articles →