1. Commerce
  2. Commerce Developer Documentation
  3. Develop SCA Customizations
  4. SCA Reference
  5. SCA Source Directory

SCA Source Directory

You can download the SuiteCommerce Advanced (SCA) source files directly from the file cabinet in NetSuite. The structure of these source files depends on the version of your implementation. The tables in the following topics describe the files and folders you see when you extract your source files from the NetSuite file cabinet and then set up the SCA developer tools:

Note:

From the SuiteCommerce Advanced release 2024.2 and later, source files will be set by default to inactive in the NetSuite File Cabinet. All files will still work as expected but you cannot view them unless you check the Show Inactives box.

SCA 2019.2 and Later Source Directory

For SCA 2019.2 and later releases, when you download and extract the source files as described in Download SCA Source Files, the default name for the top-level directory is SuiteCommerce Advanced xx.x (where xx.x refers to the release, such as 20.1). The following directories and sub-directories reside in the top-level SuiteCommerce Advanced directory:

            SC_xx.x_Live
 Advanced
 Backend
 Commons
 gulp
 DeployDistributionAdvanced
 DeployDistributionAdvancedSS2
 LocalDistributionAdvanced
 LocalDistributionAdvancedSS2
 node_modules

The following table describes the preceding directories as well as some important files:

File / Folder

Description

SC_xx.x_Live

This folder contains the workspace for SuiteCommerce Advanced source code. This folder also contains administrative files necessary to run npm and gulp commands.

You execute npm and node commands from this folder location.

xx.x refers to the release. For example, SC_20.1_Live.

Advanced

This folder contains the source code for all of the modules that are used exclusively by SCA. This folder also contains the distro.json file, which lists all of the modules used by the SCA application and the name and version number of the distribution.

Backend

This folder contains models and service controllers for modules that have been migrated to SuiteScript 2.0.

Commons

This folder contains the source code for all of all modules that are common to both SCA and SuiteCommerce InStore.

gulp

This folder contains all of the files required by Gulp.js. You should not edit the files within this directory.

DeployDistributionAdvanced

This folder contains all of the files associated with the compiled application and any that rely on SuiteScript 1.0. This directory is created when you run the gulp deploy command. When you run the command, the compiled application files are output to this directory. After compilation, the contents of this directory are deployed to your NetSuite account.

See Contents of the Deploy and Local Distribution Directories for information on the contents of this directory.

Important:

Do not manually edit the files in this directory. It is created and updated when you run the gulp command.

DeployDistributionAdvancedSS2

This folder contains all of the files associated with the compiled application that rely on SuiteScript 2.0. This directory is created when you run the gulp deploy command.

See Contents of the Deploy and Local Distribution Directories for information on the contents of this directory.

Important:

Do not manually edit the files in this directory. It is created and updated when you run the gulp command.

LocalDistributionAdvanced

Created when you run the gulp local command, this directory contains all of the files associated with the compiled application used by the local server.

When you run this command, Gulp.js outputs the compiled application files to this directory. After compilation, the contents of this directory are deployed to the local Node.js server.

See Contents of the Deploy and Local Distribution Directories for information on the contents of this directory.

Important:

Do not manually edit the files in this directory. It is created and updated when you run the gulp command.

LocalDistributionAdvancedSS2

Created when you run the gulp local command, this directory contains all of the files associated with the compiled application that rely on SuiteScript 2.0 and are used by the local server.

When you run this command Gulp.js outputs the compiled application files to this directory. After compilation, the contents of this directory are deployed to the local Node.js server.

See Contents of the Deploy and Local Distribution Directories for information on the contents of this directory.

Important:

Do not manually edit the files in this directory. It is created and updated when you run the gulp command.

node_modules

This folder stores the dependencies and other files required by Node.js. This directory is created when you run the npm install command during SCA developer tools set up.

gulpfile.js

Contains all the JavaScript code for Gulp.js. You should only edit this file if you need to add a new task to Gulp.js .

.nsdeploy

This file defines how Gulp.js connects to your NetSuite account during deployment. This file is created the first time you run the gulp deploy command.

distro.json

This file, located in the SC_xx.x_Live directory, lists all of the modules used by the SCA application. It also specifies the name and version number of the distribution.

SCA 2019.1 and Earlier Source Directory

The source directory for SCA 2019.1 and earlier releases includes the following folders:

            SuiteCommerce Advanced Version
 gulp
 Modules
 node_modules
 LocalDistribution
 DeployDistribution

The following table describes the preceding directories as well as some important files:

File / Folder

Description

SuiteCommerce Advanced Version

This folder contains the workspace for SuiteCommerce Advanced source code. This folder also contains administrative files necessary to run npm and gulp commands.

You execute npm and node commands from this folder location.

Version refers to the release. For example: SuiteCommerce Advanced 2019.1 or SuiteCommerce Advanced Aconcagua

gulp

Contains all of the files required by Gulp.js. This file is created when Gulp.js is installed. You should not edit the files within this directory.

Modules

This folder contains the source code for all of the modules that are used exclusively by SCA.

node_modules

Stores the dependencies and other files required by Node.js. This directory is created when you run the npm install command as part of the SCA developer tools set up.

LocalDistribution

Created when you run the gulp local command. This directory contains all of the files associated with the compiled application used by the local server.

When you run this command, Gulp.js outputs the compiled application files to this directory. After compilation, the contents of this directory are deployed to the local Node.js server.

See Contents of the Deploy and Local Distribution Directories for information on the contents of this directory.

Important:

Do not manually edit the files in this directory. It is created and updated when you run the gulp command.

DeployDistribution

Contains all of the files associated with the compiled application. This file is created when you run the gulp deploy command.

When you run this command, the compiled application files are output to this directory. After compilation, the contents of this directory are deployed to your NetSuite account.

See Contents of the Deploy and Local Distribution Directories for information on the contents of this directory.

Important:

Do not manually edit the files in this directory. It is created and updated when you run the gulp command.

.nsdeploy

Defines how Gulp.js connects to your NetSuite account during deployment. This file is created the first time you run the gulp deploy command.

distro.json

Lists all of the modules used by the SuiteCommerce Advanced application. It also specifies the name and version number of the distribution.

gulpfile.js

Contains all the JavaScript code for Gulp.js. You should only edit this file if you need to add a new task to Gulp.js .

Related Topics

General Notices