Custom Tool Script Requirements for NetSuite 2026.1

Starting in NetSuite 2026.1, there are significant updates to the custom tool script type and its corresponding SuiteCloud Development Framework (SDF) object. These enhancements include support for execution logs, which provide a vital resource for developers to monitor and analyze script performance.

What's New

This release introduces the ability to utilize execution logs in custom tool scripts, enhancing the script debugging process. Both new and existing custom tools must adhere to the updated specifications to ensure this logging feature functions effectively.

Key Changes

1. Execution Log Support: All custom tool scripts now support execution logs available on the Script Execution Logs page located at Customization > Scripting > Script Execution Logs.
2. Updated Script Requirements:
   • The script header must include the JSDoc tag @NScriptType CustomTool.
   • Entry point functions for each tool method must be declared as asynchronous.
3. New JSON Schema Requirements: Developers need to define properties for actions in their custom tools using a JSON schema.
4. SDF Object Specifications: Custom tools are defined within the SDF as toolset objects, requiring specific properties in the XML definition to operate correctly.

Development Guidelines

To create a custom tool script successfully, you must include:

• Custom Tool Script File: This file contains the SuiteScript code for your tool. Each method can be defined as a separate tool in the tool schema. Refer to the Custom Tool Script Best Practices for optimal structuring.
• Custom Tool JSON Schema: This JSON file outlines all the properties for the actions in your custom tool.
• Toolset SDF Object: An XML definition file that corresponds with your custom tool script. This is critical for integrating correctly within the SuiteCloud environment.
• Note that the modules N/http, N/https, and N/sftp are not supported within custom tool scripts.

Example Structure

Here’s a brief overview of the essential components:

1/**
2 * @NScriptType CustomTool
3 */
4 define(['N/record'], function(record) {
5     async function myToolMethod() {
6         // Your code here
7     }
8     return {
9         myToolMethod: myToolMethod
10     };
11 });

Ensure that your JSON schema file aligns with the specifications laid out in the documentation, as proper structure is crucial for performance.

Who This Affects

• Developers: Engaged in custom scripting and tool creation.
• Administrators: Managing deployments and ensuring compliance with current script versions.
• Technical Support Teams: Assisting users facing issues with custom tools.

Key Takeaways

• Custom tool scripts in NetSuite 2026.1 can utilize execution logging.
• Adhere to new specifications for both existing and new scripts.
• Include proper JSON schema and XML object definitions for successful implementation.
• Asynchronous functions are now mandatory for tool method entry points.
• Review Custom Tool Script Best Practices to optimize the script performance.