Use application page as a portlet

Portlets can be defined in all applications to make data from applications available on a portal page.

Portlets can also be displayed on application pages using the "Portlet container" application element.

General information on portlets can be found here. Find out how to integrate the portlets into a portal page here.

To use a view page as a portlet, first create a view page with the application elements that display the desired data. Consider the size of the view page so that the portlet that displays it can be positioned well in terms of its dimensions.

To make a view page available for a portlet, the setting "Use as a portlet" must be enabled. You can find this in two locations in the Portal Manager in an open application in the "Applications" module:

The following conditions must be met for an application page to be used as a portlet:

  • There is no portlet container on the page.

  • The page is a view page (input pages cannot be used as a portlet).

Define the portlet in the application properties

All view pages already being used as a portlet are listed here. To use a new view page as a portlet, click on "Add portlet".

Add portlet

Select the desired view page here and click "OK" to save the setting and close the dialog again.

You will find them again in the application properties on the "Portlets" tab. Click here on "Edit portlet" if you want to change the portlet settings.

Edit portlet

The settings here cannot be selected if there is a portlet container on the page.

Use as portlet

This setting is available if the dialog was opened via the properties of a view page. If the dialog was opened via the application properties, the setting is automatically activated and is not shown in the dialog. If this setting is activated, the view page will be used as a portlet.

Description

You can provide the portlet with a description here.

Multilingual

Opens a dialog where the description can be entered in the different portal languages.

Portlet is available in other applications

With this setting, the portlet can be integrated into other applications and on portal pages.

Restrict selection of the portlet on the web by Groovy script

If this setting is active, Groovy script can be used to control the selection of the portlet in the browser.

Restrict display of the portlet on the web by Groovy script

If this setting is active, Groovy script can be used to control the display of the portlet in the browser.

Select script file

In each case, opens a dialog, where a Groovy file can be selected or generated.

Edit script

In each case, opens the script editor.

Groovy examples

Example of how to use Groovy in this area are available here.

Click on "OK" to save the settings and close the dialog.

Remove portlet

Removes the selected portlet from the list.

If a view page is defined as a portlet, you will find the portlet on all portal pages in the "Portlets in applications" area under the title of the page if you have the appropriate authorization in the browser. This button allows you to allocate the portlet so that it can be used in the browser.

Portlet container

The portlet container is an application element that allows you to display portlets on view and edit pages. As is the case with all portal pages, you will then find an arrow button on the right-hand side of the page. Click here to open the settings where you can select and arrange the portlets of your choice. Find more information about the portlet container here.