Content Importer module

Edition CE




Maven site



The Content Importer module allows you to bootstrap content from the file system into the JCR. The module adds bootstrapping capabilities for light modules. You can import content during development, distribution and deployment of light modules. For example, import sample content for a new template so authors can immediately see how the template works.

Magnolia monitors the bootstrap directory on the file system. When Magnolia detects a change, it sends a message to the Tasks app to the superuser account. The superuser can then import the content. This allows you to import content in a controlled way, ensuring that no existing content is overridden by accident.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:


How content import works

To demonstrate how content import works, we bootstrap a cruise-manager page into the /travel/about/careers section in the Pages app.

To create a bootstrap file for testing, create a page in the Pages app, export it and save the file to a temporary location on your computer. Next, delete the page in the Pages app and then add the file to your bootstrap directory on the file system. See Importing and exporting JCR data for bootstrapping for more.

Here’s how bootstrapping files from the file system works in the UI:

  1. An XML file is added to the bootstrap directory. See Bootstrap directory.
    Example : Add to /magnoliaAuthor/data.

  2. A message is logged to the user:

    2019-03-28 14:27:06,676 INFO File change detected at '/magnoliaAuthor/data/', pulse task has been sent.
  3. A task is sent to the Tasks app.
    Example: Import request task and Import action for cruise-manager page in the Tasks app.
    Import request task and Import action for cruise-manager page in the Tasks app

  4. superuser assigns himself the task and clicks Import to import the content into the corresponding workspace in the repository. He can also Reject or Abort the import.
    Content Import Request tab

  5. The bootstrapped content is available in the relevant app.
    Example: Cruise Manager page in the Pages app.
    Cruise Manager page in the Pages app
    Cruise Manager in edit mode

  6. The bootstrap directory is monitored and a new task sent to the Tasks app when a change in the XML is detected.

  • Observation only occurs if the bootstrap directory is set in the file.

  • Deletions are not removed automatically. To remove content, delete it in the JCR and the bootstrap directory.

Bootstrapping settings

You can use the Server configuration page in the About app to check the current bootstrapping settings.

Bootstrap directory

To set the bootstrap directory, add the magnolia.content.bootstrap.dir property in the file. The bootstrap directory can reside anywhere on the file system and can be named anything you like.

Example: Setting the bootstrap directory as a subdirectory of the resources directory.

# The directory to expose file system resources from
# The directory to import file system content files from

Subdirectories of the bootstrap directory are also monitored. You can structure your bootstrap files within the bootstrap directory.

Filename pattern

Use the magnolia.content.bootstrap.pattern property to specify which filenames will be imported and observed in the content bootstrap directory.

Example: magnolia.content.bootstrap.pattern=/data/.xml

Bootstrapping strategy

You can use two properties to configure a content bootstrapping strategy: magnolia.content.bootstrap.onlyImportAtInstall and magnolia.content.bootstrap.createTasks.

  • onlyImportAtInstall=true and createTasks=always: the most restrictive strategy. Content is bootstrapped only at installation, not at every instance startup. No content is bootstrapped automatically.

  • createTasks=onchange: the most permissive strategy. Content is bootstrapped automatically if the path does not exist in JCR. If the path exists, a task is created.

  • createTasks=never: content is bootstrapped at every startup and after every change.

The default configuration is onlyImportAtInstall=false and createTasks=always.

Possible values for createTasks are always, onchange and never.


The module is configured in /modules/content-importer.

No configuration changes are required unless you customize the implementation.

Content Import Request task

The Content Import Request task displays in the Tasks app.

This task is configured in /modules/content-importer/tasks.

The Content Import Request task configuration

Property Description



Tasks folder.



Task name.



Users who can view and assign tasks.

Please note that at least one user or one group (see the next property) should be defined for bootstrap messages to be displayed. The default configuration comes with superuser.



User groups who can view and assign tasks.



Message view displayed in detail view.



content message view definition.



Task title.

Content Import Request message view

The Content Import Request message view is displayed to the user who opens a task. The view is mapped to the Content Import Request task in the taskView property (above).

The Import (approve) action uses a custom action implementation class that is responsible for importing the bootstrap file into the JCR. With this exception, it is a standard message view definition.

The content message view is configured in /modules/content-importer/messageViews/content.

Content Import Request message view

Property Description



Message views folder.



Message view name.



Form definition node.

Text fields (read only):

  • content.repository: Target workspace.

  • content.path: File source path.

  • content.modificationDate: Modification date.



Actions definition node.

             <action definitions>


Configured actions:

  • approve:

Property Description



Availability rules node.



Action definition class.

info.magnolia.ui.admincentral.shellapp.pulse.task.action.ResolveTaskActionDefinition: Action for resolving a task.






Action icon.



Implementation class.

info.magnolia.content.action.BootstrapAction executes bootstrap import action and resolves task by delegating to ResolveTaskAction.
  • confirmRejection: Reject action definition. Opens the reject dialog (configured in the module dialogs folder) that allows the user to leave a comment.

  • retry: Retry import task action definition.

  • claim: Assign to me action definition.

  • archive: Remove from list action definition.

  • abort: Abort action definition.



Action bar definition.


DX Core



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