Configure SiteEntry

27 Configure SiteEntry

The SiteEntry screen is used to specify caching and pagelet parameters for the page to be rendered by this Template asset.

When the Template asset is saved, field values that you specify in the SiteEntry screen are written to the SiteCatalog table, as indicated in the procedures below.

In the SiteEntry screen, fill in the fields as explained in the steps below:

In the Cache Criteria field:
1. WebCenter Sites names the following reserved variables as Cache Criteria:
```
c,cid,context,p,rendermode,site,sitepfx,ft_ss
```
  Note:
  Configure SiteEntry
  The reserved Cache Criteria variables should not be removed.
2. If you have to include your own variables as Cache Criteria (for example, foo), add them to the existing list. For example:
```
c,cid,context,foo,p,rendermode,site,sitepfx,ft_ss
```
  Note:
  
  The Cache Criteria field names the variables which, in conjunction with SiteCatalog Pagename, define a pagelet as being unique. The variables are used to identify cached pages, which means that the variables are used in the page's cache key.
  
  Only those variables that are specified as Cache Criteria are used by the caching system to create the cache key for cached pages. Therefore, if your site design requires you to use page-level variables in addition to the reserved variables, be sure to designate them as Cache Criteria variables, as shown in this step.
If you have to enable the Extra Parameters section in CKEditor, complete these steps:
1. Move the "Extra Parameters" that were added to the Cache Criteria of the Template to the "Legal Arguments" section of the Template.
2. When moving the parameters to the Legal Arguments section, it is no longer necessary to prefix the parameters with fp:, just use the parameter name.
  
  For example, instead of using fp:imageHeight, just use imageHeight.
3. These parameters are then available in the included template, and can be retrieved in standard ways, such as using <ics:getvar name="imageHeight"/>.
The Extra Parameters section provides a way of passing custom parameters, such as image dimensions, to the template. These extra parameters will be available in the Include asset link and Add asset link dialog boxes. The parameter names (imageHeight and imageWidth in our example) will be displayed in CKEditor's Extra Parameters section, as options in the Name menu. The Value field enables the user to specify a value for the chosen parameter.

When the Template asset is saved, the Cache Criteria variables are written to the pagecriteria column in the SiteCatalog table.
The Access Control Lists field corresponds to the acl column in the SiteCatalog table. To allow only certain visitors to request this page, select the ACLs that the visitors must have to see the page.
The Rootelement field is pre-populated.
The Cache Rules field corresponds to the cscacheinfo and sscacheinfo columns in the SiteCatalog table. Do one of the following:
- Select Cached if the pagelet to be rendered by this template's element must be cached. The pagelet is set to be cached forever. The cache will be flushed by CacheManager's active cache management logic. This option sets both WebCenter Sites and Satellite Server caching conditions.
- Select Uncached to turn off caching for the pagelet to be rendered by this template's element. This option sets both WebCenter Sites and Satellite Server caching conditions.
- Select Advanced to set caching rules individually for WebCenter Sites and Satellite Server. Selecting Advanced displays two additional fields: one for WebCenter Sites caching and one for Satellite Server caching.
Note:

CacheManager is designed to manage the lifecycle for cached pages on both WebCenter Sites and Satellite Server. It is designed to operate with pages that are set to be cached forever. If the cache expires on WebCenter Sites before it expires on Satellite Server, CacheManager will fail to flush the cache properly and invalid pages may be served from cache. Only advanced users should configure these settings manually.
SiteCatalog Pagename field. Do not change the value of this field. This field is pre-populated with the name of the page entry.
In the Pagelet parameters section, you can enter pagelet parameters (name-value pairs), which will be passed into the template each time it is executed. The Pagelet parameters section supports a total of 510 characters.
Note:

The Pagelet parameters section is pre-populated with the following default pagelet parameters, including their values:
```
site, sitepfx, rendermode
```
The default parameter values will be overwritten if they are explicitly specified when the template is called.
- If you are specifying a pagelet parameter in this step, make sure to list its name as a Cache Criteria variable.
- If you named your own Cache Criteria variables, the variables are listed in the Page parameters section. If you do not specify values for these parameters, WebCenter Sites ignores the parameters.
When the Template asset is saved, the name-value pairs that are specified as Pagelet parameters are written to either the resargs1 or resargs2 column of the SiteCatalog table. The column to which they are written is not important and is managed automatically. (Each column supports up to 255 characters.)
Click Continue to open the Thumbnails screen.
Click Continue to open the Map screen.

Note:

You will return to the Thumbnail screen after you have completed creating the Template asset and saved the Template asset.