Expression language beans for accessing programming models

Expression language (EL) beans are used to access some HCL Digital Experience (DX) programming models. These beans are accessed through the PortalBean (wp). The beans allow you to use HCL DX models and associated classes.

PortalBean

The PortalBean provides access to EL beans that represent some of the HCL Portal models. You can use these models to access resource information in your JSPs.

You can access following items using the PortalBean. Append the following bean names to wp. to create a bean in your JSP. For example, wp.themeList.current gets the current theme and returns a Theme bean representing it.

• wp.ac
  Provides read access to the current access control permissions for a resource.

  • AccessControl
    Provides read access to the current access control node for a resource.

• wp.analyticsTagList
  Attaches marketing information to Portal resources such as portal pages, portlets, or web content items. Reads the analytics tags that are associated with an identifiable portal resource.

  • AnalyticsTag
    Represents a single analytics tag.

• wp.clientProfile
  Provides access to the client profile.

• wp.identification
  Provides access to the identification services serialize and deserialize.

• wp.languageList
  Provides access to the list of languages that are defined in portal.

  • Language
    Provides access to the interface that represents a portal language.

• wp.layoutModel
  Provides access to the tree model representation of the layout of a page.

  • LayoutModel
    Provides access to the tree model representation object of the layout of a page.

    • LayoutControl
      Provides access to the interface that represents a control in a LayoutModel.

    • LayoutContainer
      Provides access to the interface that represents a container in a LayoutModel.

• wp.localizedDescription
  Provides access to the description of the currently rendered page. This bean returns the Description for the current page description and is never null. For example:

  ${wp.localizedDescription}
  

• wp.localizedTitle
  Provides access to the title of the currently rendered page. This bean returns the Title for the current page title and is never null. For example:

  ${wp.localizedTitle}
  

• wp.metadata
  Provides access to the aggregated metadata of a node. The metadata that can be provided by individual nodes of the content model are combined according to the hierarchy that the content model exposes for these nodes. Values set on the node itself take precedence over values set for its parents. This bean returns Metadata and is never null. For example:

  ${wp.metadata[wp.selectionModel.selected]['com.ibm.portal.layout.template.ref']}
  

• wp.moduleList
  Accesses modules that are part of the modularized theme architecture. You can query individual modules and their attributes and identify the currently used modules within the scope of the currently selected and rendered page and theme.

  • Module
    Represents one individual module.

  • CurrentModuleList
    Represents the list of modules within the scope of the current request, which is the currently selected page and theme. This module iterates through all modules, locates individual modules, and queries their capabilities. This is especially useful for portlet developers to check whether certain capabilities are available on the page or not.

    • ModuleCapabilitiesList
      Represents the aggregated capabilities of a list of modules. This is usually the non-deferred or deferred capabilities of the currently selected page and depends on how this object was fetched. It is useful for portlet developers to check whether certain capabilities are available on the page or not.

      • ModuleCapability
        Represents one capability as defined by a module.

• wp.navigationModel
  Provides access to the navigation model.

  • NavigationNode
    Provides access to a navigation node in a navigation model.

    • ContentNode
      Provides access to a content node. This interface offers a way to obtain the type of the content node.

• wp.publicRenderParam
  Allows portlets to share context information. They are addressed with qualified names. This expression bean can be used within a theme or theme module to read the first String value of a public render parameter.

• wp.publicRenderParamValues
  Reads the values of a public render parameter within a theme or theme module. This parameter is read in the context of the currently selected page that is determined internally.

• wp.rep
  Provides access to the set of configuration entries for the specified resource environment provider.

  • Properties
    Represents a set of properties made available as part of the resource environment provider.

• wp.selectionModel
  Provides access to a selection model for a navigation model.

  • NavigationNode
    Provides access to a navigation node in a navigation model.

    • ContentNode
      Provides access to a content node. This interface offers a way to obtain the type of the content node.

• wp.themeConfig
  Encapsulates the theme configuration parameter lookup process.

• wp.themeList
  Provides access to all themes in the system and the currently selected theme.

  • Theme
    Provides access to the attributes of one theme.

    • ProfileList
      Provides access to all profiles in a theme and the currently selected profile.

      • Profile
        Provides access to the attributes of one profile.

• wp.title
  Provides access to the title of the currently rendered page or the title information set by a portlet. This bean returns the Title in the current locale as a string. For example:

  ${wp.title}
  

• wp.user
  Provides access to the active user.

Common beans

• Common beans
  The following beans are returned by many different beans and are used flexibly.

  • Description
    Provides access to the description of certain objects such as Navigation, Content, Theme, Profile, and others.

  • Metadata
    Provides access to the metadata of certain objects such as Navigation, Content, Theme, Profile, and others.

  • Title
    Provides access to the title of certain objects such as Navigation, Content, Theme, Profile, and others.

• UrlGeneration
  Creates a portal URL you can control with attributes.

  • UrlGenerationPage
    Extends UrlGeneration on a page. All the UrlGeneration attributes are available in addition to these attributes.

  • UrlGenerationPortlet
    Extends UrlGeneration in a portlet. All the UrlGeneration and UrlGenerationPage attributes are available in addition to these attributes.

Other beans

These beans cannot be accessed through the PortalBean. To access the uiNavigationModel Bean, you must use the uiNavigationModel tag and define the variable name that you want the bean to be available under.

• uiNavigationModel
  Lists the visible pages by default as part of its iterator. When the Show hidden pages option is selected in the toolbar, it also lists the hidden pages. There is a mobile hidden flag for pages. The model also helps you specify a mobile test device class expression, which is used to evaluate if the system is rendered as part of a mobile request.

  • uiNavigationNode
    Provides access to a navigation node in a navigation model.