The satellite.properties file is created on each WebCenter Sites system because each WebCenter Sites system runs a Satellite servlet. When the Satellite servlet is running in the same virtual machine as the ContentServer servlet, it is said to be "co-resident." Otherwise, it is remote.
satellite.properties is on each server that hosts a Satellite Server application. The function of satellite.properties is to configure the Satellite servlet that it controls.
Properties in the satellite.properties file are organized by function on the following tabs in the Property Editor:
The Caching tab holds the Satellite Server cache settings.
The file_size property can significantly influence performance. To optimize performance, try to maximize the amount of memory caching. However, be sure that you do not exceed the host's memory capacity.
If you have lots of memory or a relatively small web site, Oracle recommends caching everything to memory by setting a large value. However, in calculating whether your entire web site can fit in memory, remember that expired web pages stay in memory until explicitly removed or until the cache cleaning thread removes them. Be sure to consider this fact when you set the value of the cache_check_interval property.
Table 15-1 Properties in satellite.properties: Caching Tab
| Property | Description |
|---|---|
|
Deprecated. Applies to only legacy page caching. This property controls the frequency of the cache cleaner thread. Expired objects are not pruned from cache when they expire. They are pruned either when they are requested and found invalid, or when a cache cleaner thread explicitly prunes them. In minutes, specify the pause between executions of the cache cleaner thread. |
|
|
Applies to only legacy page caching. This property specifies the location of disk based cache data. If this property is left blank, cached data will be stored in the context's Default value: blank |
|
|
Applies to only legacy page caching. This property specifies the maximum number of objects to maintain in the cache. Objects are removed from the cache if the size specified is exceeded; an LRU method is used to manage cache size limits. |
|
|
Applies to inCache page caching and legacy page caching. This property specifies expiration information (in the form of a The expiration information for an object can be specified in the Note that the outermost wrapper page of any request cannot specify an override, so this property is the only place where it can be controlled. Default value: This means that everything in the Satellite Server cache expires every day at 5:00 a.m. The format is as follows:
Possible values:
Other possible values:
|
|
|
Applies to legacy page caching. This property specifies the size (in kilobytes) of objects that can be cached to disk. Smaller objects are retained in memory. This value should be adjusted for system RAM, disk speed, and so on. Default value: |
The Configuration tab holds the properties that configure the Satellite servlet.
Table 15-2 Properties in satellite.properties: Configuration Tab
| Property | Description |
|---|---|
|
Deprecated. Specifies the number of seconds a request will wait when another thread is in the process of requesting the same data from the host. Waiting helps reduce load on the host server when the cache is empty at the expense of individual user response time. Default value: A value of -1 means wait until the previous thread returns. A value of 0 means never wait. This value must be tuned based on the host performance, average request size, and network latency. It is safe to use a large number or -1. |
|
|
Specifies the password that the Satellite engine will require for special functions like engine restart or cache reset. Be sure to change the username and password from the defaults. |
|
|
Deprecated. Specifies the socket read timeout in seconds, after which a read terminates with an error. A value of 0 leaves the timeout to the Java runtime environment. A value of 3 sets a 3-second wait time. Default value: |
|
|
A regular expression denoting content types that may contain nested components such as pagelets, links to other WebCenter Sites pages, or links to blobs. Pages whose content types match this pattern will be parsed by Satellite Server. |
|
|
Specifies the URL pattern used to identify the Satellite Server servlet. Satellite Server will rewrite links and forms to use this URL pattern if pages are properly designed. Default value: |
|
|
Specifies the username that the Satellite engine will require for special functions like engine restart or cache reset. Be sure to change the username and password from the defaults. |
The Remote Host tab holds properties that define the communications rules between Satellite Server and WebCenter Sites. These properties are documented here in alphabetical order:
Table 15-3 Properties in satellite.properties: Remote Host Tab
| Property | Description |
|---|---|
|
This value is the servlet path for the Blob Server servlet. It is used to tell Satellite Server where to go to resolve Typical values include |
|
|
The name of the remote host system running WebCenter Sites that the Satellite engine is caching requests for. This is required and there is no default. |
|
|
The port number for communicating with the WebCenter Sites host. Default value: |
|
|
The communication protocol between the Satellite Server host and the WebCenter Sites host. (Generally Note that setting the protocol to |
|
|
This value is the servlet path for the WebCenter Sites servlet. It is used to tell Satellite Server where to go to resolve Typical values include |
The Sessions tab holds properties that provide information about how the Satellite servlet should interpret a user's browser session.
Table 15-4 Properties in satellite.properties: Sessions Tab
| Property | Description |
|---|---|
|
Replaces the Applies to installations in which Satellite Server and WebCenter Sites are running in the same web application and must therefore share the user's session. This property specifies the path to the WebCenter Sites installation, enabling Satellite Server to access WebCenter Sites resources, such as the system asset root and the Possible values:
|
|
|
Satellite Server maintains a session between itself and the remote host on behalf of the client. Satellite Server needs to know the name of the session ID cookie the application server uses so that it can be properly tracked. Enter the possible session cookie name prefixes here, separated by a semicolon. If left blank, a default set will be used. |
|
|
Replaced with: |
|
|
Users can now specify the prefix that is prepended to the session id cookie. The session id cookie is the session id cookie for the host (i.e., WebCenter Sites). Satellite Server needs to pass the session id cookie to the client in order to maintain a session between WebCenter Sites and the client. The cookie must be renamed, so it does not conflict with the session cookie that Satellite Server itself uses. The configurable prefix allows users who know the name of the session id cookie to construct the full cookie name. This can be used in a servlet filter or other mechanism to support custom functionality. |
|
|
Specifies whether the ContentServer servlet and the Satellite servlet share the user session. If Satellite Server is running remotely, set this to If this property is not set appropriately, user-specific information may be inconsistent between pages. |
Table 15-5 Properties in satellite.properties: Compatibility Tab
| Property | Description |
|---|---|
|
The Satellite servlet converts WebCenter Sites URLs that you GET or POST to into Satellite URLs. This property specifies which string to replace in the WebCenter Sites URL to create a Satellite URL. This value is case sensitive. Effective in Satellite Server 6, use the new |
|
|
Specifies the replacement string in URLs to be GET'ed or POST'ed to the locally mapped servlet. This value is case sensitive. Effective in Satellite Server 6, use the new |
|
|
If this property is set to Effective in Satellite Server 6, use Default value: |
Table 15-6 Properties in satellite.properties: User Defined Tab
| Property | Description |
|---|---|
|
Deprecated. Value: |
|
|
Deprecated. Value: |
|
|
Used to enable the propagation of pages among nodes that are enabled for inCache page caching. Information about inCache can be found in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide. |
|
|
Specifies the frequency, in minutes, of the event that runs to clean up files in the The default location of the Default value: |