Configure a Page Tool
Introduction
Goal
Configure an Open UI page tool.
Background
An Open UI page tool must be configured in the repository to make it available in the Experience manager.
Configure a Page Tool
A page tool must be configured with a node of type frontend:uiExtension as child node of the node at the path /hippo:configuration/hippo:frontend/cms/ui-extensions.
One or more page tools can be configured. Each tool is shown in the Experience manager in the right side panel in a separate tab. The order of nodes determines the tab order.
A page tool configuration node accepts the following properties:
|
Property |
Description |
Remarks |
|---|---|---|
|
frontend:config |
A string of configuration values to be passed to the page tool. This could be for example an api key that the tool requires. How the string is interpreted is up to the page tool. Since v14.7, this property value may contain variable references using the Container Configuration for the CMS application (e.g, $CATALINA_BASE/conf/platform.properties).
Suppose this property is set to the following containing a reference to the variable called "backend.url": { "my.backend.api.url": "${backend.url}" } And if you set the backend.url property with value, "https://api.example.com", in the Container Configuration for the CMS application (e.g, $CATALINA_BASE/conf/platform.properties), then the property value will be interpreted to the following at runtime: { "my.backend.api.url": "https://api.example.com/" } |
optional |
| frontend:displayName | Name of the tool to be shown on the tab in the right side panel. | mandatory |
| frontend:extensionPoint | The type of extension point (where in the CMS will the extension be shown). For a page tool it must be: channel.page.tools | mandatory |
| frontend:initialHeightInPixels | This property is not used for page tools. | optional |
| frontend:url |
The URL on which the tool is served. It will be the value for the src parameter of the iframe. If the URL starts with 'http://' or 'https://' the value will be used as-is. All other URLs will be regarded as paths to a tool running on the same origin as the CMS. It's recommended to host extensions on a different origin than the CMS itself. The main advantages are security (extensions cannot interfere with the CMS UI or access the user session) and deployment (extensions can be updated independently of the CMS). |
mandatory |
The default configuration bootstraps a security domain for these configuration nodes at the path /hippo:configuration/hippo:domains/ui-extensions. This allows users in the everybody group to read these nodes.
All page tools that are configured are available in all channels.