Validation and Deployment Errors
The following sections describe the errors that may occur when validating and deploying an SDF SuiteApp project that contains a single page application (SPA) object.
Missing Fields and Field Values
Error Message |
Scenario |
Solution |
---|---|---|
When the SuiteCloud project contains a singlepageapp, the manifest must define the SERVERSIDESCRIPTING feature as required. |
The |
Add the |
The object script ID must not be empty and must start with custspa. |
The |
Specify a script ID in the SPA object definition file and ensure that it starts with the prefix |
The object field name is missing. |
The |
Add the |
The object field name must not be empty. |
The |
Specify a value for the |
The object field url is missing. |
The |
Add the |
The object field url must not be empty. |
The |
Specify a unique value for |
The object field folder is missing. |
The |
Add the |
The object field folder must not be empty. |
The |
Specify a unique value for |
The object field clientscriptfile is missing. |
The |
Add the |
The object field serverscriptfile is missing. |
The |
Add the |
The object field clientscriptfile must not be empty. |
The value of the |
Specify a value for the |
The object field serverscriptfile must not be empty. |
The value of the |
Specify a value for the |
The linkcategory field is missing for the (link) subrecord. |
The |
Add the |
The linklabel field is missing for the (link) subrecord. |
The |
Add the |
The linkcategory field for the (link) subrecord must not be empty. |
The |
Specify a value for the |
The linklabel field for the (link) subrecord must not be empty. |
The |
Specify a value for the |
Incorrect Format
Error Message |
Scenario |
Solution |
---|---|---|
The scriptid value must be lowercase alphanumeric without spaces or punctuation. Underscores are permitted. |
The value for |
Ensure that the value for |
The script ID must not exceed 28 characters. |
The value for |
Ensure that the value for |
The name field contains more than the maximum number (1000) of characters allowed. |
The value for |
Ensure that the value for |
The description field contains more than the maximum number (1000) of characters allowed. |
The value for |
Ensure that the value for |
The url field contains more than the maximum number (1000) of characters allowed. |
The value for |
Ensure that the value for |
The URL cannot contain the following characters: ? ! * ' ( ) ; : @ & = +$ , / ? # [ ] . |
The value for |
Ensure that the value for |
The {folder value} folder value referenced by the folder object field must start and end with the '/' character and must not contain the following characters: ?, *, <, >, |, ', \\ . |
The value for |
Ensure that the value for |
The folder name, {folder name}, must not exceed 99 characters. |
The folder name has more than 99 characters. |
Ensure that the folder name is limited to 99 characters. |
The filename [filename] must not exceed 199 characters. |
The client script file name, including the file extension, has more than 199 characters. |
Ensure that the file name is limited to 199 characters, including the file extension. |
The filename [filename] must not exceed 199 characters. |
The server script file name, including the file extension, has more than 199 characters. |
Ensure that the file name is limited to 199 characters, including the file extension. |
The file {folder value}/SpaClient referenced by the field clientscriptfile is an invalid file type. The file name can only contain the following file extension(s): .js. Change the file name reference and then try again. |
The client script file does not have a file extension or has an incorrect file extension. |
Ensure that the client script file is a JavaScript file (.js). |
The file {folder value}/SpaServer referenced by the field serverscriptfile is an invalid file type. The file name can only contain the following file extension(s): .js. Change the file name reference and then try again. |
The server script file does not have a file extension or has an incorrect file extension. |
Ensure that the server script file is a JavaScript file (.js). |
The {assetsfolder} folder value referenced by the assetsfolder object field must start and end with the '/' character and must not contain the following characters: ?, *, <, >, |, ', \\. |
The value for |
Ensure that the value for |
The folder name, {<assets folder name>}, must not exceed 99 characters. |
The assets folder name has more than 99 characters. |
Ensure that the assets folder name is limited to 99 characters. |
The linklabel field contains more than the maximum number (30) of characters allowed. |
The |
Ensure that the value for |
The notifyemails field contains more than the maximum number (999) of characters allowed. |
The value for |
Ensure that the value for |
Duplicate Values
Error Message |
Scenario |
Solution |
---|---|---|
This URL already exists. Please enter a different one. |
The value for |
Specify a unique value for |
The URL <url> specified by the object field url is already referenced by another object. Select a different URL and try again. |
More than one SPA object is using the specified URL. Each SPA must have a unique URL. |
Specify a unique value for |
The folder <folder> referenced by the object field folder is already referenced by another object. Select a different folder and try again. |
The value for |
Specify a unique value for |
Duplicate values {linkcategory value} were found in the 'links' sublist on the 'singlepageapp' record. |
There is more than one |
Remove the duplicate values for the |
Invalid Values
Error Message |
Scenario |
Solution |
---|---|---|
The object field executeas must not be {x}. |
The value for |
Ensure that the value specified in Use uppercase letters when entering a generic role value. |
[ADMINISTRATOR] role cannot be used for the 'Execute As' field. Select a different value. |
The value entered for the |
Specify a role other than |
The object field loglevel must not be {x}. |
The value for |
Set |
The object field audienceroles must not be {x}. |
The value for |
Ensure that the value specified in Use uppercase letters when entering a generic role value. |
The audienceallroles field must be set to a valid Boolean value, 'T' or 'F'. |
The value for |
Set |
The object reference {executeas value/audienceroles value} is missing in the project and also not included in the dependencies list. |
The custom role referenced in the |
Ensure that the custom role referenced in |
The linkcategory field for the (link) subrecord must not be {linkcategory value}. |
The value in the |
Check the list of possible values for the center category in generic_centercategory. The |
The {linkcategory value} object referenced by the linkcategory field in the (link) subrecord is missing. |
The |
Check that the custom centercategory object that you are referencing in the |
The notifyuser field must be set to a valid Boolean value, 'T' or 'F'. |
The value for |
Set |
The notifyowner field must be set to a valid Boolean value, 'T' or 'F'. |
The value for |
Set |
The notifyadmins field must be set to a valid Boolean value, 'T' or 'F'. |
The value for |
Set |
The notifyemails field value is invalid. To include multiple addresses, separate them by commas. |
The |
Ensure that the email address specified is valid and entered in the correct format. Use a comma to separate multiple email addresses. |
Values Do Not Match
Error Message |
Scenario |
Solution |
---|---|---|
The script ID must match the file name (excluding the file extension). |
The |
Specify the same value for the SPA object file name ( |
The folder field in the {/ |
The |
Check that all of the following values match:
|
Reference File or Folder Does Not Exist
The following errors are thrown when a path in the SPA object definition file is incorrect or when the reference file or folder does not exist in the SuiteApp project folder.
Folder and file paths specified in the SPA object definition are absolute and must point to the SuiteApp project folder src/FileCabinet/SuiteApps/
<publisherid>.<projectid>
/
(where the transpiled and bundled source files of the SPA are located).
Error Message |
Scenario |
Solution |
---|---|---|
The SPA folder is not within the application folder. The folder field in the {/ |
The folder path in the |
Ensure that the SPA folder is inside your local SuiteApp project folder |
The folder {/ |
The SPA folder specified in the |
Ensure that the SPA folder has been created in your local project. |
The file {folder value}/SpaClient.js referenced by the object field clientscriptfile is missing. |
The client script file specified in |
Ensure that you have the SPA client script inside the SPA folder. |
The file {folder value}/SpaServer.js referenced by the object field serverscriptfile is missing. |
The server script specified in |
Ensure that you have the SPA server script inside the SPA folder. |
The folder {/ |
The assets folder specified in the |
Ensure that the folder has been created in your local project and is inside the SPA folder. |
The client script is not within the SPA folder. |
The client script path points to a different folder than the SPA folder. |
Check that the value in the |
The server script is not within the SPA folder. |
The server script path points to a different folder than the SPA folder. |
Check that the value in the |
The assets folder is not within the SPA folder. |
The assets folder path points to a different folder than the SPA folder. |
Check that the value in the |
/ |
The client script path points to a folder in a different application. |
Check that the value in the |
/ |
The server script path points to a folder in a different application. |
Check that the value in the |
The assetsfolder field in the {/ |
The assets folder path points to a folder in a different application. |
Check that the value in the |