Configure a Document Field Extension

Overview

This page explains how to configure an Open UI document field extension in Bloomreach Content.

When to Use

Configure a document field extension when you need to integrate a custom UI component into a document type in the CMS using Open UI.

Prerequisites

  • Access to the JCR repository.

  • Appropriate permissions to modify configuration nodes.

  • The extension you want to configure is available and accessible by URL.

Configuration Steps

To configure a document field extension, create a node of type frontend:uiExtension under /hippo:configuration/hippo:frontend/cms/ui-extensions. The node name must contain only alphanumeric characters.

You can configure multiple extensions by creating multiple nodes.

Supported Properties

The following table describes the properties you can set on a document field extension configuration node:

PropertyDescriptionRemarks
frontend:configString containing configuration values for the extension. For example, you can provide an API key required by the extension. The interpretation of this string depends on the extension implementation.

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

For example, if you set this property to:

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

and define backend.url=https://api.example.com in the container configuration, the property will resolve to:

{ "my.backend.api.url": "https://api.example.com/" } at runtime. | optional | | frontend:displayName | Not used for document extensions. | optional | | frontend:extensionPoint | Specifies where the extension appears in the CMS. For document field extensions, set this to document.field. | mandatory | | frontend:initialHeightInPixels | Sets the initial height of the iframe in pixels. Defaults to 150 if omitted. | optional | | frontend:url | The URL where the extension 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 values are treated as paths on the same origin as the CMS.

Recommendation: Host extensions on a different origin than the CMS for improved security and 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 |

Add the Extension to a Document Type

You can use any configured document field extension in Open UI String fields within any document type.

To add the extension:

  1. Open the document type editor.

  2. Add a field of type "Open UI String".

  3. In the field properties, set the "ui.extension" property to the name of your extension configuration node.

  4. Configure other field options as needed (caption, hint, multiple, required, etc.).

Verification

  • After configuration, verify that the extension appears in the document editor as expected.

  • Confirm that the iframe loads the correct URL and that any configuration values are passed correctly.

Share Feedback
Page: /frontend/open-ui-extensions/configure-a-document-field-extension
Section: Frontend
Category *