Set Up Extension Developer Tools

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 sites 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 API Components for an explanation of what components are currently accessible using the Extensibility API.

Which Tools Do I Use?

Your extension developer tools can be found in the SuiteBundles folder of your NetSuite File Cabinet, as described in Download Theme Developer Tools. These tools accompany the SuiteCommerce Extension Management bundle and are updated automatically with each new SuiteApp update.

The correct tools you require depend on your implementation:

• SuiteCommerce and SCA 2019.1 and Later – Use the latest theme and extension developer tools found in the appropriate SuiteBundles folder in your NetSuite File Cabinet, as detailed in the following procedure.

• SCA Aconcagua and 2018.2 Release – These implementations are compatible with the 2018.2 extension developer tools. Use the 2018.2.1 developer tools found in the appropriate SuiteBundles folder in your NetSuite File Cabinet, as detailed in the following procedure. These implementations are not compatible with any other developer tools.

Prerequisites

Before downloading the extension developer tools, complete the following tasks:

• Verify that you have SuiteCommerce or SuiteCommerce Advanced installed as described in Install Your Commerce Website Applications.

• Verify that you have SuiteCommerce Extension Manager installed as described in Install Your Commerce Website Applications.

• Set up your developer environment as described in Install Node.js and Install Gulp.js.

Download the Extension Developer Tools

To download and extract the extension developer tools:

1. Login to your NetSuite account.

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

3. Go to SuiteBundles/Bundle 500777/.

4. Download the .zip file you find there:

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

   Important:

   If you are implementing the Aconcagua or the 2018.2 release of SuiteCommerce Advanced, download the ExtensionDevelopmentTools-18.2.1.zip file. These are the only tools compatible with your implementation.

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 of the same name, but you can rename this directory to suit your needs.

   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

   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.

   Note:

   If you use a sandbox account, follow the preceding steps to create two separate root development directories—one for production and one for sandbox. Following this best practice will help ensure you fetch from and deploy to the correct account later in the development lifecycle.

You are now ready to begin extension development. See Get Started with Extensions for information about building a baseline extension, testing on a local server, and deploying to a NetSuite account.

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

Using Extension Developer Tools with Token-Based Authentication

Extension Developer Tools can be used to support token-based authentication (TBA) for your site. To take advantage of this, complete the following steps:

Note:

If you completed these steps when setting up the Theme Developer Tools, you do not need to repeat these steps.

1. Create an integration record.

   For more information, see Create Integration Records for Applications to Use TBA.

   1. In the Name field, enter a name for the integration record.

   2. In the State field, select Enabled.

   3. Check the Token-Based Authentication box.

   4. Check the TBA: Authorization Flow box.

   5. In the Callback URL field, enter: http://localhost:7777/tba.

   6. Clear the Authorization Code Grant box.

   7. Check the User Credentials box.

2. Save the integration. Be sure to copy the consumer key/secret before closing the page.

3. Paste the consumer key/secret in the .env file.

   Note:

   This file is inside the root extension developer tools folder that was downloaded when setting up developer tools. For more information about locating this folder, see Download the Extension Developer Tools.

Related Topics

• Develop Extensions
• Extension Development Files and Folders
• Anatomy of an Extension
• APIs for SuiteCommerce Extensions
• Develop Your Extension
• Test and Deploy Your Extension
• Extension Tutorials
• Do More With Extensions

General Notices