Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

satellite.page

Gets a pagelet and specifies its cache expiration.

Syntax

<satellite.page pagename="pagelet_name"
               [cachecontrol="expiration_date_and_time"]
               [name1="value1"]
               ...
               [nameN="valueN"]/>

Parameters

pagename (required)

Specify the name of a pagelet.

cachecontrol (optional)

Deprecated. In order to specify when the pagelet will expire, specify a value for the sscacheinfo column in the SiteCatalog. While this value still functions in this version, its use can lead to inconsistent results. This attribute controls when this pagelet expires from the cache. If this attribute is left blank, the default expiration information will be retrieved from the sscacheinfo column in the SiteCatalog. You can override the default expiration value by specifying one of the following:

• never -- tells CS-Satellite that this pagelet should never expire for time reasons. Such objects are not guaranteed to stay in the cache forever. For example, if the cache is full, CS-Satellite still removes pagelets on a LRU (Least Recently Used) basis.
• immediate -- tells CS-Satellite to expire this pagelet immediately; in other words, to not cache this page.
• expiration_date_and_time -- tells CS-Satellite the precise date(s) and time(s) this pagelet should expire.
• session:expiration_date_and_time -- tells CS-Satellite the precise date(s) and time(s) this pagelet should expire. Placing the word session in front of the expiration date and time tells CS-Satellite to serve this pagelet only to the current session. Typically, you specify session:expiration_date_and_time when the pagelet contains personalized data.

name (optional)

Specify zero or more name/value pairs to be passed to the page, just as you pass arguments to the CONTENTSERVER tag. The arguments must be specified as page criteria in the resargs columns of the sitecatalog so that the system can differentiate cached pages properly. Any attribute passed in must be specified as PageCriteria in the sitecatalog or the page does not get cached properly. Pagename and cachecontrol do not need to be specified as page criteria.

errno

The possible values of errno include:

Value	Description
-30	Page not found.
-106	Bad parameters.
-406	Bad XML parameter.

Description

satellite.page inserts a pagelet using the specified parameters. If the specified pagelet is already cached on this CS-Satellite, satellite.page requests the page from Content Server, then loads it. If the specified pagelet is not already cached on this CS-Satellite, satellite.page caches it and loads it. Scoping for the satellite.page tag is set to STACKED. Cookies must be enabled for the satellite.page tag to function properly.

Example

The following tag identifies a pagelet named Experiment/CarOffer that expires yearly at 2:30 p. m. on July 31.

<satellite.page 
  pagename="Experiment/CarOffer"/>

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