Modules

Magnolia has a modular architecture. A module can perform a task, package content, or provide specialized functionality. Modules can be project specific or reused across different projects. You should use the module mechanism to package and deploy your own site’s configuration and functionality.

In Magnolia documentation, the terms module and project module always refer to a Magnolia module.

What makes a Magnolia module are files specific to Magnolia in a particular folder. You can add such a Magnolia module folder directly into the webapp of your Magnolia instance.

You can define a Magnolia module with one file, with its Module descriptor. Typically, the descriptor resides either in a Maven module or within a light module together with other files.

When you are creating a website project, you should have one module for templates, another module for content, a third for a theme, and so on.

  • Maven module

  • Light module

Maven also uses the term module but it means something different. For this, we explicitly write Maven module. You can make the Magnolia module folder part of a Maven module. In that case you would build a JAR file and deploy it to your webapp.

You don’t need to know Java or Maven to create a perfectly valid Magnolia module. Put your project files into a file-system directory to create a light module.

Use YAML-based configuration and Magnolia’s unified resource loading.

This enables light development, a development style which does not require Java skills or a Java development environment. It’s a straightforward way to get started with Magnolia development and works well for front-end developers. The Hello Magnolia tutorial uses light development to create a fully-functional template module.

Store your light modules outside of the apache-tomcat directory so that the modules you add can be accessed by any Magnolia instance. If you already have a light modules directory you want to use, edit the magnolia.resources.dir property in your magnolia.properties file to point to it.

Bundled modules

Some modules are bundled as part of the Community Edition (CE) or standard DX Core offering. This means the module is automatically installed as part of your project.

All others modules are are unbundled. For these modules, you can pick and choose the modules you want to add to your project. Note that additional licenses may be required.

List of modules

Module compatibilities with DX Core and CE

The value in the SPA column marks the module’s availability for implementation in SPA/Headless projects.
Module Edition Bundling options SPA Latest version Issues

About App module

CE

Yes

n/a

6.2.19

MGNLUI

Admincentral module

CE

Yes

n/a

6.2.38

MGNLUI

Advanced cache modules

DX Core

Yes

n/a

2.3.5

MGNLADVCACHE

Backup module

DX Core

Yes

n/a

2.5.1

MGNLBACKUP

Blossom module

CE

Yes

n/a

3.7.2

BLOSSOM

Cache modules

Multiple (see modules)

Yes

n/a

5.9.12

MGNLCACHE

Campaign Publisher module

DX Core

Yes

n/a

2.0.4

MGNLCAMPU

CAS module

DX Core

Yes

n/a

1.3.2

MGNLCAS

Categorization module

CE

Yes

n/a

2.9.1

MGNLCAT

Configuration Framework module

CE

Yes

n/a

6.2.46

MAGNOLIA

Contacts module

CE

Yes

n/a

1.8.4

CNTCTSAPP

Content Dependencies module

DX Core

Yes

n/a

2.0.5

MGNLCDEP

Content Editor module

DX Core

Yes

n/a

2.1.10

CONTEDIT

Content Importer module

CE

Yes

n/a

1.0.5

MGNLCI

Content Tags module

DX Core

Yes

n/a

2.0.6

CONTTAGS

Content Translation Support module

DX Core

Yes

n/a

2.5.11

MGNLCTS

Content Types module

CE

Yes

n/a

1.2

MGNLCT

Definitions App module

CE

Yes

n/a

2.1.3

CFGUI

Device Detection module

CE

Yes

n/a

1.1

DEVDECT

Diff module

DX Core

Yes

No

2.2.7

MGNLDIFF

Digital Asset Management module

CE

Yes

n/a

3.0.33

DAM

Form module

CE

Yes

No

2.7.8

MGNLFORM

GraphQL module

DX Core

Yes

n/a

1.1.8

MGNLGQL

Groovy module

CE

Yes

n/a

3.0.5

MGNLGROOVY

High performance caching modules

DX Core

multiple (see modules)

n/a

multiple (see modules)

multiple (see modules)

Image Recognition module

DX Core

Yes

n/a

1.2.5

IMGREC

Imaging module

CE

Yes

n/a

3.5.10

MGNLIMG

Javascript Models

CE

No

No

2.0

JSMODELS

JCR Tools module

CE

Yes

n/a

1.3

JCRTOOLS

LDAP Connector module

DX Core

Yes

n/a

1.10.4

MGNLLDAP

Log Tools module

CE

Yes

n/a

1.1.2

LOGTOOLS

Mail module

CE

Yes

n/a

5.6.3

MGNLMAIL

Marketing Tags module

DX Core

Yes

Yes

2.0.1 [1]

MGNLTAGS

Messages App module

CE

Yes

n/a

6.2.19

MGNLUI

MTK module

CE

Yes

No

2.0.3

MTK

MTE module

CE

Yes

n/a

2.0.3

MTE

Multisite module

DX Core

Yes

Yes

2.1.5

MULTISITE

Observation module

CE

Yes

n/a

2.2.1

MGNLOBS

Pages module

CE

Yes

Yes

6.2.36

PAGES

Password Manager module

CE

Yes

n/a

1.2.8

PSWDMNGR

Periscope module

CE

Yes

n/a

1.2.10

MGNLPER

Personalization module

DX Core

Yes

Yes

2.1.12

MGNLPN

Privacy module

DX Core

Yes

n/a

2.0

MGNLPRIV

Public User Registration module

CE

Yes

No

2.7.7

MGNLPUR

Publishing module

CE

Yes

n/a

1.3.14

PUBLISHING

Publishing Transactional module

DX Core

Yes

n/a

1.2.4

EEPUBLISH

Resources module

CE

Yes

n/a

3.0.10

MGNLRES

REST Client module

CE

Yes

n/a

2.0.5

MGNLRESTCL

REST module

CE

Yes

n/a

2.2.27

MGNLREST

RSS Aggregator module

CE

Yes

n/a

2.6.6

MGNLRSSAGG

Scheduler module

CE

Yes

n/a

2.3.6

MGNLSCH

Security app module

CE

Yes

n/a

2.3.6

MGNLUI

Site module

CE

Yes

n/a

1.4.6

MGNLSITE

Soft Locking module

DX Core

Yes

n/a

3.1.4

MGNLSLOCK

Solr module

DX Core

Yes

n/a

6.1.11

MGNLEESOLR

SSO module

DX Core

No

n/a

3.1.9

MGNLSSO

Synchronization module

DX Core

Yes

n/a

2.0.1

MGNLSYNC

Text Classification module

DX Core

Yes

n/a

1.1.6

TXTREC

Tools module

DX Core

Yes

n/a

1.9.3

MGNLTOOLS

User Result Ranker module

DX Core

Yes

Yes

1.0.3

MGNLRANK

UI Framework REST Extensions module

DX Core

Yes

n/a

1.0.6

MGNLRESTUI

UI module

CE,Cloud

Yes

n/a

6.2.46

MGNLUI

UI Media Editor module

CE,Cloud

Yes

n/a

6.2.46

MGNLUI

Virtual URI module

CE

Yes

n/a

6.2.46

MAGNOLIA

Webhooks module

DX Core

Yes

n/a

1.0.2

MGNLHOOK

Workflow module

DX Core

Yes

n/a

6.0.14

MGNLWORKFLOW

Module bundling for webapps

magnolia-empty-webapp is the base Magnolia webapp. All other webapps build upon it successively. dx-core-webapp on top of the empty webapp, dx-core-demo-webapp overlaying dx-core, and so forth. The same is true for CE editions, with magnolia-community-webapp and magnolia-community-demo-webapp built successively on the empty webapp.

Module Bundled in magnolia-empty-webapp Bundled in dx-core-webapp Bundled in dx-core-demo-webapp

About App module

Yes

Yes

Yes

Admincentral module

Yes

Yes

Yes

Advanced cache modules

No

Yes

Yes

Backup module

No

Yes

Yes

Cache modules

Yes

Yes

Yes

Content Dependencies module

No

Yes

Yes

Content Editor module

No

Yes

Yes

Content Importer module

Yes

Yes

Yes

Content Tags module

No

Yes

Yes

Content Types module

Yes

Yes

Yes

Definitions App module

Yes

Yes

Yes

Diff module

No

Yes

Yes

GraphQL module

No

Yes

Yes

Image Recognition module

No

No

Yes

Marketing Tags module

No

Yes

Yes

Multisite module

No

Yes

Yes

Pages module

Yes

Yes

Yes

Personalization module

No

Yes

Yes

Publishing module

Yes

Yes

Yes

Publishing Transactional module

No

Yes

Yes

Resources module

Yes

Yes

Yes

Scheduler module

Yes

Yes

Yes

Security app module

Yes

Yes

Yes

Soft Locking module

No

Yes

Yes

Text Classification module

No

No

Yes

Tools module

No

Yes

Yes

User Result Ranker module

No

Yes

No

Virtual URI module

Yes

Yes

Yes

Webhooks module

No

Yes

Yes

Workflow module

No

Yes

Yes

Unbundled modules, for example, Campaign Publisher in dx-core, may still be managed in a webapp’s parent pom if some custom project needs to use them.

Connector Pack modules

Module Connector Pack Bundled in DX Core SPA Latest version Issues

Analytics module

Analytics Connector Pack

No

n/a

1.2.3

Analytics

E-commerce module

Commerce Connector Pack

No

Yes

1.3.6

ECOMMERCE

External DAM module

DAM Connector Pack

No

n/a

1.1.6

EXTDAM

Marketing Automation module

Marketing Automation Connector Pack

No

Yes

1.0.4

MKTAUT

Siteimprove module

Optimization Connector Pack

No

n/a

1.2.1

SIMPROVE

Special Feature modules

Module Bundled in DX Core SPA Latest version Issues

A/B/n Testing module

No

No

1.0.1

ABTEST

Live Copy module

No

Yes

3.2.15

LIVECOPY

Incubator modules

Incubator modules are developed and supported by Magnolia Professional Services. They have typically been developed in close collaboration with customers to meet requirements not covered by the core product. Now you can benefit from these useful features in your projects as well. However, you must assume some risk as the modules have not been through a rigid development process.

General information

  • Licensing

  • Support

  • Issues

Only available to Magnolia Enterprise customers.

Our MLA is friendly and includes access to the source code. All extensions are covered by this agreement.

See also the GPL.

Incubator modules are supported by the Magnolia Professional Services team. It is crucial to be aware that incubator modules supported by Magnolia Professional Services are based on commercially reasonable efforts only, meaning the team is not bound to fix any bug or issue right away. The estimated completion time could be defined, but no guarantee is made.

Please, open a ticket in the appropriate Jira project.


1. In Magnolia 6.2, preconfigured Magnolia DX Core bundles contain version 1.4.4 of the Marketing Tags module. Version 1.4 is compatible with the 5 UI framework. If you wish to use module version 2.0 (or higher), you must first remove the 1.4.4 module.
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules