Module Definition

The definition of a module is performed through a markup file in XML format, which must follow the schema file provided by the portal. The link to this schema file can be found on the API and XSD page.

The definition of the module is mandatory and must be done with a file called lumis-module.xml. This file must be located in a folder called META-INF. This folder, in turn, must be located at the root of the module.

In this file, the following can be defined:

• Module Identifier: This field is mandatory and provides the identifier of the module.
• Display Name: Optional. Provides the display name for this module.
• Description: Optional. Provides a description for the module.
• Version: Optional. Indicates the version of the module.
• Scope: Optional. Indicates whether the module should be global or isolated. For more information, see Portal Classloader. If not defined, it will be considered isolated.