Module Settings

Last modified: April 18, 2024

1 Introduction

Module settings allow you to choose the type of the module when you build your app and to set a version for certain module types:

To open module settings, select the module in the App Explorer and double-click Settings:

2 Module Type

There are three different types of modules and the choice of the type depends on the purpose of the module. You can choose one the following:

2.1 App Module

App module is a standard way of structuring your app. Use app modules to distinguish between functional domains: create an app module for each relevant domain and put all pages, microflows, entities, and other documents in one place.

An App module is exported as a package file (.mpk ) that includes the full source code of the module.

2.2 Add-on Module

An add-on module is a stand-alone module that is not dependent on other modules and is used as a separate element, for example, as a connector.

An add-on module is exported as an module file (.mxmodule) that only exposes the elements with the Usable export level. For more information on Export levels, see Configuring Add-on and Solution Modules for Publishing. Its source cannot be inspected by the consumer of the module.

If you are creating functionality that can be exported and used by other users separately and independently of the rest of the app, you can set your module to an add-on type.

When the module is set as the add-on module, it gets the letter A as an icon.

2.3 Solution Module

Solution modules are only used for developing a solution and are an inseparable part of it. Set of solution modules used for the solution form the solution core. Solution modules are exported as a solution package and distributed as a solution to multiple consumers. For more information on solutions, see Create Solutions in the Marketplace Guide.

When the module is set as the solution module, it gets the letter S as an icon.

3 Module Version

A version number of the module. The version should be a semantic version (i.e. consisting of at least three parts: major, minor, and patch version). For more information on semantic versions, see Semantic Versioning.

Mendix recommends setting a new version every time changes are made to the module.

5 Read More