Repository Browser

NOTE

The Repository Browser is available on AEM versions 6582 and higher.

INFO

You can also watch this clip for a quick video introduction on how to use the Repository Browser to debug AEM as a Cloud Service.

Introduction

The repository browser is a developer tool that provides a read-only view into the repository for all environments on author, publish and preview tiers. It is designed to facilitate viewing of the content structure in order to make it easier to see or debug content.

Accessible from the Developer Console, it can be used to browse the repository of an author or publish instance for a selected environment.

Access Prerequisites

These following conditions must be met in order to access the Developer Console or the Repository browser

In order to access Developer Console:

  • For Production programs, users must have the Cloud Manager - Developer Role in the Admin Console
  • For sandbox programs, it is available to any user with a product profile giving them access to AEM as a Cloud Service.

In order to access the Repository Browser:

  • Users must have the Cloud Manager - Developer Role in the Admin Console to view Author and Publish instances.
  • In addition, for author, users with the AEM Users Product Profile can view the repository browser with minimal read access; the user’s permissions are respected when browsing the repository. Users with the AEM Administrators Product Profile can view the repository browser with full read access.

For more information about setting up user permissions, see the Cloud Manager Documentation.

Launching the Repository Browser

The repository browser can be launched by following the steps below.

  1. In Cloud Manager, click the three dots next to the environment of your choice, and select Developer Console

    repobrowser1

  2. Next, click the Repository Browser tab

  3. Choose any pod corresponding to author, publish or preview by clicking on the Pod dropdown list.

    repobrowser2

  4. Launch the repository browser by clicking on the Open Repository Browser link further down. This will launch the browser corresponding to a representative instance (pod) for the chosen tier. This will launch the browser corresponding to a representative instance (pod) for the chosen tier. Note that you cannot control the specific pod for that tier that is launched.

Features

You can use the left hand navigation pane to nagivate through the content hierarchy. Clicking on each folder or node will reveal its children. The folder structure reflects the Sling Resource tree, which is a super-set of the JCR Node tree.

repobrowser3

For publish, by default, the Repository Browser will only show public content, thus certain folders like /conf or /home will not be visible.

In order to make those locations visible, you need to follow the below procedure.

  1. Click the three dots next to the environment of your choice and select Manage Access

    repobrowser7

  2. Find your publish instance, then click on it

    repobrowser8

  3. Create a new product profile for publish administrators. In the example below, it is called DEV - AEM Administrators Publish

    repobrowser9

  4. Add the appropriate users, corresponding to who should be able to navigate the publish repository browser with full access, to the new product profile

    repobrowser10

  5. Wait for a few minutes, then open the AEM author console

  6. Add the group corresponding to the new product profile as a member of the administrators group. You can do this by clicking on Tools - Security - Groups on author, then clicking on the administrators group. Then, add the group as shown below

    repobrowser11

  7. Activate the administrators and the new DEV - AEM Administrators Publish group so that they become available on publish

    repobrowser12

  8. As a good security practice, remove the new DEV - AEM Administrators Publish group from the administrators group on author so the new group is isolated to publish

    repobrowser13

  9. Upon accessing repository browser for a publish instance, all folders are visible, including /home and /conf.

View JCR Properties

Clicking on a node will reveal its JCR properties in the right hand pane of the navigation browser. Below is an example for the experience-fragments node.

repobrowser4

View Content

You can use the repository browser to view content by clicking on a resource in the navigation pane. This will open a preview on the right hand side of the browser, under a tab named after the respective resource.

repobrowser6

Preview is currently available for image types in the list below:

  • apng
  • avif
  • gif
  • jpeg
  • png
  • svg+xml
  • webp
  • bmp
  • x-icon
  • tiff

And for the following text-based mime-types:

  • "text/*"
  • 'application/javascript'
  • 'application/json'
  • 'application/x-sh'

Download Content

You can also use the repository browser to download content. In the example below, you can press the download link to download the jcr:data associated with the selected node. This feature is available for all binary properties by navigating to the node containing the property definition.

repobrowser5

On this page