Deploy to a Custom SSP Application

This topic applies to

Applies to

SuiteCommerce Advanced

During installation of SuiteCommerce Advanced (SCA), two SSP applications are automatically configured in your account and you can easily deploy to the Development SSP application as described in the section Deploy to NetSuite. However, you can also deploy your files to a custom SSP application.

Deploying to a custom SSP application consists of the following three steps:

Note

Before deploying to a Custom SSP Application, the SCA bundle must be installed in your account. You can not deploy local files into an account without the bundle installed.


Step 1: Create a Custom SSP Application

The NetSuite SSP application record defines the folder in the NetSuite file cabinet where your website customization assets are stored. If you are unfamiliar with SSP applications in NetSuite, review the following section in the NetSuite Help Center before proceeding:

SSP Application Overview

Important

If you are updating a site that has been previously developed and deployed to a custom SSP application, you do not need to create a new SSP application. Instead you can connect to the existing SSP application. You need to know the Application Folder and the Application Name of the SSP application record corresponding to the site you are working on. You can find this information on the SSP Application Record.


To create a new SSP application:

  1. Go to Setup > SuiteCommerce Advanced > SSP Applications > New.

  2. Go to the NetSuite Help topic Create a SuiteScript 1.0 SSP Application Record and follow the steps outlined there for creating the application.

Creating an SSP application results in a directory structure in the NetSuite File Cabinet with the following path: <HTML Hosting Root>: /SSP Applications/<Application Publisher>/<Application Name>. This is where application files will be deployed to using Gulp.

For example, suppose you have a website, MyNetSuiteSite.com, where you want the home page to point to the SCA Shopping application. The configuration of your SSP application could look like this:

  • HTML Hosting Root: Live Hosting Files

  • Application Publisher: My Company Name

  • Application Name: SuiteCommerceDevSite

Step 2: Deploy Local Files to Your SSP Application

After creating your SSP application, use Gulp to deploy the files generated earlier in the Distribution folder to your NetSuite File Cabinet. You will need the following information to complete these steps:

  • Your NetSuite username and password

    Note

    The developer tools do not support emails or passwords containing special characters such as + and %.


  • Details from the SSP application record created in Step 1: Create a Custom SSP Application: HTML Hosting Root, Application Publisher, Application Name

To deploy local files using Gulp:

  1. Return to your command line or terminal window.

  2. From the root directory of the SCA source files (the same directory used during the developer tools installation), enter the following command.

    gulp deploy

    Note

    You should run gulp deploy in the directory above the Distribution folder.


  3. When prompted, enter your NetSuite email and password.

    Note

    The developer tools do not support emails or passwords containing special characters such as + and %.


  4. When prompted, navigate to the following using the details from your SSP application record:

    Tip

    These values correspond to the path to your SSP application in the NetSuite File Cabinet: <HTML Hosting Root>: /SSP Applications/<Application Publisher>/<Application Name>


    • Hosting Files folder: This is the HTML Hosting Root of your SSP application.

    • Application Publisher: This is the Publisher of your SSP application.

    • SSP Application: This is the Name of your SSP application.

After all of the connection settings are entered, files from the Distribution folder on your local system are pushed to the NetSuite file cabinet. This process may take a few minutes. Wait for the process to complete before proceeding.

Note

The first time gulp deploy is run, the connection settings are saved to a .nsdeploy file in the root directory of your source SCA files. On subsequent deployments only the login credentials are required. If you need to change the SSP application you are deploying to, you can manually edit the .nsdeploy file with the updated information. For details, see Changing Your Connection Information.


Step 3: Configure the SSP Application

Now that all of the necessary files are available to the SSP application within NetSuite, there are a couple more configuration steps to complete before your site uses the uploaded SCA applications.

  1. Go to Setup > SuiteCommerce Advanced > SSP Applications and then click Edit next to the SSP application created in Step 1 above.

  2. In the Libraries subtab under Scripts, click Add.

  3. Navigate to the ssp_libraries.js file in your SSP application folder and click Add.

    The ssp_libraries.js file was pushed to the file cabinet with the gulp deploy command. It will reside in the root folder of your SSP application at <HTML Hosting Root>: /SSP Applications/<Application Publisher>/<Application Name>.

    Note

    Depending on the number of files in your File Cabinet you may need to scroll through a long list!. Also, do not depend on the search. The files available may not be refreshed, resulting in a no matches found error even though the file does exist.


  4. In the Touch Points tab, define the Touch Points for this SSP application.

    Touch Points are the entry points for your web store. For each touch point defined here, your website links to an SSP application page.

    1. In the Name field, select the desired Touch Point.

    2. In the Entry Page, field select the .ssp file that should be the starting point for this Touch Point.

    3. Click Add.

    For example, if you want your web store to use the Shopping application when a user goes to your Home page, select the View Homepage Touch Point and set the Entry page as the shopping.ssp file.

  5. Click Save on the record.

    You are returned to the list of available SSP applications.

  6. Deploy the SSP application to your site.

    1. Click View next to your SSP application.

    2. Click Link to Site.

    3. In the Site dropdown field, select the site you want to deploy this application to.

      Note

      Only sites already set up are available for selection. If you have not already set up a web site record go to Setup > SuiteCommerce Advanced > Web Site Set Up > New. For detailed instructions, see Getting Started.


    4. Click Save.

    After the SSP application has been deployed to your site you can view the site by navigating to the domain defined for that site.