clearAlert

The clear alert request causes the Transaction Server to change the status of alerts from open to cleared.

The request contains the criteria to use to determine which alerts are cleared on behalf of the requester. When no alerts match the criteria, a message indicating that no alerts were cleared for this request is logged.

The following table shows the fields that are needed to create a clear alert request.
Table 1. clearAlert Request
Field Description
Message Type The message type text for this message. The strings that can be used for the message type are:
  • AppBridgeConstants.MSGTYPE_CLEAR_ALERT
  • clearAlert
Using the string that is defined in the AppBridgeConstants interface is the preferred method for setting the message type.
Unit of Work The unit of work identifier and the type that was used when the alert was opened.
Payload An instance of ClearAlertBean that contains the information about which alerts are to be cleared. For a description of the bean, see clearAlertBean.

clearAlertBean

The ClearAlertBean message payload contains all of the information that the Transaction Server needs to clear alerts for the requester. The fully qualified class name for the bean is com.ibm.paydir.ima.txacc.app.bridge.ClearAlertBean.

The contents of the bean can be set by using its constructor or the methods that are shown in the following table.

Table 2. clearAlertBean Methods
Method name Takes data type Description
setProductName String The product name that was used when the alert was opened.
setProductType ProductType The value for the product type that was used when the alert was opened. This bean does not require that the product type be specified.

The product type is not supported by the logMessage API and should not be used to find alerts that are created by logMessage.

For more information about the product type values, see the following table.
setMessageId String The message identifier that was used when the alert was opened.
setClearedBy String The name of the user, or the module, that is requesting that the status of the alert be set to cleared.
setNote String An optional explanation for why this alert is being cleared. It can be up to 1024 characters long.

The values to use for the product type are defined in the ProductType class. The fully qualified class name for the class is com.ibm.ftm.base.util.constants.UsageConstants.ProductType.

The product type values are described in the following table.
Table 3. Values to use for the product type
Value Description
ADAPTER A resource adapter module that is deployed as part of a J2EE application.
ENGINE A runtime processing engine that is deployed as a J2EE application.
EXTERNAL An external application that is using the logMessage API.
MANAGER A manager controls the data that is used by related engines.
MODULE A user interface module.
NA No product type applies.
SERVER A runtime processing engine that is deployed as a stand-alone server.
TASK A Services Framework task.
UI A user interface that is deployed as a web module.
UI_MODULE A user interface that is deployed as a user interface module.
UIEJB A user interface processing engine that is deployed as a J2EE application.
UTILITY A utility application, such as terminate and exit.
WS_MODULE A runtime processing engine that is deployed as a web service module.

For more information about the classes that are used by the clear alert request, refer to the Javadoc information in Transaction Server.