Module Structure for Custom Development in eCatalog


Building on eCatalog’s Flexible Platform:

Programmers can extend the functionality of the eCatalog platform by developing custom modules. These modules follow a standardized structure that ensures they integrate smoothly with the core system, enhancing its capabilities and providing tailored solutions.


Detailed Breakdown of the Module Structure:


Directory and File Structure:

  • Website/eCatalog Directory:
    • [Install] Folder
      This directory contains all SQL installation files necessary for setting up the module within eCatalog. These files are executed to configure the database and other components essential for the module’s operation.
    • [module_name] Folder
      The main directory for the module, which includes:
      • Module Folder: Contains the module.xml, which defines the module in XML format. This file includes essential information such as the module name and the assembly name, crucial for the system to recognize and handle the module correctly.
      • Menu XML: The menu.xml file specifies the menu configuration in XML format. It defines how the module’s options will appear on the Settings page, ensuring that users can interact with the module’s functionalities through the eCatalog interface.
      • Web.config File: This configuration file is used to manage page access settings, such as specifying which pages allow anonymous access. By default, if nothing is specified in this file, the module will not permit anonymous access.
      • Other Assets: Includes various web assets associated with the module, such as images, CSS files, and JavaScript files, which are used to enhance the module’s functionality and user interface.


Notes on Module Structure and Usage:


Module and Menu XML Files:


  • Module Definition
    The module.xml not only defines the module but also links it to the necessary assemblies and resources, ensuring that the system can correctly implement its functionalities.
  • Menu Integration: The menu.xml plays a critical role in integrating the module with the eCatalog’s UI, defining how it appears within the system’s navigation and settings.