Deploy to a Sandbox or Custom SSP Application

Learn how to deploy to both sandbox accounts and custom SSP applications in NetSuite, streamlining your development process.

·3 min read·View Oracle Docs

Deploying to a sandbox account or a custom SSP application in NetSuite allows developers to test and refine their code in a controlled environment. This guide provides detailed steps to successfully execute deployments to each environment.

How to Deploy to a Sandbox Account

Deploying to a sandbox account is an essential part of the development process to ensure code works properly before going live. Here are the steps for deployment:

  1. Open a Terminal or Command Line Interface
    Start by accessing your command line or terminal window.

  2. Execute the Deployment Command
    From the top-level directory of your source files, use the appropriate command based on what you are deploying:

    • For theme development, run:
      bash
      gulp theme:deploy
    • For extension development, run:
      bash
      gulp extension:deploy
    • For core SuiteCommerce Advanced development, run:
      bash
      gulp deploy

    Upon first deployment, a DeployDistribution subdirectory is created, compiling the source files for your deployment.

  3. Enter Authentication Information
    If prompted, input the authentication ID for your sandbox account. Ensure that your chosen role has the necessary permissions to allow deployment.

  4. Select and Authorize Sandbox in NetSuite
    In NetSuite, select the appropriate sandbox account and the role you wish to authenticate with. After this selection, click Allow to generate the required authentication token and secret.

How to Deploy to a Custom SSP Application

The deployment to a custom SSP application allows testing of specific resources in a safer environment. Follow these steps:

  1. Create a Custom SSP Application
    You must create separate applications for SuiteScript 1.0 and SuiteScript 2.0 if you want to deploy using both. This is crucial for compatibility.

    • Follow the guides on creating a custom SSP application tailored for your specific SuiteScript version.
  2. Deploy Local Files
    Once your custom SSP application is set up, you can deploy your local customizations to the designated domain and site.

  3. Configure Your Custom SSP Applications
    Proper configuration is essential for ensuring the SSP application interacts correctly with your development resources.

Important Considerations

  • Ensure that all necessary Commerce bundles are installed before initiating a deployment to your sandbox account.
  • If you’ve previously deployed to another account, you may need to delete the .nsdeploy file which contains old configurations. This allows you to set up fresh login credentials for your sandbox.
  • For those using the 2019.1 release or later of SuiteCommerce Advanced, remember to create two separate custom SSP applications: one for SuiteScript 1.0 and another for SuiteScript 2.0, referred to as SSPv2 for compatibility.

Key Takeaways

  • Deployment processes for sandbox and custom SSP applications are distinct but essential for effective testing.
  • Appropriate setup of environments enhances code validity before a live rollout.
  • Always verify the installation of necessary bundles and permissions prior to deployment activities.

Source: This article is based on Oracle's official NetSuite documentation.

Source: Deploy to a Sandbox or Custom SSP Application Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in SuiteCloud Development Framework

View all SuiteCloud Development Framework articles →