SuiteCommerce Advanced Module Architecture and Structure

SuiteCommerce Advanced (SCA) organizes its source files into various modules, allowing for a clean and efficient structure for web development. Understanding this architecture is crucial for developers aiming to customize and extend SCA functionality.

What are the Types of Modules in SCA?

SCA is defined by multiple module categories:

• Application modules: These are the higher-level collections grouping feature sets that perform similar functions, specifically in three areas:
  • Shopping
  • Checkout
  • My Account
• Feature modules: These focus on specific functionalities within SCA. For instance, the Case Management feature is encapsulated within the Case module.
• Framework modules: They provide the foundational logic and structure that governs the interaction between modules and applications, allowing application modules to extend their functionalities.
• Utility modules: Serving multiple modules, these provide shared functionalities. An example is the GlobalViews module, which defines commonly reused views within SCA.

How are SCA Modules Structured?

Each module follows a consistent file structure correlating with the Asynchronous Module Definition (AMD) API. This is pivotal when using RequireJS, which asynchronously loads the necessary modules effectively. A typical module file is structured as follows:

1define('<module_name>',
2   [   '<dependency_1>',
3      '<dependency_2>'
4   ],
5   function (<module_1>, <module_2>) {
6      <module code>
7}

Explanation of Structure Components:

• module_id: A string defining the module's name.
• dependencies: An array listing the names of necessary dependencies, which can be other modules or core components.
• function: The function that instantiates the module.

Adhering to this structure allows the developer tools to compile the application into a single JavaScript file, optimizing the load process by managing dependencies from the top-level application modules down to the feature and utility modules.

Who This Affects

• Developers: Those customizing SCA will greatly benefit from understanding module architecture.
• Administrators: Knowledge of module functionality aids management of SCA applications.
• Project Managers: Insight into module architecture assists in planning integrations and customizations.

Key Takeaways

• SCA consists of application, feature, framework, and utility modules that simplify web development.
• Each module adheres to a structured format based on the AMD API, enhancing load efficiency.
• Familiarity with module architecture is essential for developers and administrators working with SCA.