Content Importer module

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

<dependency>
  <groupId>info.magnolia.content</groupId>
  <artifactId>magnolia-content-importer</artifactId>
  <version>1.0.3</version>
</dependency>

• magnolia-content-importer.jar

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.

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 website.travel.about.careers.cruise-manager.xml to /magnoliaAuthor/data.

   └─<magnoliaAuthor>
   	└─data
   		└─website.travel.about.careers.cruise-manager.xml

2. A message is logged to the user:

   2019-03-28 14:27:06,676 INFO magnolia.content.observer.TaskCreatorWatcherCallback: File change detected at '/magnoliaAuthor/data/website.travel.about.careers.cruise-manager.xml', 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.
    
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.
   
5. The bootstrapped content is available in the relevant app. 
   Example: Cruise Manager page in the Pages app.
   
   
6. The bootstrap directory is monitored and a new task sent to the Tasks app when a change in the XML is detected.

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 magnolia.properties 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
magnolia.resources.dir=${magnolia.home}/modules
......
# The directory to import file system content files from
 magnolia.content.bootstrap.dir=${magnolia.resources.dir}/data

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.

Configuration

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.

Properties:

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.

Properties: