Previous Topic: Policy Engine Hub Registry ValuesNext Topic: Policy Engines Subkey


Policy Engine Hub Key

The Policy Engine Hub registry key contains the following registry values:

EventLoggingLevel

Type: REG_DWORD

Data: Defaults to 2. This determines the level of logging for message processing. For example, you can configure the hub to only log errors or warning system messages.

Log entries are written to the wgnphub_<date>.log file, where <date> is the date and time when the log file was created; the file location is set by the LogFilePath registry value. The supported logging levels are:

1 - Errors only

2 - Errors and warnings

3 - Errors and warnings, plus informational and status messages

Note: Setting EventLoggingLevel=3 will cause the log file to grow extremely rapidly. This level of logging is provided for testing purposes only.

EventRetryAttempts

Type: REG_DWORD

Data: Defaults to 4. Determines how many times the hub attempts to pass an email to a policy engine before it is flagged as an ‘email failure’ and passed back to the Exchange or Domino server agent.

This only applies to email failures caused by a problem with the policy engine (such as a host machine crash) or with the email itself (that is, some unexpected condition that prevents the policy engine from analyzing the email).

It does not apply to email failures resulting from the time-out GlobalEventTimeoutSeconds expiring or because the HighWaterMarkEventCount or HighWaterMarkMB thresholds have been exceeded.

How the email server agent handles ‘email failures’ depends on its EMailFailureMode registry value.

Note: For Import Policy jobs, we recommend a value of 0, to stop the policy engine retrying failed events.

GlobalEventTimeoutSeconds

Type: REG_DWORD

Data: Defaults to 300. A time-out (in seconds) that specifies how long an email can stay in the event queue on the hub or policy engine before it is flagged as an ‘email failure’ and passed back to the source component (typically the Exchange server agent or, for Import Policy jobs, Event Import).

How the Exchange server agent handles ‘email failures’ depends on its EMailFailureMode registry value (see link above). For Event Import, the handling of import failures depends on the type of import operation.

Note: If Import Policy is installed, the default for this value changes to 21,600 seconds (6 hours), so that events are less likely to timeout.

HighWaterMarkMB

Type: REG_DWORD

Data: Defaults to 400. The maximum amount of memory (in MB) that can be allocated to the various hub event queues. If any queue lengthens and causes the allocated memory to rise above this maximum level, the hub temporarily suspends normal operations until the queue shortens (see LowWaterMarkMB).

While normal operations are suspended, the hub’s behavior depends on the HubFailureMode registry value. Either the hub delays new emails from the email server agent, or it returns them to the server agent as ‘email failures’.

How the server agent handles ‘email failures’ depends on its EMailFailureMode registry value (see link above).

Note: Note the following:

HighWaterMarkEventCount

Type: REG_DWORD

Data: Defaults to 400. The maximum total number of events that can be allocated to the various hub event queues.

If any queue lengthens and causes the event count to rise above this maximum level, the hub temporarily suspends normal operations until the queue shortens (see LowWaterMarkEventCount below).

While normal operations are suspended, the hub’s behavior depends on the HubFailureMode. Either the hub delays new emails from the Exchange or Domino server agent, or it returns them to the server agent as ‘email failures’ (whose handling is dependent on the EMailFailureMode; see link above)

Note: Note the following:

LogFilePath

Type: REG_SZ

Data: Defaults to empty. This specifies the folder you want to write log files to. The PE domain user must have write access to the specified folder.

If the path is not defined, the log file is saved in the default location.

In the current CA DataMinder release, log files are typically saved in CA's \data\log subfolder. On 32-bit machines, find this subfolder in the Windows All Users profile. On 64-bit machines, find this subfolder below the \ProgramData folder.

LogMaxNumFiles

Type: REG_DWORD

Data: Defaults to 10. This specifies the maximum number of log files. When the maximum number of log files exists and the maximum size of the latest is reached (see below), the oldest log file is deleted to enable a new one to be created.

LogMaxSizeBytes

Type: REG_SZ

Data: Defaults to 1,000,000. This specifies the maximum size (in bytes) for each log file. When the current log file reaches its maximum size, the policy engine hub creates a new log file. Log entries are written to a wgnphub_<date>.log file—for details see EventLoggingLevel above.

LowWaterMarkMB

Type: REG_DWORD

Data: Defaults to 200. The total amount of memory allocated to the various hub queues (in MB) that triggers a resumption in hub operations.

If normal hub operations are suspended because the HighWaterMarkMB has been exceeded (see above), they only resume when the queues shorten and allocated memory falls back below the LowWaterMarkMB amount.

Note: For Import Policy jobs, we recommend a low value (for example, 20 MB) to ensure a steady stream of events.

LowWaterMarkEventCount

Type: REG_DWORD

Data: Defaults to 300. The total number of events allocated to the various hub queues that triggers a resumption in hub operations.

If normal hub operations are suspended because the HighWaterMarkEventCount has been exceeded (see above), they only resume when the queues shorten and the event count falls back below the LowWaterMarkEventCount amount.

Note: For Import Policy jobs, we recommend a low value (for example, 20) to ensure a steady stream of events.

NoPEFailTimeoutSeconds

Type: REG_DWORD

Data: Defaults to 60. This specifies how long (in seconds) the hub waits after it detects there is no active policy engine available for a specific queue before it times out events in that queue (that is, flags them as email failures).

When this timeout expires, all events in the queue are immediately flagged as email failures. This overrides the GlobalEventTimeoutSeconds (see above).

How the Exchange or Domino server agent handles ‘email failures’ depends on the EMailFailureMode; see link above)

Note: We recommend that you do not change the default timeout of 60 seconds.

OperationalLoggingLevel

Type: REG_DWORD

Data: Defaults to 3. This determines the level of logging for hub operations. For example, typical log entries cover hub installation, creating or deleting queues, the failure or suspension of policy engines, and so on.

Log entries are written to the wgnphub_<date>.log file, where <date> is the date and time when the log file was created; file name and location details and supported logging levels are the same as for EventLoggingLevel (see above).

PECallTimeoutMilliseconds

Type: REG_DWORD

Data: Defaults to 10000. A time-out (in milliseconds) that specifies how long the hub will wait to connect to a policy engine for configuration purposes before it cancels the call and assumes that the policy engine is currently unavailable.

(More information:

Email Server Agent Registry Values

Import Failures

Uninstall Policy Engine Hubs