<portal-core/> tags | HCL Digital Experience
The <portal-core/> tags are used to provide portal core functionality such as entering the main render flow as well as URL-related aspects of the page.
The following table provides a brief description of each tag.
Tag | Description |
---|---|
<portal-core:cacheProxyUrl/> | Creates a URL to the caching proxy servlet. Note: This tag is deprecated for HCL Digital Experience Portal 8.0. |
<portal-core:constants/> | Makes the <%= wpsBaseURL %> and <%= wpsDocURL %> constants available to the page. |
<portal-core:defineObjects/> | Defines a set of objects which can be used later
on (for example, escapeXmlWriter ). |
<portal-core:init-lazy-set/> | This tag initializes the lazy set functionality and is required to be called in the outer most JSP. For example in your theme it would be the default.jsp. It must not be placed in a dynamic content spot JSP. |
<portal-core:lazy-set/> | This tag evaluate the given EL expression unless
it has been cached already with the current request and stores
a variable in the request scope with the given name (var). Attributes:
For example:
|
<portal-core:pageRender/> | Used in the Home screen to render the content of the selected page. Do not confuse this with the <portal-core:pageRender/> tag deprecated in V4.2. |
<portal-core:screenRender/> | Starts the rendering of the screen. This tag should be used only in theme JSPs. |
<portal-core:stateBase/> | Stores a base URL which can be used instead of full, newly-coded URLs on each occurrence of a
URL in the markup. This tag should occur only in the header section of
the markup, which is provided by theme JSPs. Attributes:
|
Detailed descriptions of the <portal-core/> JSP tags
The following section provides detailed descriptions of the <portal-core/> JSP tags:
- Creates a URL to the caching proxy servlet. The URL created is
fully cacheable and includes information about the requesting
client. The CC/PP client profile is used for gathering information
about the client for the URL. The purpose of this tag is to
link .CSS files into the JSP. The tag has one attribute.Note: For security reasons, the cache proxy servlet will only serve URLs pointing to resources located in the themes, skins, and screens directories. This makes all resources underneath these directories public. Also, any URLs containing the ".." characters will not be served.
Attributes
- forwardurl
- Specifies the address to the file you want to be sent to the caching proxy servlet. This attribute can be set by passing in a String or a URL object.
The following code example uses this tag to link a CSS file in a JSP:
<link href="<portal-core:cacheProxyUrl forwardurl="<portal-logic:urlFindInTheme type="css" file="styles.jsp"/>"/>">
- Makes the following constants available to the page:
- <%= wpsBaseURL %>
Provides the context path of the portal site as specified during installation, for example,
/wps
- <%= wpsDocURL %> Provides the URL to the product documentation located in the HCL DX Portal Web application directory, including the Javadoc information, and portal help. The URL returned includes the locale of the client, for example,
/wps/doc/locale/
. For example, the following code would generate a URL to the portal help:<%= wpsDocURL %>/help/index.html
- <%= wpsBaseURL %>
- Defines a set of objects which can be used later (for example,
escapeXmlWriter
). Makes the following constants available to the page:- <%= escapeXmlWriter %> This writer can be used to stream out URLs. The writer makes sure that the URL is written out in XML compliant representation:
<portal-navigation:urlGeneration contentNode="wps.Links" portletMode="view"> <c:set var="title"><portal-fmt:text bundle="nls.bundle" key="link" /></c:set> <a href="<% wpsURL.write(escapeXmlWriter); %>"><c-rt:out value='${title}' escapeXml='true' /></a> </portal-navigation:urlGeneration>
- <%= escapeXmlWriter %>
- Used in the Home screen to render the content of the selected page. Do not confuse this with the <portal-core:pageRender/> tag deprecated in V4.2. This tag renders the portal page without the navigation. When this tag is called, all pages that are available for the user are determined.
- Renders the current screen. Types of screens include Home (default), Login, and Error. This tag
can only be used once in the portal. This tag should be used only in theme
JSPs.
Example:
This part of theDefault.jsp
portlets.<div id="FLYParent"> <%@ include file="./banner.jspf" %> <portal-logic:if portletSolo="no"> <%@ include file="./topNav.jspf" %> <%@ include file="./sideNav.jspf" %> <portal-logic:if/> <a name="wpsMainContent"> <%-- Call the portal engine command to render the portlets for this page --%> <div id="mainContent"><portal-core:screenRender/></div> <portal-logic:if portletSolo="no"> <%@ include file="./footer.jspf" %> <%@ include file="./flyout.jspf" %> </portal-logic:if> <portal-logic:if loggedIn="yes"> </div>
- Stores a base URL which can be used instead of full, newly-coded URLs on each
occurrence of a URL in the markup. This enables shorter URLs and can improve the page serving
performance. This tag should occur only in the header section of the markup - it is not allowed to
occur outside of the header section. Theme JSPs are responsible for the header section, using
Head.jsp
by default.