ExternalWeb component

An ExternalWeb component embeds an external web page in a Web App. An ExternalWeb component is created with the <ExternalWebComponent> element.

If the host of the web page prohibits embedding, for example, by including an appropriate HTTP response header, that web page cannot be embedded in a Web App.
Note that embedded websites may store and use cookies on the end device.

The following attributes can be defined for the <ExternalWebComponent> element:

Attribute	Description
`displayName`	Display name of the component in the menu. Translatable Data Binding possible Possible values: Any string
`path`	Required. Unique URL of the component, visible in the browser address bar. Possible values: String of alphanumeric characters (no umlauts, dots, etc.)
`allowForms`	Allows embedded content to submit forms. Possible values: `true` `false` (default)
`allowModals`	Allows embedded content to display modal dialogs. Possible values: `true` `false` (default)
`allowPointerLock`	Allows embedded content to interpret mouse movements directly as an input method. Possible values: `true` `false` (default)
`allowPopups`	Allows embedded content to open a web page in a new window or tab. Possible values: `true` `false` (default)
`allowSameOrigin`	Allows embedded content to share memory if the origin of the embedded content is the same as the origin of the host web application. Possible values: `true` `false` (default)
`allowScripts`	Allows embedded content to execute JavaScript. Possible values: `true` `false` (default)
`allowTopNavigation`	Allows embedded content to open a web page in the same window or tab. Possible values: `true` `false` (default)
`process`	Repository path to a Technical Process Possible values: Any path in the X4 repository without leading slash (e.g. `Project/Folder/Process.wrf`)
`url`	Uniform Resource Locator (URL) with any valid protocol (`http://`, `https://`, etc.) Possible values: Any valid URL (e.g. `https://www.softproject.de/`)
`name`	Unique name that references the component. Possible values: Any string
`default`	Determines whether the view on a component is selected as default. Possible values: `true` / `false` (maximum one component may have the attribute `default="true"`)
`showInMenu`	Determines whether the external web component is visible in the navigation bar. Possible values: `true` / `false`

Input

If the parameter process is set, an XML file with the URL as input is expected in the following structure:

XML

<?xml version="1.0" encoding="UTF-8"?>
<Ok
	url="URL"/>

Example

URL in ExternalWeb

The following example in the .wad creates an ExternalWeb component:

XML

<ExternalWebComponent 
	path="ExternalWebUrl"
	displayName="SoftProject Website"
	url="https://www.softproject.de" />

URL via Technical Process

The following example in the .wad creates an ExternalWeb component:

XML

<ExternalWebComponent 
	path="ExternalWebUrl"
	displayName="SoftProject Website"
	process="provideURL.wrf" />

The provideURL.wrf Technical Process returns the following output, which sets the URL:

XML

<?xml version="1.0" encoding="UTF-8"?>
<Ok
	url="https://www.softproject.de"/>