OpenWGA 7.9 - TMLScript reference

TMLPortlet "portlet"
Method :

registerPortletForName(name [, moduledb] , module [, overwrite])

On object TMLPortlet "portlet"
Usage Registers a new portlet or changes the registry of an existing portlet
Description This method either registers a new child portlet for the current portlet (if the given name is not yet registered) or it updates the registration of the existing child portlet of the given name (if the overwrite parameter is specified as true). The update effectively can be used to change the layout module of the portlet.

The new or updated portlet configuration is automatically stored in the personalisation profile. So there is no need to manually trigger storage unless you do further modifications on the returned portlet object.
Parameters name (String):
Name by which the portlet is registered. May consist of alphanumeric characters, dots, underlines and colons.

moduledb (String, optional):
Database key of the application that hosts the WebTML module to use for portlet layout. Omit to use the current WebTML design application.

module (String):
Name of the WebTML module to use for portlet layout.

overwrite (Boolean, optional):
Controls if an already existing portlet registration may be overwritten. If false (the default) an error is thrown when the given name is already registered.
Allowed in script types
  • WebTML pages and normal WebTML actions