SuiteCommerce Advanced Source Direct...

TL;DR Opening

Starting with the SCA 2019.2 release, the SuiteCommerce Advanced (SCA) source directory introduced a standardized structure for managing files and directories essential for customization and development. Understanding this structure helps developers effectively navigate and utilize the resources available.

What is the SuiteCommerce Advanced Source Directory?

The SuiteCommerce Advanced source directory is a designated location where all files pertaining to the SCA framework are organized. This structure is critical for efficient management of resources when developing and customizing your eCommerce site.

Directory Structure of SCA Source Files

When you download and unpack the source files for SCA 2019.2 and later, you'll find that the top-level directory is named SuiteCommerce Advanced xx.x, where xx.x is the release version (e.g., 20.1). Below is the standard directory structure:

none

1SC_xx.x_Live
2 Advanced
3 Backend
4 Commons
5 gulp
6 DeployDistributionAdvanced
7 DeployDistributionAdvancedSS2
8 LocalDistributionAdvanced
9 LocalDistributionAdvancedSS2
10 node_modules

Detailed Description of Key Directories and Files

File / Folder	Description
SC_xx.x_Live	Contains the workspace for SCA source code and necessary administrative files for npm and gulp commands.
Advanced	Holds source code for all SCA-exclusive modules and the `distro.json` file, which lists all modules and versions.
Backend	Features models and service controllers for modules shifted to SuiteScript 2.0.
Commons	Source code for modules common between SCA and SuiteCommerce InStore.
gulp	Contains files needed by Gulp.js; do not edit these files directly.
DeployDistributionAdvanced	Utilized for compiled application files relying on SuiteScript 1.0. Do not edit contents manually.
DeployDistributionAdvancedSS2	Comprised of files for compiled applications that depend on SuiteScript 2.0. Created on `gulp deploy` command.
LocalDistributionAdvanced	Directory for the compiled application files used by the local server, created with `gulp local`.
LocalDistributionAdvancedSS2	Similar to LocalDistributionAdvanced but for SuiteScript 2.0 dependencies.
node_modules	Contains Node.js dependencies created with `npm install`.
gulpfile.js	JavaScript code for Gulp.js; edit only for adding new tasks.
.nsdeploy	Defines Gulp.js connection to your NetSuite account, created on the first `gulp deploy`.
distro.json	Details all modules for the SCA application and its version, located in `SC_xx.x_Live`.

Important Notes

The gulp deploy and gulp local commands generate various directories essential for deployments and local server testing, specifically tailored to the version of SCA implemented.
Editing Warning: Directly modifying files in the DeployDistribution or LocalDistribution directories can cause issues, as these directories are auto-generated.

Who This Affects

The information above is predominantly useful for:

Developers: Those working on SuiteCommerce Advanced customizations and enhancements.
Administrators: Individuals managing the setup and customization of SuiteCommerce.
Technical Support Teams: Those troubleshooting eCommerce implementations using SCA.

Key Takeaways

Familiarize yourself with the SuiteCommerce Advanced source directory structure for efficient development.
Key commands (gulp deploy and gulp local) play a vital role in generating directories.
Avoid manual edits in auto-generated directories to prevent deployment issues.

Frequently Asked Questions (4)

Does the SuiteCommerce Advanced source directory structure differ across NetSuite versions?

Yes, starting with the SCA 2019.2 release, the SuiteCommerce Advanced source directory adopted a standardized structure. This update applies to SCA 2019.2 and later versions.

What are the critical directories that should not be edited manually in SuiteCommerce Advanced?

The DeployDistributionAdvanced and LocalDistribution directories, as well as their SuiteScript 2.0 counterparts, should not be edited manually as these are auto-generated by Gulp commands like 'gulp deploy' and 'gulp local'.

What is the purpose of the 'gulp' directory in the SuiteCommerce Advanced structure?

The 'gulp' directory contains essential files used by Gulp.js for command execution. These files should not be edited directly to ensure proper functionality of build and deployment processes.

How is the 'distro.json' file used in SuiteCommerce Advanced?

The 'distro.json' file, located in the Advanced folder, lists all modules and their versions used in the SCA application. It is integral for defining the configuration and dependencies of the application.

SuiteCommerce Advanced Source Directory Structure