SDF Validation Errors for Custom Tool Scripts

Diagnose SDF validation messages for custom tool scripts, RPC schema files, tool definitions, and UI resources in SuiteCloud projects.

·4 min read·View Oracle Docs

When a SuiteCloud project includes custom tool scripts, deployment can fail during custom tool RPC schema validation. The messages identify failures to prepare a toolset, parse an RPC schema JSON file, validate tools or inputSchema values, or resolve UI resources. Use the file, tool, property, or path named in the message to review the relevant definition before deploying again.

What triggers custom tool RPC schema validation errors?

These messages can appear when deploying a SuiteCloud project that includes custom tool scripts. The documented validation failures fall into four areas:

  • Preparing a custom toolset for RPC schema validation
  • Parsing a custom toolset RPC schema file as RPC schema JSON
  • Validating schema properties, tool definitions, and inputSchema values
  • Validating UI-resource references for a tool

Some messages identify a specific schema file, tool, script file, property, path, or UI resource. Those placeholders point to the definition involved in the reported validation failure.

Which SDF validation messages can appear?

Error messageWhat it means
An error occurred during custom tool RPC schema validation.Custom tool JSON-RPC schema validation failed during deployment of a SuiteCloud project.
The custom toolset <customToolSet> could not be prepared for RPC schema validation.The custom toolset could not be prepared for validation during deployment.
The custom toolset RPC schema file <file> is not a valid RPC schema JSON file.The JSON-RPC schema file could not be parsed during deployment.
Unsupported property "<property>" at <path>. Supported properties are: <properties>.The JSON-RPC schema includes an unsupported property at the specified path.
The custom toolset RPC schema file <file> defines tool <tool>, but script file <scriptFile> does not export a method with the same name.The JSON-RPC schema defines a tool that does not match an exported method in the script file.
The custom toolset RPC schema file <file> defines duplicate tool name <tool>.More than one tool in the JSON-RPC schema uses the same tool name.
The custom toolset RPC schema file <file> defines tool <tool> with an invalid inputSchema.The tool definition has an invalid inputSchema.
The custom toolset RPC schema file <file> defines UI resource <resourceUri> for tool <tool>, but file <filePath> does not exist in the File Cabinet.The UI resource points to a file that does not exist in the File Cabinet.
The custom toolset RPC schema defines an invalid UI resource for tool <tool>.The UI resource path is not valid for the custom toolset. For example, the path can point outside the SuiteApp folder.
The custom toolset RPC schema file <file> defines UI resource <resourceUri> for tool <tool>, but UI resources must reference .html files.The UI resource must reference an .html file.

How should you review each error?

Start with the validation message rather than treating all custom tool deployment failures as the same issue.

  • Schema file cannot be parsed: Review the named RPC schema file when the message says it is not a valid RPC schema JSON file.
  • Unsupported property: Review the reported property at the reported path and compare it with the supported properties listed in the error.
  • Tool and script mismatch: Compare the tool defined in the schema with the method exported by the named script file. The message is raised when they do not have the same name.
  • Duplicate tool name: Review tool definitions in the JSON-RPC schema for more than one use of the reported tool name.
  • Invalid inputSchema: Review the inputSchema for the tool named in the message.
  • Missing UI-resource file: Confirm that the File Cabinet contains the file identified by <filePath>.
  • Invalid UI resource: Review the UI-resource path for the named tool. The documented example of an invalid path is one that points outside the SuiteApp folder.
  • Wrong UI-resource file type: Change the UI-resource reference so that it references an .html file.

A failure to prepare the custom toolset or the general RPC schema validation error does not identify a more specific condition in the message itself. Review any accompanying validation message that identifies a schema file, tool, property, path, script file, or UI resource.

Who This Affects

  • Teams deploying SuiteCloud projects that include custom tool scripts
  • Owners of custom toolset RPC schema files
  • Developers responsible for methods exported by the script files named in tool definitions
  • Teams maintaining File Cabinet files referenced as custom tool UI resources

Key Takeaways

  • These validation messages can appear during deployment of SuiteCloud projects that include custom tool scripts.
  • A tool defined in the RPC schema must match a method with the same name exported by the script file.
  • Duplicate tool names and invalid inputSchema values can cause validation failures.
  • UI resources must point to existing File Cabinet files and must reference .html files.
  • The property, path, file, tool, or resource shown in a message identifies the definition to review.

Frequently Asked Questions (4)

Which deployments can trigger custom tool RPC schema validation errors?
These validation messages appear when deploying SuiteCloud projects that include custom tool scripts. The documented failures occur while preparing a custom toolset, parsing an RPC schema JSON file, validating schema properties/tool definitions/inputSchema values, or validating UI-resource references.
If I see the message that a custom toolset RPC schema file is not a valid RPC schema JSON file, what should I check?
That message means the JSON-RPC schema file could not be parsed during deployment. Review the named RPC schema file for JSON syntax or structure errors and fix the schema before deploying again.
What causes the error that a tool defined in the RPC schema does not match an exported method in the script file?
The error occurs when the JSON-RPC schema defines a tool name that does not match a method exported by the named script file. Compare the tool name in the schema with the method exported by the script file and make them identical.
What are common UI resource validation failures and how should I address them?
Common failures include the referenced file not existing in the File Cabinet, the UI-resource path being invalid (for example pointing outside the SuiteApp folder), and the resource referencing a non-.html file. Confirm the File Cabinet contains the named file, ensure the path is valid and inside the SuiteApp folder, and change the resource to reference an .html file.
Source: SDF Validation Error Messages 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 →