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 Pulse task 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.4</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 Setting the bootstrap directory.
   Example : Add website.travel.about.careers.cruise-manager.xml to /webapps/magnoliaAuthor/modules/data.

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

2. A message is logged to the user:

   INFO   info.magnolia.content.observer.TaskCreatorWatcherCallback 01.11.2016 13:18:48 
   -- File change detected at 'C:\Users\Ruth\magnolia\magnolia-enterprise-5.5\apache-tomcat
   -8.5.5\webapps\magnoliaAuthor\modules\data\website.travel.about.careers.cruise-manager.xml', 
   pulse task has been sent.

3. A task is sent to the Pulse.
   Example: Import request task and Import action for cruise-manager page in the Pulse.
    
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 Pages app.
     
6. The bootstrap directory is monitored and a new task sent to the Pulse when a change in the XML is detected. 
   Example: Changes to Cruise Manager page in XML and page editor.
      

Setting the bootstrap directory

The bootstrap directory is set in the magnolia.properties file.

The bootstrap directory can reside anywhere on the file system and can be named anything you like.

To set the bootstrap directory add the magnolia.content.bootstrap.dir property to magnolia.properties.

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 XML files from
 magnolia.content.bootstrap.dir=${magnolia.resources.dir}/data

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 tab in the Pulse.

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

Properties:

Content Import Request message view

The Content Import Request message view displays when the user opens a task.This 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: