Home >	Contents >	Index >

Template Tags TOC   |    Alpha TOC   |    Tag Family TOC   |    Purpose TOC   |    Annotated TOC   |    Index

render:getpageurl

Creates a URL for an asset, processing the arguments passed to it from the calling element into a URL-encoded string and returning it in a variable.

Syntax

<render:getpageurl
      outstr="theURLVariable"
      pagename="SiteCatalogPageEntry" 
      [cid="Asset ID]" 
      [c="AssetType"]
      [p="Id of parent page asset"]
      [addsession="true/false"]
      [dynamic="true/false"]
      [deptype="exists|none"]
      [wrapperpage="name of uncached wrapper page"]
      [packedargs="stringFromPACKARGStag"]
      [assembler="uri assembler shortform"]
>
      [<render:argument name="xxx" value="y"/>]
</render:getpageurl>

Parameters

outstr (required)

Input. Name of the variable that stores the URL generated by this tag.

pagename (required)

Input. Page name from a SiteCatalog entry.

cid (optional)

Input. ID of the asset that the URL represents. required if c and cid are required parameters by the SiteCatalog entry.

c (optional)

Input. Type of the asset. This parameter is optional, but if c (asset type) is not supplied, rendermode is set to export, and assets of this type have a Filename field, then the file name that the Export to Disk publishing method creates for the asset does not include the information from the Filename field of the asset. We strongly recommend that you supply a value for c.

p (optional)

Input. ID of the parent page.

addsession (optional)

Input. Whether or not to include session IDs in the URL when a browser is set to reject cookies. true means to encode session IDs in the URL. If this parameter is not specified, it is set to true by default.

dynamic (optional)

Input. Whether to create a static or a dynamic URL for the asset when the page is being rendered by the Export to Disk publishing method. true means to create a dynamic URL even if rendermode is set to export. false means to create a static URL if rendermode is set to export. If this parameter is not specified, it is set to false by default.

deptype (optional)

Input. This attribute specifies whether approval dependency is exists , or none.

Legal values are:

• exists (default) -- Exists specifies that any version of the asset satisfies the dependency condition.
• none -- None specifies no approval dependency on the asset.

wrapperpage (optional)

Input. If the target uses an uncached wrapper page, supply this argument with the name of that SiteCatalog page.

packedargs (optional)

Input. Previously created URL-encoded packed arguments, in standard form; that is, the output of a previous render:packargs tag.

assembler (optional)

Short form name for uri assembler class. Specifying an assembler overrides the default assembler used by Content Server to construct URLs. Omitting this value will cause URLs generated by this tag to use the assembler registered with an index of 0 in the request property file.

 

render:argument (optional)

Input. Name/value pairs to be passed in and included in the URL.

Description

This tag creates URLs for assets that are not blobs.

If rendermode is set to export,the tag creates a static URL (that is, a file name for an HTML file) and returns it as a variable. It creates the URL based on the standard CS-Direct page criteria variables c, cid, and p, a page name from a SiteCatalog entry, and other parameters that are described in the following section.

If rendermode is set to live, the tag creates a dynamic URL by concatenating and encoding the following:

• Name of the server (which is the same server as the one serving the page that is requesting the URL).

• Approot (application root) of the application server software, which it obtains from the ft.approot property in the futuretense.ini file.

• CGI path, which it obtains from the ft.cgipath property in the futuretense.ini file. For example, for WebLogic this path is /servlet/ and for iAS6, this path is /NASapp/cs/.

• String ContentServer?pagename=

• Name from a SiteCatalog entry, passed in as a parameter that is described in the following section.

• Information passed in with parameters for the the standard CS-Direct page criteria variables, c, cid, and p, that are also described in the following section.

Based on this information, the tag creates a URL for the asset and returns it to the element that requested it in the variable specified by the outstr parameter. The requesting element can then use the variable to create a hyperlink for the asset.

Note You use render:getpageurl to create URLs for CS-Direct assets. You cannot use it to create links to other Web sites or HTML files that are created outside of the Export publishing process.

errno

None.

Example

This code creates a URL for an article asset and stores it in a variable named "theURL":

<render:getpageurl pagename="BurlingtonFinancial/Article/Full"    cid='<%=ics.GetVar("asset.id")%>' c="Article" outstr="theURL"/>
<a href='<%=ics.GetVar("theURL")%>'>
	<ics:getvar name='asset:name'/>
</a>

This code creates a link to a page displaying a CO_Content asset using a wrapper page:

<render:getpageurl pagename="CO/CO_Container"  
	cid='<%=ics.GetVar("cid")%>' 
	c="CO_Content" 
	wrapperpage="CO_WrapperPage" 
	outstr="theURL"/>
<a href='<%=ics.GetVar("theURL")%>'>
	<ics:getvar name='asset:name'/>
</a>

See Also

render:packargs
render:getbloburl

		Home >	Contents >	Index >
	FatWire JSP Tag Reference Copyright 2005 by FatWire Software All rights reserved.