Module Definition in eCatalog


Enabling Seamless Module Integration and Execution:

The Module Definition feature in eCatalog allows programmers to define essential details about custom modules so that the system can properly recognize and execute them. This XML-based configuration specifies everything from assembly details to module visibility, ensuring that each component behaves as intended within the eCatalog environment.


Structure of a Module Definition File:

A module definition file in XML format provides a structured way to outline the characteristics and behaviors of a module. Here’s an example of what a typical module definition file might look like:



<?xml version="1.0" encoding="utf-8" ?>

<Module>

  <ModuleName>CLIP</ModuleName>

  <Version></Version>

  <ModuleDescription>Clinician Integrated Portal</ModuleDescription>

  <ModuleTitle>Clinician Integrated Portal</ModuleTitle>

  <ModuleAssembly>Glenosoft.eCatalog.Module_CLIP.Context,Glenosoft.TTSH.CLIP, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null</ModuleAssembly>

  <ModuleStartPage>/</ModuleStartPage>

  <ModuleVisible>1</ModuleVisible>

  <ModuleType>1</ModuleType>

  <ModuleAssemblyFile></ModuleAssemblyFile>

  <Status>0</Status>

</Module>




Key Elements of the Module Definition:


  • ModuleName
    Identifies the module by name, which is used within the system to reference the module.
  • ModuleDescription
    Provides a brief description of what the module does, enhancing understanding and manageability.
  • ModuleTitle
    The title of the module as it should appear in any user interfaces or documentation.
  • ModuleAssembly
    Specifies the full name of the module’s main assembly, including its namespace, name, version, culture, and public key token if applicable.
  • ModuleStartPage
    Defines the default or start page of the module once loaded.
  • ModuleVisible
    Indicates whether the module should be visible within the eCatalog user interface (1 for visible, 0 for not visible).
  • ModuleType
    May be used to categorize the module type for system organization or behavior.
  • ModuleAssemblyFile
    If separate from the main assembly, this can specify an additional assembly file necessary for the module’s operation.
  • Status
    Represents the operational status of the module, such as active (1) or inactive (0).



Module Class


The module class need to inherit from ModuleBase and IModule