Portal topology schema
The portal topology descriptor distinguishes the console module from other
portlet applications by providing additional information about the portlets
in the application. Whereas the portlet.xml provides a unique identifier for
each portlet, it's fully-qualified class name, and supported modes, the portal
topology descriptor describes a console module in a generic sense, including
a list of component portlets, the page layout, and navigation information.
Portlets in the application can be packaged in the WAR file or already deployed
from another archive. The only mapping between the descriptors is a reference
from the portal application's <resource-link/> element, using the portlet
application ID and portlet name from the portlet descriptor.
Figure 1. References from the portal topology
descriptor to the portlet descriptor
Description of the top level topology elements
Only the following elements, along with those described in Application definition elements, are supported for this release.
- <ibm-portal-topology/>
-
- Required. the root element of the portal topology descriptor. The content of this tag is one or more <application-definition/> tags and, optionally, either an <about-page/> or a <PAA-ref/> element.
- <application-definition/>
-
- At least one is required. This element describes an application with its component portlets, page layout, and portal navigation structure. See Application definition elements.
- <about-page/>
-
- Optional. The about page is provided by the lead application for a product and provides a description of the product and other resources for support. This content is specified using the unique name of the layout element in the application definition that contains the about page content. At runtime, the about page is accessed from the main welcome page of the console. Providing the <about-page/> element also causes the console module to appear in the View selection list of the navigation.
In the following example from the page layout sample, about page refers to a layout element with the unique name com.ibm.isclite.pagelayout.layoutElement.F.
<about-page>com.ibm.isclite.pagelayout.layoutElement.F</about-page>
The layout element provided in this sample includes a portlet with the about page content.
- Optional. The about page is provided by the lead application for a product and provides a description of the product and other resources for support. This content is specified using the unique name of the layout element in the application definition that contains the about page content. At runtime, the about page is accessed from the main welcome page of the console. Providing the <about-page/> element also causes the console module to appear in the View selection list of the navigation.
- <PAA-ref/>
-
- Optional. This element references the appID of the lead application for the product. The appID name should be unique in the install. This element is intended for subcomponents of an application that spans multiple archives.
Sub-topics
Application definition elements
Organizing the navigation tree
Console module elements - guidelines for unique identifiers