This is an internal documentation. There is a good chance you’re looking for something else. See Disclaimer.

Different Module Types

Nice2 is split into different type of modules.

Core Modules

Core modules provide the basic functionality of a Nice2 installation. All core modules are always installed on every installation. A Nice2 installation would not work without them.

Core modules can be found in: core/*

Optional Modules

Optional modules (also called marketing modules) are, as the name lets guess, optional. An optional module represents a feature or functionality which a customer can add to his installation depending on his demand.

Optional modules can be found in: optional/*

Customer Modules

For every customer installation a customer module exists. A customer module configures the installation of the customer. A customer module defines which optional modules (marketing modules) are installed. Also customer specific adjustments which only belong to the customer are done in customer modules.

Customer modules can be found in: customer/*

Intermediate Modules

A intermediate module is always needed if a feature or functionality should be added automatically [1] if two or more specific modules are installed.

Example: There are two modules donation and sms. The module donation has an entity donation and a form donation_list.xml which displays the donations. The module sms has an action to send sms. See the following picture.

digraph {
  donation [
    label=<<b>Optional Module: donation</b><br/><br/>Contains te form Donation_list.xml>
  sms [
    label=<<b>Optional Module: sms</b><br/><br/>Contains the action to send sms>
  donationsms [
    label=<<b>Intermediate Module: donationsms</b><br/><br/>Extends Donation_list.xml with an sms action>

  { donation sms } -> donationsms [ label="depends on", dir=back ]

If a customer has installed both modules (sms and donation), the action to send sms should be available automatically [1] on the form donation_list.xml. The intermediate module donationsms which depends on the modules sms and donation adds this action to the form.

The name of an intermediate module consists of the names of the depending modules. For example the module licencecorrespondence depends on the modules licence and correspondence.

Intermediate modules can be found in: optional/*


A intermediate module

  • adds functionality automatically [1] if at least two other specific optional modules are installed

  • depends on at least two other modules

  • is not licensed separately (otherwise it must be an optional module)

  • has a name that consists of the names of the depending modules