Module's config.xml File

The config.xml is the file that defines a module. It's used by NexoPOS to identify a module and to distinguish it among other modules. This will explain all you need to know about the config.xml file.

Structure Of The config.xml File

That file is located at the root of every module. A module not having that file is not a valid module and might even not appear as a module on the dashboard. That file must have a specific structure like so :

<?xml version="1.0" ?>
<module>
    <namespace>NsStockTransfers</namespace>
    <version>4.5.1</version>
    <author>Blair Jersyer</author>
    <name>Stock Transfers Module</name>
    <description>module description</description>
    <requires>
        <dependency namespace="NsMultiStore" min-version="4.5.0">Nexo Multi Store Module</dependency>
    </requires>
    <core min-version="4.5.8"/>
</module>

The "module" tag is a required parameter. As a child, it has the following tags

  • namespace (required): a unique identifier of the module. Should not have any space or special character.
  • version (required): the actual version of the module.
  • author (required): The name of the author.
  • name (required): A human name for the module. This will be displayed on the module list.
  • description (required): a brief description of what does the module. Will also be displayed on the modules list.
  • requires (optional): this defines the dependencies requires by the module.
  • dependency (optional): describe a dependency required for the module. can include a min-version or max-version to enforce a specific version. The namespace attribute should be the same as the dependency namespace. The value within the tag "dependency" should be the "name" of the dependency.
  • core (optional): define what should be the version required for NexoPOS. This ensures the module to be executed on a compatible environment.