Single Page Application Creation And Development

Important:

The Single Page Application feature is available by request only. Currently, this feature can be enabled only for SDN partners with a publisher ID. SPA development requires the use of SuiteCloud Development Framework (SDF) SuiteApp projects and SuiteScript 2.1. For information about the requirements to use this feature and how to request access, see Requesting Access to the Single Page Application Feature.

Before you start working on your single page applications (SPAs), ensure that you have access to the required tools and that prerequisite features have been enabled in your account. For more information, see Requesting Access to the Single Page Application Feature and Prerequisites for Single Page Applications.

In NetSuite, SPAs are developed as part of a SuiteApp project that is created using the SuiteCloud Development Framework (SDF). NetSuite UI Framework (UIF) provides the UI components that you can use to build your SPAs.

The following steps provide an overview of the process for developing SPAs with NetSuite UIF:

Create the SDF SuiteApp project where you will implement your SPA. Alternatively, you can use one of the sample SPA SuiteApps as a starting point or you can add SPAs to an existing SuiteApp project.
Within the SuiteApp project, create the following for each SPA implementation:
- A unique SPA folder
- Two required scripts: SPA client script and SPA server script
- An SPA object definition file
If you are using a sample project, ensure that you update the folder names, file names, and the contents based on your project.
Develop your application. Use the UI components and APIs from NetSuite UIF to build your SPA. You also can use SuiteScript modules in the SPA client script and SPA server script.
Convert your SPA source files and build the SuiteApp. The sample SPA projects contain a gulpfile that implements the build and bundle steps to convert the SPA source files. You can use this file or you can opt to use your preferred tool to transpile and convert the files.
Validate and deploy your SuiteApp project.
Open your single page application in NetSuite.

For more information, see the following topics:

Creating a Single Page Application – Describes how to create an SDF SuiteApp project that includes SPAs.
Single Page Applications as XML Definitions – Provides information about the XML definition for an SPA (singlepageapp) SDF custom object.
Developing Single Page Applications – Describes how to develop the SPA client script and SPA server script.
Troubleshooting Single Page Applications – Provides information about errors related to SPAs.

For information about the sample SPA SuiteApps, see Single Page Application Samples.

Related Topics