Superagent Exception Handling

Document ID : KB000055587
Last Modified Date : 14/02/2018
Show Technical Document Details

Superagent Exception Handling in eTrust Admin 8.1 SP1 CR8 and Higher CRs

Summary:

The purpose of this document is to describe the steps required to enable use of Superagent Exception Handling in eTrust Admin 8.1 SP1 CR8 and higher CRs.

eTrust Admin Superagent can be configured to catch exceptions thrown by the connector and then try to continue. This is the new default behavior. To disable this new behavior additional procedures are required. This section describes the conceptual overview of eTrust Admin Superagent Exception Handling.

WARNING: It's possible that the exception will cause data corruption that can cause the SuperAgent or some other agent plug-in to fail at a later time.

Pre-requisites:

The following pre-requisites must be completed prior to configuring eTrust Admin Superagent Exception Handling.

  1. Must have installed eTrust Admin 8.1 SP1 CR8 or a higher SP1 CR.

Procedure:

Configuring the Superagent Exception Handling

By default the Superagent will catch the exception, log it, and try to continue. The customer can set a configuration parameter in %ETAHOME%\Data\eta_connector.conf on the Superagent machine to control the behavior. This information can be added below the section that already exists in eta_connector.conf for configuring the Superagent logging. Simply uncomment the desired choice (shown here with CatchConnectExceptions enabled). The Superagent service must be restarted for the change to take effect.

# Control Superagent Exception Handling

#

# Don't catch exceptions

# CatchConnectorExceptions 0

#

#

# Default Behavior: Catch exceptions, log it, and try to continue

CatchConnectorExceptions 2

The possible behaviors supported for managing these exceptions are detailed in the following table.

Key Value Action
CatchConnectorExceptions 0Do not catch agent plug-in exception
CatchConnectorExceptions1Catch an agent plug-in exception, log the problem identifying the offending agent plug-in and begin graceful shutdown procedures.
CatchConnectorExceptions2Catch an agent plug-in exception; log the problem identifying the offending agent plug-in. However, the SuperAgent will continue to run. Default.

WARNING: It's possible that the exception will cause data corruption that can cause the SuperAgent or some other agent plug-in to fail at a later time.

Troubleshooting Superagent Exceptions

The log message generated in the etatrans log (and displayed in the Admin Manager) has the following format:

<Operation>: Plug-in exception: dn=<DN>

Example:

Modify: Plug-in exception: dn=eTSDKAccountName=sdkacct1,eTSDKAccountContainerName=...

The DN identifies the plug-in and the object being processed since the DN contains the specific RDN type. The operation identifies the operation as Add, Modify, Delete, etc.