NetSuite Changelog
CommerceSuiteCommerceModulesConfigurationBest Practices

SuiteCommerce Advanced Build Process: File Structure & Gulp.js

Explore the SCA build process for organizing files and utilizing Gulp.js to enhance web deployment efficiency.

·2 min read·1 views·View Oracle Docs

To understand how the Suite Commerce Advanced (SCA) build process operates and why it is essential, one needs to grasp the organization of SCA source files and how the application is compiled. This article elaborates on the necessary components, tools, and processes that contribute to SCA's efficient deployment.

How Are SCA Files Structured?

The SCA source code is arranged into various modules, each containing subdirectories and files such as JavaScript, Sass, and in some cases, TypeScript files as indicated by the .ts extension. This organizational structure, while logical, can lead to inefficiencies in web deployment, necessitating the use of a build system to streamline the file transfer to web browsers.

What Is Gulp.js and Its Role?

Gulp.js is a task runner that automates the integration and management of files during the SCA build process. Specifically, it helps:

  • Identify files required for the web application.
  • Combine multiple JavaScript, Sass, and SSP library files into single files.
  • Copy additional resources necessary for the application, enhancing loading efficiency.

The results of these tasks are stored within the Distribution directory, which is subsequently uploaded to NetSuite for deployment.

Essential Configuration Files

Two key configuration files guide the SCA build process:

  1. distro.json - Defines which modules are included and specifies application configuration settings.

    • Key parameters include:
      ParameterDescription
      nameThe application name (default: SuiteCommerce Advanced <version>)
      versionSpecifies the application version.
      modulesLists SCA modules in alphabetical order. Dependencies must be respected.
      taskConfigDefines tasks required for building. Custom edits are typically unnecessary.
      copySpecifies file source and target paths for copying.

  2. ns.package.json - Works alongside distro.json to further define module contents and manage package settings.

Conclusion

Through proper use of Gulp.js and structured configuration files, the SCA build process plays a critical role in effectively managing the distribution of source files, ensuring that applications are optimized for web use.

Who This Affects

  • Developers: Understanding the build process is crucial for customizations and optimizations.
  • Administrators: Management of source files and deployment strategies are essential for system maintenance.

Key Takeaways

  • The SCA build process organizes source files into a structured format to optimize deployment.
  • Gulp.js automates file combination and management, crucial for web efficiency.
  • Configuration files distro.json and ns.package.json are pivotal for defining modules and build tasks.

Frequently Asked Questions (4)

Do I need to configure Gulp.js manually for the SCA build process in SuiteCommerce?
While Gulp.js plays a crucial role in the SCA build process for file integration and management, manual edits to the configuration files that guide Gulp's execution, such as `distro.json` and `ns.package.json`, are typically unnecessary.
What is the purpose of the 'modules' parameter in the distro.json file?
The 'modules' parameter in the distro.json file lists all SCA modules in alphabetical order, ensuring that dependencies are respected during the build process. This helps define which modules are included in the application configuration.
How does the SCA build process handle TypeScript files?
The SCA build process organizes TypeScript files within the structured module directories as indicated by their `.ts` extension and uses Gulp.js to streamline their deployment along with JavaScript and Sass files.
Where are the results of the SCA build process stored before they are deployed to NetSuite?
The results of the SCA build process, after files are combined and managed by Gulp.js, are stored within the Distribution directory. This directory is then uploaded to NetSuite for deployment.
Source: SCA Build Process — 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 →