Parameters Used by Remote MPX Cache Agent

CatchupCheckInterval

Integer; number of seconds. The default is 300.

The interval in which a remote MPX Cache Agent will check to see if any of its cache sources require catch-up because the Message Broker connection was lost. When catch-up is required, catch-up cycles continue to be performed until normal Message Broker connectivity has been resumed.

Minimum value is 1.

ContentSource

Each ContentSource group specifies a StarTeam Server configuration that the Remote MPX Cache Agent will monitor for new file content via MPX messages. Optionally, this group specifies an "upstream" MPX Cache Agent that will be contacted for catch-up and forwarding requests. A Remote MPX Cache Agent can have one or more ContentSource groups.

It can contain the following parameters:

ServerGUID

This value must be specified within each ContentSource group. It must be the GUID of the StarTeam Server that this remote MPX Cache Agent will track.

It is used to establish the publish/subscribe “subjects” used to monitor new file content. If the GUID is specified incorrectly, the MPX Cache Agent will not receive new file content.

To locate the GUID for a specific server configuration:

  1. From the Server Administration tool, select the server.
  2. Click the Properties icon on the toolbar or click Server > Server Properties. These actions display the Properties dialog box.
  3. Copy the GUID from the server configuration’s Properties dialog box and paste it into the .xml file.
Projects

If specified, this group value indicates that not all content for the corresponding StarTeam Server is to be tracked. Instead, only content for each Project parameter within the Projects group will be tracked and stored. It contains one or more Project parameters.

Project

Each Project parameter specifies one project name or name pattern. All files checked into a project whose name matches the specified name or pattern are cached by the MPX Cache Agent. A pattern is a name that contains one or more asterisk (*) wildcard characters.

For caching purposes, each file revision "belongs" to the project it is checked in to. In practice, a file could be shared among multiple projects and a given check-in may cause the corresponding file revision to appear in multiple projects. Because the file content is "broadcast" with the project name it was checked into, only Remote MPX Cache Agents tracking that project will store the file. For example, suppose a file is shared between projects P1 and P2, and a new revision of the file is checked into project P1. Only Remote MPX Cache Agents tracking project P1 store the new file revision. A Remote MPX Cache Agent tracking only project P2 will not receive the broadcast. However, "pull through" caching, explained more below, allows the Remote MPX Cache Agent that is tracking only project P2 to obtain the file revision anyway.

When a Remote MPX Cache Agent is configured to track specific projects, it still accepts requests for any file. If a requested file is not in its local cache, a Remote MPX Cache Agent forwards the request to the appropriate Root MPX Cache Agent and stores it locally for future requests, regardless of which projects the file belongs to. In other words, tracking-by-project limits files visible to Remote MPX Cache Agents by "push" caching, but it does not limit the files a Remote MPX Cache Agent can store via "pull through" (request forwarding) caching.

UpstreamCache

This group specifies that an upstream MPX Cache Agent will be contacted for catch-up and forwarding requests for content related to the corresponding StarTeam Server. The upstream MPX Cache Agent can be automatically located or explicitly configured as specified by the group’s parameters: AutoLocate, UpstreamHost, and UpstreamPort.

If a ContentSource parameter does not contain an UpstreamCache parameter, catch-up and miss forwarding will not occur for the corresponding server configuration. When used, UpstreamCache must contain either an UpstreamHost or an AutoLocate parameter. The two are mutually exclusive. UpstreamHost (along with UpstreamPort) explicitly specifies the upstream MPX Cache Agent, while AutoLocate requests polling.

AutoLocate

Indicates that the Root MPX Cache Agent for the corresponding StarTeam Server configuration is to be automatically located and used as the upstream MPX Cache Agent. Remote MPX Cache Agent to continue periodic polls for a Root MPX Cache Agent until one is found. It is an empty tag and mutually exclusive with UpstreamHost.

UpstreamHost

Explicitly identifies the host name or IP address of the upstream MPX Cache Agent to be used for content related to the corresponding StarTeam Server. This parameter is mutually exclusive with AutoLocate.

UpstreamPort

Integer. The default is 5201. The range is from 1 to 65535.

Only meaningful if UpstreamHost is specified, this parameter specifies the port number of the upstream MPX Cache Agent.

PrechargeSize

Integer. The default is MaxCatchupSize.

Specifies the maximum size of a Remote MPX Cache Agent's first catch-up operation, which is used to precharge its cache. It defaults to the MPX Cache Agent's MaxCatchupSize, but it can be specified larger or smaller than that value. If this value is zero, the Remote MPX Cache Agent does not perform an initial pre-charge operation.