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
Incorrect Format
Duplicate Values
Invalid Values
Values Do Not Match
Reference File or Folder Does Not Exist

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 `SERVERSIDESCRIPTING` feature is missing in the manifest.xml file.	Add the `SERVERSIDESCRIPTING` feature to the manifest.
The object script ID must not be empty and must start with custspa.	The `scriptid` is empty or it does not start with `custspa`.	Specify a script ID in the SPA object definition file and ensure that it starts with the prefix `custspa`.
The object field name is missing.	The `name` field is missing.	Add the `name` field and specify a value for it.
The object field name must not be empty.	The `name` field is empty.	Specify a value for the `name` field.
The object field url is missing.	The `url` field is missing.	Add the `url` field and specify a value for it.
The object field url must not be empty.	The `url` field is empty.	Specify a unique value for `url`.
The object field folder is missing.	The `folder` field is missing.	Add the `folder` field and specify a value for it.
The object field folder must not be empty.	The `folder` field is empty.	Specify a unique value for `folder`.
The object field clientscriptfile is missing.	The `clientscriptfile` field is missing.	Add the `clientscriptfile` field and specify a value for it.
The object field serverscriptfile is missing.	The `serverscriptfile` field is missing.	Add the `serverscriptfile` field and specify a value for it.
The object field clientscriptfile must not be empty.	The value of the `clientscriptfile` field is missing.	Specify a value for the `clientscriptfile` field.
The object field serverscriptfile must not be empty.	The value of the `serverscriptfile` field is missing.	Specify a value for the `serverscriptfile` field.
The linkcategory field is missing for the (link) subrecord.	The `link` sublist element is included in the SPA object definition, but there is no `linkcategory` field inside it.	Add the `linkcategory` field and specify a value for it.
The linklabel field is missing for the (link) subrecord.	The `link` sublist element is included in the SPA object definition, but there is no `linklabel` field inside it.	Add the `linklabel` field and specify a value for it.
The linkcategory field for the (link) subrecord must not be empty.	The `linkcategory` field is empty.	Specify a value for the `linkcategory` field.
The linklabel field for the (link) subrecord must not be empty.	The `linklabel` field is empty.	Specify a value for the `linklabel` field.

Error Message

Scenario

Solution

When the SuiteCloud project contains a singlepageapp, the manifest must define the SERVERSIDESCRIPTING feature as required.

The SERVERSIDESCRIPTING feature is missing in the manifest.xml file.

Add the SERVERSIDESCRIPTING feature to the manifest.

The object script ID must not be empty and must start with custspa.

The scriptid is empty or it does not start with custspa.

Specify a script ID in the SPA object definition file and ensure that it starts with the prefix custspa.

The object field name is missing.

The name field is missing.

Add the name field and specify a value for it.

The object field name must not be empty.

The name field is empty.

Specify a value for the name field.

The object field url is missing.

The url field is missing.

Add the url field and specify a value for it.

The object field url must not be empty.

The url field is empty.

Specify a unique value for url.

The object field folder is missing.

The folder field is missing.

Add the folder field and specify a value for it.

The object field folder must not be empty.

The folder field is empty.

Specify a unique value for folder.

The object field clientscriptfile is missing.

The clientscriptfile field is missing.

Add the clientscriptfile field and specify a value for it.

The object field serverscriptfile is missing.

The serverscriptfile field is missing.

Add the serverscriptfile field and specify a value for it.

The object field clientscriptfile must not be empty.

The value of the clientscriptfile field is missing.

Specify a value for the clientscriptfile field.

The object field serverscriptfile must not be empty.

The value of the serverscriptfile field is missing.

Specify a value for the serverscriptfile field.

The linkcategory field is missing for the (link) subrecord.

The link sublist element is included in the SPA object definition, but there is no linkcategory field inside it.

Add the linkcategory field and specify a value for it.

The linklabel field is missing for the (link) subrecord.

The link sublist element is included in the SPA object definition, but there is no linklabel field inside it.

Add the linklabel field and specify a value for it.

The linkcategory field for the (link) subrecord must not be empty.

The linkcategory field is empty.

Specify a value for the linkcategory field.

The linklabel field for the (link) subrecord must not be empty.

The linklabel field is empty.

Specify a value for the linklabel field.

Incorrect Format

Error Message	Scenario	Solution
The scriptid value must be lowercase alphanumeric without spaces or punctuation. Underscores are permitted.	The value for `scriptid` contains characters not allowed in the ID field.	Ensure that the value for `scriptid` contains only lowercase alphanumeric characters and underscores.
The script ID must not exceed 28 characters.	The value for `scriptid` has more than 28 characters.	Ensure that the value for `scriptid` is limited to 28 characters.
The name field contains more than the maximum number (1000) of characters allowed.	The value for `name` has more than 1000 characters.	Ensure that the value for `name` is limited to 1000 characters.
The description field contains more than the maximum number (1000) of characters allowed.	The value for `description` has more than 1000 characters.	Ensure that the value for `description` is limited to 1000 characters.
The url field contains more than the maximum number (1000) of characters allowed.	The value for `url` has more than 1000 characters.	Ensure that the value for `url` is limited to 1000 characters.
The URL cannot contain the following characters: ? ! * ' ( ) ; : @ & = + $ , / ? # [ ] .	The value for `url` contains spaces or some of the following characters: ? ! * ' ( ) ; : @ & = + $ , / ? # [ ] .	Ensure that the value for `url` does not contain spaces or any of the characters that are not allowed.
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 `folder` is entered in the wrong format.	Ensure that the value for `folder` starts and ends with '/' and does not contain any of the following characters: ? * < > \| ' \\.
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 `assetsfolder` is entered in the wrong format.	Ensure that the value for `assetsfolder` starts and ends with '/' and does not contain any of the following characters: ? * < > \| ' \\.
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 `linklabel` field has more than 30 characters.	Ensure that the value for `linklabel` is limited to 30 characters.
The notifyemails field contains more than the maximum number (999) of characters allowed.	The value for `notifyemails` has more than 999 characters.	Ensure that the value for `notifyemails` is limited to 999 characters.

Error Message

Scenario

Solution

The scriptid value must be lowercase alphanumeric without spaces or punctuation. Underscores are permitted.

The value for scriptid contains characters not allowed in the ID field.

Ensure that the value for scriptid contains only lowercase alphanumeric characters and underscores.

The script ID must not exceed 28 characters.

The value for scriptid has more than 28 characters.

Ensure that the value for scriptid is limited to 28 characters.

The name field contains more than the maximum number (1000) of characters allowed.

The value for name has more than 1000 characters.

Ensure that the value for name is limited to 1000 characters.

The description field contains more than the maximum number (1000) of characters allowed.

The value for description has more than 1000 characters.

Ensure that the value for description is limited to 1000 characters.

The url field contains more than the maximum number (1000) of characters allowed.

The value for url has more than 1000 characters.

Ensure that the value for url is limited to 1000 characters.

The URL cannot contain the following characters: ? ! * ' ( ) ; : @ & = + $ , / ? # [ ] .

The value for url contains spaces or some of the following characters: ? ! * ' ( ) ; : @ & = + $ , / ? # [ ] .

Ensure that the value for url does not contain spaces or any of the characters that are not allowed.

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 folder is entered in the wrong format.

Ensure that the value for folder starts and ends with '/' and does not contain any of the following characters: ? * < > | ' \\.

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 assetsfolder is entered in the wrong format.

Ensure that the value for assetsfolder starts and ends with '/' and does not contain any of the following characters: ? * < > | ' \\.

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 linklabel field has more than 30 characters.

Ensure that the value for linklabel is limited to 30 characters.

The notifyemails field contains more than the maximum number (999) of characters allowed.

The value for notifyemails has more than 999 characters.

Ensure that the value for notifyemails is limited to 999 characters.

Duplicate Values

Error Message	Scenario	Solution
This URL already exists. Please enter a different one.	The value for `url` is not unique and already exists in the account.	Specify a unique value for `url`.
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 `url`.
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 `folder` is not unique and already exists in the account.	Specify a unique value for `folder`.
Duplicate values {linkcategory value} were found in the 'links' sublist on the 'singlepageapp' record.	There is more than one `link` element with the same value in the `linkcategory` field. You cannot set more than one link for each location.	Remove the duplicate values for the `linkcategory` field.

Error Message

Scenario

Solution

This URL already exists. Please enter a different one.

The value for url is not unique and already exists in the account.

Specify a unique value for url.

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 url.

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 folder is not unique and already exists in the account.

Specify a unique value for folder.

Duplicate values {linkcategory value} were found in the 'links' sublist on the 'singlepageapp' record.

There is more than one link element with the same value in the linkcategory field. You cannot set more than one link for each location.

Remove the duplicate values for the linkcategory field.

Invalid Values

Error Message	Scenario	Solution
The object field executeas must not be {x}.	The value for `executeas` field does not correspond to any existing role.	Ensure that the value specified in `executeas` is an existing role. 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 `executeas` field is `ADMINISTRATOR`. This value cannot be used for this field.	Specify a role other than `ADMINISTRATOR` in the `executeas` field.
The object field loglevel must not be {x}.	The value for `loglevel` is not valid.	Set `loglevel` to any of the following: `DEBUG`, `AUDIT`, `ERROR`, or `EMERGENCY`.
The object field audienceroles must not be {x}.	The value for `audienceroles` field does not correspond to any existing role.	Ensure that the value specified in `audienceroles` is an existing role. 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 `audienceallroles` is not valid.	Set `audienceallroles` to either `T` or `F`.
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 `executeas` or `audienceroles` field does not exist in the project and is not included in the dependencies list.	Ensure that the custom role referenced in `executeas` or `audienceroles` exists in the SuiteApp project.
The linkcategory field for the (link) subrecord must not be {linkcategory value}.	The value in the `linkcategory` field is not valid.	Check the list of possible values for the center category in generic_centercategory. The `linkcategory` field also accepts references to centercategory custom type.
The {linkcategory value} object referenced by the linkcategory field in the (link) subrecord is missing.	The `linkcategory` field value references an object that is missing from the project.	Check that the custom centercategory object that you are referencing in the `linkcategory` field exists in your SuiteApp project.
The notifyuser field must be set to a valid Boolean value, 'T' or 'F'.	The value for `notifyuser` is not valid.	Set `notifyuser` to either `T` or `F`.
The notifyowner field must be set to a valid Boolean value, 'T' or 'F'.	The value for `notifyowner` is not valid.	Set `notifyowner` to either `T` or `F`.
The notifyadmins field must be set to a valid Boolean value, 'T' or 'F'.	The value for `notifyadmins` is not valid.	Set `notifyadmins` to either `T` or `F`.
The notifyemails field value is invalid. To include multiple addresses, separate them by commas.	The `notifyemails` field value is not a valid email address or is entered in the wrong format.	Ensure that the email address specified is valid and entered in the correct format. Use a comma to separate multiple email addresses.

Error Message

Scenario

Solution

The object field executeas must not be {x}.

The value for executeas field does not correspond to any existing role.

Ensure that the value specified in executeas is an existing role.

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 executeas field is ADMINISTRATOR. This value cannot be used for this field.

Specify a role other than ADMINISTRATOR in the executeas field.

The object field loglevel must not be {x}.

The value for loglevel is not valid.

Set loglevel to any of the following: DEBUG, AUDIT, ERROR, or EMERGENCY.

The object field audienceroles must not be {x}.

The value for audienceroles field does not correspond to any existing role.

Ensure that the value specified in audienceroles is an existing role.

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 audienceallroles is not valid.

Set audienceallroles to either T or F.

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 executeas or audienceroles field does not exist in the project and is not included in the dependencies list.

Ensure that the custom role referenced in executeas or audienceroles exists in the SuiteApp project.

The linkcategory field for the (link) subrecord must not be {linkcategory value}.

The value in the linkcategory field is not valid.

Check the list of possible values for the center category in generic_centercategory. The linkcategory field also accepts references to centercategory custom type.

The {linkcategory value} object referenced by the linkcategory field in the (link) subrecord is missing.

The linkcategory field value references an object that is missing from the project.

Check that the custom centercategory object that you are referencing in the linkcategory field exists in your SuiteApp project.

The notifyuser field must be set to a valid Boolean value, 'T' or 'F'.

The value for notifyuser is not valid.

Set notifyuser to either T or F.

The notifyowner field must be set to a valid Boolean value, 'T' or 'F'.

The value for notifyowner is not valid.

Set notifyowner to either T or F.

The notifyadmins field must be set to a valid Boolean value, 'T' or 'F'.

The value for notifyadmins is not valid.

Set notifyadmins to either T or F.

The notifyemails field value is invalid. To include multiple addresses, separate them by commas.

The notifyemails field value is not a valid email address or is entered in the wrong format.

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 `scriptid` value specified in the object definition does not match the SPA object file name.	Specify the same value for the SPA object file name (`custspa_<name>`) and for the `scriptid` attribute.
The folder field in the {/SuiteApps/<publisherid2>.<projectid2>/<folder name>} reference is invalid.	The `<publisherid2>.<projectid2>` does not match the `<publisherid>.<projectid>` of the manifest.xml or deploy.xml file.	Check that all of the following values match: The values in the `publisherid` and `projectid` fields in the manifest.xml file The value in the `path` tag under `files` in the deploy.xml file The values used in the `folder` field in the SPA object definition file

Error Message

Scenario

Solution

The script ID must match the file name (excluding the file extension).

The scriptid value specified in the object definition does not match the SPA object file name.

Specify the same value for the SPA object file name (custspa_<name>) and for the scriptid attribute.

The folder field in the {/SuiteApps/<publisherid2>.<projectid2>/<folder name>} reference is invalid.

The <publisherid2>.<projectid2> does not match the <publisherid>.<projectid> of the manifest.xml or deploy.xml file.

Check that all of the following values match:

The values in the publisherid and projectid fields in the manifest.xml file
The value in the path tag under files in the deploy.xml file
The values used in the folder field in the SPA object definition file

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 {/SuiteApps/<publisherid>.<projectid>/<folder name>} reference is invalid.	The folder path in the `folder` field points to a location outside of the `/SuiteApps/<publisherid>.<projectid>/` folder.	Ensure that the SPA folder is inside your local SuiteApp project folder `src/FileCabinet/SuiteApps/<publisherid>.<projectid>/`.
The folder {/SuiteApps/<publisherid>.<projectid>/<folder>} referenced by the object field folder is missing.	The SPA folder specified in the `folder` field does not exist in the SDF SuiteApp project folder.	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 `clientscriptfile` does not exist in the SPA folder inside the SDF SuiteApp project.	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 `serverscriptfile` does not exist in the SPA folder inside the SDF SuiteApp project.	Ensure that you have the SPA server script inside the SPA folder.
The folder {/SuiteApps/<publisherid>.<projectid>/<folder>/assets/} referenced by the object field assetsfolder is missing.	The assets folder specified in the `assetsfolder` field does not exist in the SDF SuiteApp project folder.	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 `clientscriptfile` field uses the path specified in the `folder` field.
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 `serverscriptfile` field uses the path specified in the `folder` field.
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 `assetsfolder` field uses the path specified in the `folder` field.
/SuiteApps/<publisherid2>.<projectid2>/<folder name>/SpaClient.js is invalid. The clientscriptfile field must start with /SuiteApps/<publisherid>.<projectid>/, /Web Site Hosting Files/.	The client script path points to a folder in a different application.	Check that the value in the `clientscriptfile` field uses the correct value for `<publisherid>.<projectid>`.
/SuiteApps/<publisherid2>.<projectid2>/<folder name>/SpaServer.js is invalid. The serverscriptfile field must start with /SuiteApps/<publisherid>.<projectid>/, /Web Site Hosting Files/.	The server script path points to a folder in a different application.	Check that the value in the `serverscriptfile` field uses the correct value for `<publisherid>.<projectid>`.
The assetsfolder field in the {/SuiteApps/<publisherid2>.<projectid2>/<folder name>/assets} reference is invalid.	The assets folder path points to a folder in a different application.	Check that the value in the `assetsfolder` field uses the correct `<publisherid>.<projectid>` value.

Error Message

Scenario

Solution

The SPA folder is not within the application folder.

The folder field in the {/SuiteApps/<publisherid>.<projectid>/<folder name>} reference is invalid.

The folder path in the folder field points to a location outside of the /SuiteApps/<publisherid>.<projectid>/ folder.

Ensure that the SPA folder is inside your local SuiteApp project folder src/FileCabinet/SuiteApps/<publisherid>.<projectid>/.

The folder {/SuiteApps/<publisherid>.<projectid>/<folder>} referenced by the object field folder is missing.

The SPA folder specified in the folder field does not exist in the SDF SuiteApp project folder.

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 clientscriptfile does not exist in the SPA folder inside the SDF SuiteApp project.

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 serverscriptfile does not exist in the SPA folder inside the SDF SuiteApp project.

Ensure that you have the SPA server script inside the SPA folder.

The folder {/SuiteApps/<publisherid>.<projectid>/<folder>/assets/} referenced by the object field assetsfolder is missing.

The assets folder specified in the assetsfolder field does not exist in the SDF SuiteApp project folder.

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 clientscriptfile field uses the path specified in the folder field.

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 serverscriptfile field uses the path specified in the folder field.

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 assetsfolder field uses the path specified in the folder field.

/SuiteApps/<publisherid2>.<projectid2>/<folder name>/SpaClient.js is invalid. The clientscriptfile field must start with /SuiteApps/<publisherid>.<projectid>/, /Web Site Hosting Files/.

The client script path points to a folder in a different application.

Check that the value in the clientscriptfile field uses the correct value for <publisherid>.<projectid>.

/SuiteApps/<publisherid2>.<projectid2>/<folder name>/SpaServer.js is invalid. The serverscriptfile field must start with /SuiteApps/<publisherid>.<projectid>/, /Web Site Hosting Files/.

The server script path points to a folder in a different application.

Check that the value in the serverscriptfile field uses the correct value for <publisherid>.<projectid>.

The assetsfolder field in the {/SuiteApps/<publisherid2>.<projectid2>/<folder name>/assets} reference is invalid.

The assets folder path points to a folder in a different application.

Check that the value in the assetsfolder field uses the correct <publisherid>.<projectid> value.

Missing Fields and Field Values

Incorrect Format

Duplicate Values

Invalid Values

Values Do Not Match

Reference File or Folder Does Not Exist

Related Topics