Configure a Page Tool

Overview

This page describes how to configure an Open UI page tool in Bloomreach Content.

When to Use

Configure a page tool to make it available in the Experience manager as a tab in the right-side panel.

Prerequisites

Access to the JCR repository.
Permission to modify nodes under /hippo:configuration/hippo:frontend/cms/ui-extensions.

Configuration Steps

To configure a page tool:

Create a child node of type frontend:uiExtension under /hippo:configuration/hippo:frontend/cms/ui-extensions.
Configure one or more page tools as needed. Each node represents a separate tool and appears as a tab in the Experience manager. The order of the nodes determines the tab order.

Page Tool Node Properties

Configure the following properties on each frontend:uiExtension node:

Property	Description	Remarks
`frontend:config`	String containing configuration values passed to the page tool. For example, use this to provide an API key. The interpretation of this string depends on the tool.

Note: Since v14.7, you can use variable references from the Container Configuration for the CMS application (such as $CATALINA_BASE/conf/platform.properties).

Example:
Set the property to:

{ "my.backend.api.url": "${backend.url}" }

If you define backend.url=https://api.example.com in the container configuration, the value is resolved at runtime to:

{ "my.backend.api.url": "https://api.example.com/" } | optional | | frontend:displayName | Name displayed on the tool's tab in the Experience manager. | mandatory | | frontend:extensionPoint | Specifies where the extension appears in the CMS. For page tools, set this to channel.page.tools. | mandatory | | frontend:initialHeightInPixels | Not used for page tools. | optional | | frontend:url | URL where the tool is served. This value is used as the src attribute of the iframe.

If the URL starts with http:// or https://, it is used as provided. Other URLs are treated as paths relative to the CMS origin.

Recommendation: Host extensions on a different origin than the CMS to improve security and allow independent deployment. | mandatory | | frontend:iframeAllow | **Since 17.3.0.**Value to set as the allow attribute of the iframe, used to delegate browser permissions (e.g. "clipboard-read; clipboard-write") to the extension.If not set, no allow attribute is set. | optional |

Example Node Structure

/hippo:configuration/hippo:frontend/cms/ui-extensions
  my-page-tool:
    jcr:primaryType: frontend:uiExtension
    frontend:displayName: My Tool
    frontend:extensionPoint: channel.page.tools
    frontend:url: https://my-tool.example.com/
    frontend:config: '{ "my.backend.api.url": "${backend.url}" }'

Security

By default, a security domain is bootstrapped at /hippo:configuration/hippo:domains/ui-extensions. This configuration allows users in the everybody group to read the page tool nodes.

Availability

All configured page tools are available in all channels.