JCR Browser app

The JCR Browser app is a Magnolia tool that allows you to work at the repository level in any workspace. You can see details that are not readily visible in a specific app’s tree view as well as edit content and associated configuration.

Configuration

The JCR Browser app is in the JCR Tools app group that is only available to the superuser role. This restriction is configured in the app launcher layout.

The app is configured in /modules/jcr-browser-app/apps/jcr-browser.

Using the app

Be careful when editing and adding content in any workspace because you are working at the repository level.
  • Browsing: Use the dropdown to switch between workspaces. All workspaces are available. If you create a new workspace, it will be automatically available in the app.

image

  • Display system properties: Click the filter iconimageand select the checkbox to display properties such as UUIDs, creation dates and user information. System properties are hidden by default. When displayed, they cannot be edited.

image

  • Editing: You can work with all content, except system properties, in the same way as in any other app.

The Configuration app is essentially a JCR browser that displays the config workspace.

Example website JCR browser

The JCR browser shows content as it is stored in the JCR and is useful for looking at details that you would not see in the Pages app.

Example: Compare the Travel Demo’s About page in the JCR browser and in the editor.

image

image

Property Description

<page folders>

Pages (mgnl:page) are stored in folders:

  • The page folder structure matches the website tree structure.

  • There are content nodes for each page area.

  • All area nodes reside at the same level, regardless of whether configured as main or nested areas.

     <area nodes>

Areas (mgnl:area) are stored in content nodes:

  • single and list areas have component subnodes.

  • noComponent areas can be used in various ways but typically have only area properties.

         <component nodes>

Components (mgnl:component) are stored in numbered content nodes:

  • Node numbers are sequential and assigned automatically.

  • Nodes are displayed in the same order as on the page.

  • The assigned number depends on when the component was created. The rendering order may not match the numbering order.

  • Components with nested components follow the same structure as area nodes. See component definition.

             <component properties>

Component properties are stored under the component node:

  • Property names correspond to dialog field names.

  • i18n properties have a locale suffix by default.

         <area properties>

Area properties, if any, reside under the area node.

     <page properties>

Page properties reside under the page node:

  • Property names typically correspond to field names in the Page properties dialog.

  • Components or areas can also add page-level properties.

Editing in the website JCR browser

Editing content directly in the JCR browser rather than in a dedicated app may damage the integrity of your data.

There are certain things that you can do in the JCR browser and not the editor. For example:

  • Add multiple similar components to a page using the Duplicate item action. This saves the time and effort of adding the components from scratch in the editor. Duplicates can be modified in the JCR browser or the editor.

  • Add the same component to multiple pages. Duplicate a component in one page and then move the duplicate to the same area in one or more other pages.

Do not move components from one page area to another. For seamless publishing, your page content must always comply with the options in the template.

Publishing in the website JCR browser

Publishing in the JCR browser is different from publishing in the Pages app:

  • When you publish a page in the JCR browser, only the page and its properties are published.

  • When you publish a page in the Pages app, the page and all its children (properties, areas and components) are published.

dev days event sign up
dev days event sign up
Feedback