Set Up Extension Developer Tools

This topic applies to

Applies to

SuiteCommerce Web Stores | Aconcagua

Before you can create an extension, you must download the extension developer tools and extract them to create a top-level development directory. This is where you maintain all of your extension’s JavaScript, SuiteScript, Configuration, HTML, Sass, and assets. You use the tools to run Gulp.js commands to build baseline files for your extension, test your changes locally, and deploy extensions to NetSuite.

Note

These tools are required for all SuiteCommerce site and any SCA sites implementing the Aconcagua release or later. You build extensions to interact with the Extensibility API to extend the application. See Extensibility Component Classes for an explanation of what components are currently accessible using the Extensibility API.


To download and extract the extension developer tools:

  1. Login to your NetSuite account.

  2. In NetSuite, go to Documents > Files > File Cabinet.

  3. Navigate to SuiteBundles/Bundle 284094/.

  4. Download the .zip file you find there:

    ExtensionDevelopmentTools-19.1.x.zip (where x equals the latest minor release).

  5. Extract the .zip file to a location in your local environment. This becomes your root development directory for your custom extensions.

    The .zip file extracts into a directory named ExtensionDevelopmentTools-19.1.x by default (where x equals the latest minor release). However, you can rename this directory to suit your needs.

    Note

    SuiteCommerce Advanced Developers: The 2019.1 release of the Extension Management Bundle includes the theme and extension developer tools for 2019.1 and 2018.2. If you are implementing the 2018.2 release of SCA, you must use the 2018.2 developer tools when creating themes and extensions due to non-backward compatibility.


    Important

    Do not move, delete, or rename any files or folders within the top-level development directory.


  6. Open a command line or terminal window.

  7. Access your root development directory created previously.

  8. Enter the following command to install additional Node.js packages into this directory:

    npm install

    Note

    This command installs the dependencies required to manage your custom extensions. These files are stored in the node_modules subdirectory of the root development directory. This command may take several minutes to complete.


You are now ready to begin extension development. See Extension Developer Tools for information on building a baseline extension, testing on a local server, and deploying to a NetSuite account. For information on developing an extension, see Extensions.

If you also intend to create themes, you must Set Up Theme Developer Tools.