Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

The JCR Tools app includes four subapps that allow you to work with JCR content: 

  • Queries: Execute JCR queries in any workspace.
  • Dumper: Create a dump of any workspace.
  • Exporter: Export JCR content to XML or YAML.
  • Importer: Import JCR content from XML or YAML. 

JCR Tools app replaces three pre-5.4.6 legacy apps - JCR Queries app, Export app and Import app - and combines them into a single app.

Configuration

The app is configured in /modules/jcr-tools/apps.The Tools app group that the app belongs to is only available to the superuser role. This is configured in the app launcher layout. 

Node name

 modules

 jcr-tools

 apps

 subapps

 query

 dumper

 exporter

 importer

Query subapp

Query subapp allows you to run JCR queries. The tool is a good place to test queries. You can write queries in SQL-2, SQL and XPath and run them on any workspace. See JCR Query Cheat Sheet for example queries.

The Query subapp only returns lists of nodes. While you can specify "columns" in your queries, these are discarded and only paths will be returned.

eg. A query like SELECT title, foo FROM [mgnl:category] will return results like

/tour-types/active

/tour-types/ecotourism

...

Dumper subapp

Dumper subapp allows you to create a dump of any Magnolia workspace. You can set the base path and path level from which to dump the data. 

Exporter subapp

Exporter subapp allows you to export files from all workspaces, including those where the Export action is not available in the workspace-specific app, for example in the Security and Forums apps. You can export in XML or YAML format and compress to GZIP or ZIP format. 

Magnolia offers a number of ways to export data, see Importing and exporting JCR data for bootstrapping for more and instructions on using the tool.

Importer subapp

Importer subapp allows you to import XML or YAML files into any Magnolia workspace, including those where the Import action is not available in the workspace-specific app, for example in the Security and Forums apps. You can set the base path and behavior for the imported data. Behavior options are:

  • Only import if no existing node.
  • Generate a new id for imported nodes (XML only).
  • Remove existing nodes with the same id (XML only).
  • Replace existing nodes with the same id (XML only).

Magnolia offers a number of ways to import data, see Importing and exporting JCR data for more and instructions on using the tool.