NetSuite Changelog
CommerceSuiteCommerceSuiteScriptModules

SuiteCommerce Advanced Source Directory Structure Overview

Understanding the SuiteCommerce Advanced source directory structure aids developers in managing files, modules, and deployments effectively.

·2 min read·View Oracle Docs

The source directory for SuiteCommerce Advanced (SCA) versions 2019.1 and earlier organizes critical development files and modules necessary for effective application management. This structure facilitates the use of Gulp.js and npm for task automation and deployment processes.

Source Directory Overview

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

none
1SuiteCommerce Advanced Version
2 gulp
3 Modules
4 node_modules
5 LocalDistribution
6 DeployDistribution

The following table provides descriptions of these directories:

File / FolderDescription
SuiteCommerce Advanced VersionThis folder contains the workspace for the SuiteCommerce Advanced source code. Administrative files for npm and gulp commands are also found here. Version refers to the specific release (e.g., SuiteCommerce Advanced 2019.1).
gulpHouses files required by Gulp.js; do not edit these files directly.
ModulesContains source code for all modules used exclusively by SCA.
node_modulesStores dependencies required by Node.js, created via the npm install command.
LocalDistributionOutput directory from running gulp local, containing files for the local server; do not edit these files directly.
DeployDistributionOutput directory from running gulp deploy, containing files for deployment to your NetSuite account; do not edit these files directly.
.nsdeployDetails how Gulp.js connects to your NetSuite account upon deployment, created during the first gulp deploy command execution.
distro.jsonLists all modules used by the SCA application along with the distribution's name and version number.
gulpfile.jsContains JavaScript code for Gulp.js; edit this file only to add new tasks.

Important Notes

  • Do not manually edit files in the LocalDistribution or DeployDistribution directories. They are automatically managed by Gulp.js and should strictly remain untouched to ensure proper functionality.
  • Access these directories primarily for troubleshooting purposes.

Related Topics

  • [SCA Build Process]
  • [The distro.json and ns.package.json Files]
  • [How Files Are Combined]

Frequently Asked Questions (4)

Can I manually edit files in the 'LocalDistribution' or 'DeployDistribution' directories?
No, you should not manually edit files in the 'LocalDistribution' or 'DeployDistribution' directories. These files are managed automatically by Gulp.js and should be left untouched to ensure proper functionality.
Where should I add new tasks for Gulp.js?
New tasks for Gulp.js should be added to the 'gulpfile.js' file. This file contains all JavaScript code necessary for Gulp.js task management.
What happens during the first 'gulp deploy' command execution?
During the first 'gulp deploy' command execution, a file named '.nsdeploy' is created. This file details how Gulp.js connects to your NetSuite account for deployment purposes.
What is the purpose of the 'Modules' directory in SuiteCommerce Advanced?
The 'Modules' directory contains the source code for all modules used exclusively by SuiteCommerce Advanced. It organizes the modules necessary for application management and development.
Source: SCA 2019.1 and Earlier Source Directory — 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 Commerce

View all Commerce articles →