Custom Tool Script Error Messages
When working with custom tool scripts, you may encounter various error messages that can help identify and resolve issues during development or deployment. The following sections provide common error messages along with their descriptions, so you can quickly understand what each message means and how it might affect your workflow.
Tool Error Messages
The following table lists error messages that can appear when custom tools are accessed or run:
|
Error Message |
Description |
|---|---|
|
Access denied. |
The user's role does not have access to the File Cabinet folder where the tools are located. Verify that access to the File Cabinet folder is not restricted for the role. For more information, see Restricting Access to File Cabinet Folders. |
|
Couldn't load modules in the custom tool script because it uses unsupported modules. Remove the unsupported modules from the script. |
The custom tool script uses one or more of the following unsupported SuiteScript modules: N/http, N/https, or N/sftp. |
|
Invalid call, the following required properties are missing: [parameter1, parameter2]") |
Some required parameters are missing. |
|
The script execution context creation failed due to the following issue: <error details> |
A critical error occurred during preparation, so the tool couldn't run. |
|
This tool is not allowed |
The tool needs a permission that the current session doesn't have. |
|
There was an unexpected error while executing the tool: <error details> |
The tool runs but fails on a line or throws an exception. |
|
Tool execution failed |
The tool doesn't return a result properly. |
SDF Validation Error Messages
The following table lists error messages that can appear when you deploy a SuiteCloud project that includes custom tool scripts:
|
Error Message |
Description |
|---|---|
|
An error occurred during custom tool RPC schema validation. |
Custom tool JSON-RPC schema validation failed when deploying a SuiteCloud project. |
|
The custom toolset <customToolSet> could not be prepared for RPC schema validation. |
The custom toolset could not be prepared for validation when deploying a SuiteCloud project. |
|
The custom toolset RPC schema file <file> is not a valid RPC schema JSON file. |
The JSON-RPC schema file could not be parsed when deploying a SuiteCloud project. |
|
Unsupported property "<property>" at <path>. Supported properties are: <properties>. |
The JSON-RPC schema includes a property that is not supported 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 |
|
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 points 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 |