Home >	Contents >	Index >
Template Tag 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"]
      [DEPTYPE="exists|none"]
      [WRAPPERPAGE="name of uncached wrapper page"]
      [PACKEDARGS="stringFromPACKARGStag"]
      [EXPORT ="true/false"]
     [ASSEMBLER="uri assembler shortform"]
     [ARGS_xxx="Y"]>
</RENDER.GETPAGEURL>

Parameters

OUTSTR (required)

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

PAGENAME (required)

Input. A page name from a SiteCatalog entry. The page name can be referred to by a specific name or it can be determined through some combination of the four standard CS-Direct page criteria variables (c, cid, ct, and p). For example: PAGENAME="BurlingtonFinancial/Article/Variables.ct"

cid (optional)

Input. ID of the asset that the URL is for.

c (optional)

Input. Type of the asset. This parameter is optional but if c (asset type) is not supplied, and 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. In other words, it is highly recommended that you supply a value for c.

p (optional)

Input. ID of the parent page.

ADDSESSION (optional)

Input. Whether to include session IDs in the URL when a browser is set to reject cookies. true means to encode session IDs in the URL. false means not to. The default value is true.

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. DYNAMIC="true" means to create a dynamic URL even if rendermode is set to export. DYNAMIC="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.

ARGS_ (optional)

Input. Name/value pairs to be passed in and included in the URL, with the string ARGS_ as the prefix for the variable name.

EXPORT (optional)

Specifies whether or not the URL reference is exported. The default value is false.

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.

 

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, which are described in the following section.

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

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

• The approot of the application server software, which it obtains from the ft.approot property in the futuretense.ini file.

• The 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/.

• The string ContentServer?pagename=

• A page name from a SiteCatalog entry, passed in as a parameter (described in the following section).

• Information passed in with parameters for the the standard CS-Direct page criteria variables, c, cid, and p, (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 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 creates an link to a page displaying that article:

<RENDER.GETPAGEURL PAGENAME="BurlingtonFinancial/Article/Full"  cid="Variables.cid" c="Article" OUTSTR="theURL"/>
<a href="Variables.theURL" REPLACEALL="Variables.theURL"><STRING.STREAM VARIABLE="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="Variables.cid" c="CO_Content" WRAPPERPAGE="CO_WrapperPage" OUTSTR="theURL"/>
<a href="Variables.theURL" REPLACEALL="Variables.theURL"><STRING.STREAM VARIABLE="asset:name"/></A>

See Also

RENDER.PACKARGS
RENDER.GETBLOBURL

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