Iframe UI module

Note: This functionality requires server 5.0.2149 or later

You can add custom modules/blades to the relatude UI that contain an iframe to integrate external systems into the UI. This can be particularly useful to integrate custom edit modules created in the old Edit UI, or other third party system you have in your network.

Follow these steps:

  1. Enable custom module buttons: You can control and override all main menu buttons in the Relatude UI. In the default configuration this is not enabled and all modules are shown. So the first step is to enable custom menu buttons. Open the system panel, then "installation" and scroll down to "UI Menu Items". Click the "Add default menu items" button to add all default modules. Click refresh



Then click "add new" to add a new menu item. Set the following values on this new item:



Plug In Key: [Empty], "Native" is default when empty. You can specify custom plugins

Module Key: [Empty], Not needed in this case as "iframe" item key is unique across all modules

Item Key: "iframe", this is the name of blade component

Param JSON: {

  "url": "edit/?module=blog",
  "margin": false,
  "wafSession": true


Change the "url" param to match the module you want the blade to show. The "wafSession" flag will ensure the current user session is transferred to the iframe content.

Title: Here you can override the title of the menu item.

IconSVG: Here you can specify the icon used for the menu item. You can specify either an icon name like "mono.user", or "mono.phone", or the full SVG of a new icon. A list of available icons can be found in the system module.

Once you have set the values, save and refresh the whole browser to reload the menu and the new button should appear in the main menu. To change its location you can reorder the menu items by editing the installation object. ( System module )