IBM Support

ID08: WebSphere Message Broker - Enterprise Exception Handling Pattern



This SupportPac provides a pattern and tools to centralize exception reporting throughout the organization for analysis, troubleshooting and data rectification.

Download Description

The Enterprise Exception Handling pattern is to provide a universally accepted method of reporting exceptions in the organization that may be analyzed. Application and system exceptions are reported in a non-standard manner throughout the organization and often reported in logs that are distributed across every node in the subsystem. Hence, the pattern addresses the standardization and centralization of system-wide exceptions.

The pattern looks into the following concepts for the realization of the process:
• Standardization of the Exception format
• Exception reporting through the ESB
• Integration with the Monitoring System
• Centralization and Statistical Analysis of Exceptions
• Testing Exceptions Conditions

This Category 01 SupportPac is an IBM Services Asset for WebSphere Software and may be freely downloaded under the license agreement. Please visit the IBM Software Services Zone for WebSphere website for detailed information on services offerings and to contact a services representative.

Engage IBM to provide knowledge and expertise on the Enterprise Exception Handling (EEH) framework for your organization:
• EEH Workshop
• EEH Strategy and Planning
• EEH Implementation
• EEH Extensibility

Possible Uses
Centralised exception handling and standardisation thereof for the entire organization and analysis of exceptions.

New in this Release
• Core EEH improvements.
• More Samples added.
• Eclipse-based EEH Database Editor.
• Ajax-based Web Analyzer.

More details on all the new features are listed below:

What’s new in Enterprise Exception Handling Pattern version 1.0.0:
• Message expiry and the expired queue can be set for the Exception Catalog.
• A description for the Exception Catalog is added to the schema.
• Exception Catalog may be property file based where XML parsing is an issue.
• Database table prefix may be provided (schema, catalog, etc.) to prefix table names.
• Centralized logging.
• Static linking of exception catalog using getExcCatInfo() generated from excutil.
• Static loading of exception catalogs using EEH_SETUP environment variable.
• EEH debug mode may be set from the environment variable , EEH_DEBUG.
• Catalog registration with the EEH installation provides centralized management.
• Catalog setup options added – setupRegisteredCatalogs(), setupCatalogs().
• AppId = "*" may be set in the Exception Catalog when used by multiple applications.
• setAppId() API added for individual applications to set their id.
• FileNotifier plugin sample added for exchd INotifier plug-in.
• EEH Editor, an eclipse-based plug-in is provider for configuration, administration and analysis and re-queuing of exception data.
• EEH Web Analyzer provides functionality to browse exceptions in the database and re-queuing of exception data.

Skill Level Required
• Basic WebSphere MQ knowledge
• Basic Database knowledge

Author: Arunava Majumdar (Chicago), Vineet Gupta (Gurgaon, India)
Category: 1 (raised from category 2 November 2011)
Released: 23Jun09
Last updated: 01May12 (as Category 1)
Current SupportPac Version: 1.0.0
»Please note that the version number shown in the right-hand pane is the version of the WebSphere MQ or WebSphere MB product that this SupportPac applies to. The date is the last webpage refresh.

To view the complete portfolio of WebSphere MQ SupportPacs please visit the WebSphere MQ SupportPacs homepage.


• IBM WebSphere MQ 7.0+
• Java 1.5 +
• JDBC 4 Complient Database (Derby, DB2 9.7, Solid DB 6.5)
• Eclipse base 3.2.2+
• IBM WebSphere Message Broker 6.1+ (optional)

[{"PRLabel":"WebSphere Services ","PRLang":"US English","PRSize":"1","PRPlat":{"label":"AIX","code":"PF002"},"PRURL":""},{"PRLabel":"Enterprise Exception Handling: Ideas and Features","PRLang":"US English","PRSize":"1","PRPlat":{"label":"AIX","code":"PF002"},"PRURL":""},{"PRLabel":"Enterprise Exception Handling: Technical Discussions","PRLang":"US English","PRSize":"1","PRPlat":{"label":"Linux","code":"PF016"},"PRURL":""}]

Installation Instructions

Unzip to any directory and set the EEH_PATH environment variable to the directory. Make sure that the following WMQ 7.0 Java libraries are in the CLASSPATH:


The Web Analyzer is packaged as EEH.war in the web directory.
The EEH Editor is packaged as an eclipse site in the eclipse site directory.

For more details on installation procedures please refer to the EEH – Getting Started Guide.pdf

[{"INLabel":"Getting Started Guide","INLang":"US English","INSize":"2115150","INURL":""},{"INLabel":"Implementation Guide","INLang":"US English","INSize":"3600300","INURL":""}]
[{"DNLabel":"","DNDate":"01 May 2012","DNLang":"US English","DNSize":"27387952","DNPlat":{"label":"HP-UX","code":"PF010"},"DNURL":"","DNURL_FTP":" ","DDURL":null}]

Technical Support

Category 01 Services Asset freely distributable binaries are provided in good faith and AS-IS. There is no warranty or further service implied or committed and any supplied binary or samples are not supported via IBM product service channels.

You may submit a question and return email address using the 'rate this page' below, but a response is not guaranteed.

Please read the license information contained within the zip file of this SupportPac to determine if you want to use it.

If you wish to arrange a IBM Services engagement (Category 01 SupportPac) a separate contract will be created when you contact the Software Services Sales Specialists. Please visit the WebSphere Services website for more information on Services Offerings to facilitate deployment of assets.

[{"Product":{"code":"SSKM8N","label":"WebSphere Message Broker"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"SupportPac","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF035","label":"z\/OS"}],"Version":"8.0;7.0;6.1","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}},{"Product":{"code":"SSFKSJ","label":"WebSphere MQ"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":null,"Platform":[{"code":"","label":""}],"Version":"7.0","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
15 June 2018