Metadata Iframe field

The application will render the selected web URL into an iframe object. The uuid and propertyGroup will be passed in the URL as query parameters.

AttributeDescriptionRequired
label

The text shown as a label in the user interface.

true

name

Unique field identifier.

Two metadata fields can't have the same name. Name must be unique.

The name must start with "okp:".

It's a good practice to use a metadata group name as a basis for the metadata field name. For example, use "okg:consulting" as the group name; the field name "okp:consulting.iframe" is formed by changing "okg" to "okp". That helps to find the metadata group based on metadata field name.

Please use only letters, numbers and underscores: "0-9a-zA-Z_".

 

true

url

Set the URL of the web page to be loaded in the iframe.

Two parameters are set on the request:

  • uuid (the node of the currently selected object in the user interface).
  • propertyGroup (the name of the metadata group).

If your URL value is http://www.openkm.com, the URL called in the iframe will be http://www.openkm.com?uuid=03ced012-63cc-4feb-ac26-bb12ded86f73&propertyGroup=okg:consulting

It's good practice for the URL to start with http:// or https://.

true

width

The width of the HTML element. It is advisable to set the width attribute to 100% so that it is adjusted to the screen.

false.

height

The height of the HTML element.

false.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
                                 "http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <iframe label="Iframe label"  name="okp:consulting.iframe" url="http://localhost:8080/openkm" width="100%" height="300px"/>
  </property-group>
</property-groups>
 
Table of contents [ Hide Show ]