Configure Pre-rendering: WCM v5.1

Configure WCM Pre-rendering

+
Search Tips | Advanced Search

Overview

Pre-rendering can be enabled as the default module or as a standalone module.

Enable Pre-rendering as the Default Module

Use this option when accessing the Pre-rendered Site via Web Content Management. This will improve performance as static content is accessed from the pre-rendered Site, but dynamic content will still be rendered via WCM.
To enable users to access the pre-rendered site via the WCM application, the "default" module in connect.cfg must be changed from...
<Default class=com.aptrix.pluto.renderer.RendererModule remoteAccess=true autoLoad=false />

...to...
<Default class=com.aptrix.cacher.CacherModule remoteAccess=true autoLoad=false />

Local Rendering Portlet (Web Content Viewer)

You cannot use the Local Rendering Portlet (Web Content Viewer) when Pre-rendering is set as the default module.

Enable Pre-rendering as a Standalone Module

This option is used when you are using WCM to generate a Pre-rendered Site, but are not using WCM to view the Pre-rendered Site. use a HTTP Server to view the Pre-rendered Site.
Ensure the following code is entered within the Cacher sub-section of the Module section of connect.cfg
<Cacher class=com.aptrix.cacher.CacherModule remoteAccess=true autoLoad=false />

Ensure the "Cacher" element in the Dependent Modules section of connect.cfg is uncommented.
Ensure the following code is entered within the ModuleConfig section of connect.cfg

<DestDir value="[ILWWCM_HOME]/ilwwcm/cacher" /> Base directory under which each site cache will be created. There will be one subdirectory created for each Site.
Important: If the Prerenderer is run with the OverwriteCache configuration setting set to "true", any files in the DestDir path that were not written in the last run of the Prerenderer will be deleted. For this reason, ensure that the DestDir path is only used for storing rendered content and that it does not contain any other data that cannot be recreated.
<TempDir value="[ILWWCM_HOME]/ilwwcm/cacher/temp" /> The temporary DestDir that is required to build the site cache prior to moving the data over to the DestDir.
<Delay value="1" /> Set the time, in seconds, between requesting a page while caching.
<BusyDelay value="5" /> Set the time, in seconds, of the "BusyDelay" setting. This is used if executing within the BusyStart to BusyEnd period. (See below.) Otherwise the "Delay" setting is used.
<BusyStart value="9:00 am" />
<BusyEnd value="5:00 pm" />
These settings determine the times between which the "BusyDelay" setting will be used. (See above.) Enter an absolute time as shown.
<Password value="password" /> When manually Pre-rendering a Site via a URL request you will be asked for a password. This password is set here. It is recommended that the default password of "password" be changed to something more secure.
<OverWriteCache value="true" />

True:

The Prerenderer will overwrite files in the DestDir cache directory (then delete unneeded files). This results in a progressive change in Site content as seen by the user.

False:

The Prerenderer renames the TempDir to the DestDir to achieve an instant update to a new version of the pre-rendered site.
Note: False should not be used if a HTTP Server is used to display the pre-rendered data as some HTTP Servers "lock" the data directories.

<RendererUser value="Anonymous" /> Determines the user to be used to render the WCM content. Either type "anonymous" or "administrator" or a specific Member Manager user or group name.
The site is pre-rendered based on this User's security rights. If the user specified here does not have access to a particular component it will not be pre-rendered.
<CacherUrl value="http://[HOST]:[PORT]/wps/wcm/connect/" /> The full URL to the CacherModule.
<ServletPath value="/connect" /> The Servlet Path to the Web Content Management servlet not including the "context path".
<DefaultContentName value="index.html" /> This sets the name of the default or "home" file of the Site used when accessing the Pre-rendered Site. This normally would be "index.html".
<Sites value="Site1,Site2" /> The Sites within a WCM environment to cache are entered here, separated by commas.
<Interval>
<Recurrence value="10" />
<StartDelay value="10" />
</Interval>
The CacherModule can be set to run after a recurring number of minutes.

Recurrence:

The recurring period in minutes for a recurring task.

StartDelay:

The delay in minutes prior to starting the first recurring task.

<Scheduled>
<Times value="10:00am,12:00am,1:00pm" />
</Scheduled>
Alternately, the CacherModule can be set to run a certain times. Enter a series of absolute times as shown, separated by commas.

Parent topic: Pre-rendered Sites.
IBM Workplace WCM - V5.1.0.1 -

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.

<DestDir value="[ILWWCM_HOME]/ilwwcm/cacher" />	Base directory under which each site cache will be created. There will be one subdirectory created for each Site.
Important: If the Prerenderer is run with the OverwriteCache configuration setting set to "true", any files in the DestDir path that were not written in the last run of the Prerenderer will be deleted. For this reason, ensure that the DestDir path is only used for storing rendered content and that it does not contain any other data that cannot be recreated.
<TempDir value="[ILWWCM_HOME]/ilwwcm/cacher/temp" />	The temporary DestDir that is required to build the site cache prior to moving the data over to the DestDir.
<Delay value="1" />	Set the time, in seconds, between requesting a page while caching.
<BusyDelay value="5" />	Set the time, in seconds, of the "BusyDelay" setting. This is used if executing within the BusyStart to BusyEnd period. (See below.) Otherwise the "Delay" setting is used.
<BusyStart value="9:00 am" /> <BusyEnd value="5:00 pm" />	These settings determine the times between which the "BusyDelay" setting will be used. (See above.) Enter an absolute time as shown.
<Password value="password" />	When manually Pre-rendering a Site via a URL request you will be asked for a password. This password is set here. It is recommended that the default password of "password" be changed to something more secure.
<OverWriteCache value="true" />	True: The Prerenderer will overwrite files in the DestDir cache directory (then delete unneeded files). This results in a progressive change in Site content as seen by the user. False: The Prerenderer renames the TempDir to the DestDir to achieve an instant update to a new version of the pre-rendered site. Note: False should not be used if a HTTP Server is used to display the pre-rendered data as some HTTP Servers "lock" the data directories.
<RendererUser value="Anonymous" />	Determines the user to be used to render the WCM content. Either type "anonymous" or "administrator" or a specific Member Manager user or group name. The site is pre-rendered based on this User's security rights. If the user specified here does not have access to a particular component it will not be pre-rendered.
<CacherUrl value="http://[HOST]:[PORT]/wps/wcm/connect/" />	The full URL to the CacherModule.
<ServletPath value="/connect" />	The Servlet Path to the Web Content Management servlet not including the "context path".
<DefaultContentName value="index.html" />	This sets the name of the default or "home" file of the Site used when accessing the Pre-rendered Site. This normally would be "index.html".
<Sites value="Site1,Site2" />	The Sites within a WCM environment to cache are entered here, separated by commas.
<Interval> <Recurrence value="10" /> <StartDelay value="10" /> </Interval>	The CacherModule can be set to run after a recurring number of minutes. Recurrence: The recurring period in minutes for a recurring task. StartDelay: The delay in minutes prior to starting the first recurring task.
<Scheduled> <Times value="10:00am,12:00am,1:00pm" /> </Scheduled>	Alternately, the CacherModule can be set to run a certain times. Enter a series of absolute times as shown, separated by commas.