Using the Console

Overview

The Bloomreach Content Console provides access to low-level repository operations for developers and administrators. By default, the Console is available at /console relative to the CMS context root. For local development, access the Console at http://localhost:8080/cms/console/.

Logging In

To access the Console, log in with a user account that has admin privileges.

You can only use the same user account to log in to both the CMS and Console applications within a single browser session. If you log in to one application, then log in to the other using a different user account in the same session, you will be logged out of the first application. To use two different user accounts simultaneously, open each application in a separate browser session (for example, by using incognito windows).

Browsing and Viewing Content

Use the tree on the left to navigate repository content. Select a node to view or edit its details in the form on the right.

Saving Changes

Changes made in the Console are not saved immediately. They remain as transient state in your session until you select the Write changes to repository button in the upper right corner. When you have unsaved changes, this button is highlighted in red. To discard pending changes, select the "Reset" button next to it.

Basic Operations

You can add, delete, copy, move, and rename nodes, as well as add properties to nodes. These operations are available from the main menu bar and from the context menu, which you can open by right-clicking a node in the browse tree.

Keyboard Shortcuts

Several functions are available through keyboard shortcuts. You can also navigate the tree using the arrow keys. To view all available shortcuts, select the question mark ('?') in the main menu to open the keyboard bindings dialog.

Advanced Operations

The top bar of the Console provides advanced operations. Key features include:

Importing and exporting system view XML or YAML
Importing and exporting (viewing) compact node type definitions (CNDs)
Resetting a node to its bootstrap content

YAML Export and Binary Properties

When exporting nodes with binary properties (such as images), download the content as a ZIP file. The YAML format requires binary resources to be stored as separate files packaged with the YAML.

Deep Linking to a Node

You can link directly to a specific node in the repository by using the path or uuid request parameter:

https://localhost:8080/console/?path=/content/documents/hippogogreen/about/about

https://localhost:8080/console/?uuid=c9f06d11-8a4f-44d7-a517-fa0ace60c147

When you browse the node tree in the Console, the URL updates automatically to include the path parameter for the currently selected node.