Components of SSP Applications

To customize and create SSP applications successfully, it is important to understand the different components involved:

SuiteScript Server Pages Feature

To use SSP applications, enable the following features:

  • SuiteScript Server Pages - to create, view, or customize SSP applications.

  • SuiteScript 2 Server Pages - to use SuiteScript 2.0 in SSP applications. Note that SSP applications written in SuiteScript 1.0 will continue to work as normal when this feature is enabled.

For more information, see Enable Required Features for SuiteScript 1.0 SSP Applications and Enable Required Features for SuiteScript 2.0 SSP Applications.

Important

You must have the SuiteScript permission to access SSP Application records. To set up permissions, go to Setup > Users/Roles > Manage Roles.


SSP Application Record

The SSP Application record provides a single NetSuite object that stores details about a website customization. This record facilitates grouping of assets, debugging of script files, and packaging of the customization for use in other NetSuite accounts. On this record, you can create and view the following properties:

  • Application Folder – the file cabinet folder where customization files are located. For more information, see Create an SSP Application Folder.

  • URL Root – the root used in web store links to SSP application assets. For more information, see Create a SuiteScript 1.0 SSP Application Record.

  • Supported Touch Points – the web store entry points for which the SSP application can generate dynamic content. For more information, see Select Supported Touch Points. Touch points are defined on the application record only for SSP applications written in SuiteScript 1.0.

  • Default SSP File – the file that controls the dynamic content generated by the SSP application on the website or domain. Only SSP applications written in SuiteScript 2.0 have default SSP files. For more information, see Select Default SSP File.

  • Sites and Domains to which the SSP application is deployed – the website or domain(s) to which the SSP application is deployed. This is applicable only to SSP applications written in SuiteScript 2.0. For more information, see SSP Applications (SuiteScript 1.0 Compared with SuiteScript 2.0) and Deploy and Undeploy SSP Aplications.

SSP Application Precedence

When SSP applications share a URL and hosting root, a system of precedence determines which SSP application handles a particular request. For more information, see Change SSP Application Precedence.

Note

SSP application precedence does not apply to SSP applications written in SuiteScript 2.0 because such applications cannot share both a URL and a hosting root. If two SSP applications written in SuiteScript 2.0 have the same URL root, they cannot be deployed to the same domain or website.


File Types for SSP Applications

Web store customizations implemented through SSP applications support the following file types:

  • .ssp files: These files, known as SuiteScript Server Pages, are frontend pages that can be written in HTML and/or server-side SuiteScript. They are similar to .jsp files, use a similar tag convention, and support Includes so that code can be pulled from associated libraries. You may invoke suitelets and RESTlets from .ssp files. Also, you can use .ssp files to develop pages that use JQuery.

  • .ss files: These files are request handlers written in SuiteScript, basically a specialized type of suitelets. They can be frontend non-HTML pages, such as AJAX handlers, or they can be backend pages that take an HTTP request and perform an action, such as writing HTML, XML, JSON or JavaScript to the output stream or issuing a redirect.

Both .ssp files and .ss files run against the server. These files support the full range of existing SuiteScript APIs that run on the server. SSP application files written in Suitescript 1.0 also support the Commerce API designed to support web store customizations.

For basic examples of .ssp and .ss file content, see Sample SSP Application Code (SuiteScript 1.0) and Sample SSP Application Code (SuiteScript 2.0).

Commerce API

The API, supported by both Site Builder and SuiteCommerce, includes all of the web store-specific objects and related methods that you need to fully customize your web store on the SuiteCloud platform.

For details about this API, see Commerce API.

Note

The Commerce API is not available for use with SSP applications written in SuiteScript 2.0.