Creating a URL tag | HCL Digital Experience

The URLCmpnt tag is used to generate a URL to a site area or content item.

About this task

Format for URLCmpnt tag:

[URLCmpnt mode=" " context=" " type=" " name=" " pageDesign=" " portalTarget=" "
targetCurrentPortalPage=" " usedIn=" " start=" " end=" " htmlencode=" "]

Procedure

To create a URLCmpnt tag, complete these steps:

Click Insert a Tag from a presentation template or element design field. The Tag Helper dialog opens.
Select URL as the tag type.

Select a mode type. This parameter determines the type of URL that is generated. This parameter is added to the tag as the mode=" " parameter:

Table 1. Modes
Mode	Details
`mode="portal"`	This parameter generates a URL to a portal page. This parameter is used when you display web content within a web content viewer portlet
`mode="standAlone"`	This parameter generates a URL to a web page. This parameter is used when you display web content using the Web Content Manager servlet.
`mode="current"`	This parameter generates a URL based on the format of the current request. For example, if the current request is a HCL Portal request, then `mode="portal"` is used.
`mode="static"`	This parameter generates a POC URL that will render as portal URL for portal pages, and as a standard URL for a servlet site.

Select the item type and the context that is used to determine which URL to reference:

Table 2. Context and item type matrix
Context and Item Type	`type="auto"`	`type="content"`	`type="sitearea"`	`type="parent"`	`type="top"`
`context="Selected"` If selected, the context is set by the selected item. You select an item by clicking Select. This parameter is added to the tag as the name=" " parameter:	This parameter displays the URL of the selected item.	This parameter displays the URL of the selected content item. If a site area is selected, then nothing is displayed.	If the selected item is a site area, then this parameter displays the URL of the site area If the selected item is a content item, then this parameter displays the URL of the parent site area of the content item.	This parameter displays the URL of the parent of the selected item.	This parameter displays the URL of the first item in the path of the selected item.
`context="Current"` If selected, the context is set by the current item.	This parameter displays the URL of the item currently being rendered.	This parameter displays the URL of the current content item. If a site area is selected, then nothing is displayed.	If the item currently being rendered is a site area, this parameter displays the URL of the current site area. If the item currently being rendered is a content item, this parameter displays the URL of the parent site area of the content item.	This parameter displays the URL of the parent site area of the item currently being rendered.	This parameter displays the URL of the first item in the path of the item currently being rendered.
`context="Autofill"` Use this option when the item that is referenced is determined by the search parameters of a menu, navigator, or taxonomy component. If the tag is not used within a menu, navigator, or taxonomy component, the context reverts to the current item.	This parameter displays the URL of the item that is returned by a menu, navigator, or taxonomy component.	This parameter displays the URL of a content item that is returned by a menu, navigator, or taxonomy component. If a site area is selected, then nothing is displayed.	If the current item returned by a menu, navigator, or taxonomy component is a site area, then the URL of the site area is displayed. If the current item returned by a menu, navigator, or taxonomy component is a content item, then the URL of the parent of the content item is displayed.	This parameter displays the URL of the parent item of the item that is returned by a menu, navigator, or taxonomy component.	This parameter displays the URL of the first item in the path of the item that is returned by a menu, navigator, or taxonomy component.
`context="portalContext"` If selected, the context is set by the context of the current page. This option is only valid for content that is delivered by using a web content viewer portlet.	This parameter displays the URL of the current page context item.	If the context of the current page is a content item, the URL of the current content item is displayed. If the context of the current page is a site area, the URL of the default content item of the site area is displayed.	If the context of the current page is a site area, the URL of the site area is displayed. If the context of the current page is a content item, the URL of the parent of the content item is displayed.	This parameter displays the URL of the parent of the current page context item.	This parameter displays the URL of the first item in the path of the current page context item.
`context="portalMapping"` If selected, the context is set by the content mapping of the current page. This option is only valid for content that is delivered by using a web content viewer portlet.	This parameter displays the URL of the item that is selected as the default content mapping of the page.	This parameter displays the URL of the default content item of the site area that is selected as the default content mapping of the page.	This parameter displays the URL of the site area that is selected as the default content mapping of the page.	This parameter displays the URL of parent of the item that is selected as the default content mapping of the page.	This parameter displays the URL of the first item in the path of the item that is selected as the default content mapping of the page.
`context="portletContext"` If selected, the context is set by context of the current web content viewer portlet. This option is only valid for content that is delivered by using a web content viewer portlet.	This parameter displays the URL from the current portlet context item.	If the context of the current portlet is a content item, the URL from the current content item is displayed. If the context of the current portlet is a site area, the URL from the default content item of the site area is displayed.	If the context of the current portlet is a site area, the URL from the site area is displayed. If the context of the current portlet is a content item, the URL from the parent of the content item is displayed.	This parameter displays the URL from the parent of the current portlet context item.	This parameter displays the URL from the first item in the path of the current portlet context item.

If you want to render the content by using an alternative presentation template, click presentation template. This parameter is added to the tag as the pageDesign=" " parameter.
Select Portal Page Target if you want to render the content on a specific Portal page. You can enter the compound name of the URL mapping or friendly URL of the target portal page in the tag after you add the tag to your design. This parameter can be used only if mode="current" or mode="portal". This parameter is added to the tag as the portalTarget=" " parameter.
Click OK to add the tag to your navigator design.

What to do next

When you add this tag to your design, you can also add the following parameters to the tag:

Table 3. Extra tag parameters
Tag parameters	Details
`name=" "`	If you specify `name="./itemName"`, the actual path is not resolved until the item is rendered. This parameter takes slightly longer to resolve than specifying the path to the item.
`usedIn=" "`	If you want to use the URL in JavaScript, you must add the parameter `usedIn="script"` to the tag.
htmlencode=" "	If `htmlencode="true"`, the reserved HTML characters in text, short text, and option selection elements are converted into character entities. For example, `'<'` is converted to `'&lt'`. This parameter is useful if you would like to prevent users from adding malicious code, or if you want to prevent users from changing the design of their text using HTML. If not specified, the default setting specified by the `cmpnt.htmlEncodeDefault` property in the WCM WCMConfigService service is used. By default, this property is set to true.
`start=" "` `end=" "`	The start and end attributes are used to wrap the data that is returned by a tag within other tags, such as HTML. These attributes are not mandatory.
`targetCurrentPortalPage=" "`	Set `targetCurrentPortalPage="true"` if you want to render the content on the portal page that is the current page when the URL is selected. You can use this parameter only if `mode="current"` or `mode="portal"` and if the portalTarget parameter is not set.