You can use two tools in IBM WebSphere InterChange Server to locate, view,
and process failed events: Failed Event Manager, a browser-based tool
with role-based security that allows you to work with failed events from the
Web, and Flow Manager, a tool installed with the IBM WebSphere InterChange
Server product. This section contains the following:
Using Failed Event Manager
Using Flow Manager
Failed Event Manager allows you to view and manage failed events from the
Web, and works with IBM WebSphere Application Server or with Tomcat.
For information on installing Failed Event Manager to work with WebSphere
Application Server or Tomcat, refer to the WebSphere Business Integration
Server Installation Guide. Failed Event Manager works with the
following versions of WebSphere Application Server, WebSphere Application
Server, and Tomcat:
- WebSphere Application Server versions 5.0.2 or 5.1
If you selected an Administrative Toolset installation of WebSphere
Business Integration Server, Failed Event Manager is automatically installed
and configured if WebSphere Application Server or WebSphere Application Server
versions 5.0.2 or 5.1 are detected on your system.
- Tomcat versions 4.1.24 and 4.1.27.
By default, role-based security is enabled after you have installed Tomcat
with Failed Event Manager (Refer to the WebSphere Business Integration
Server Installation Guide). Default roles must be added in
Tomcat_home\conf\tomcat-users.xml
directory. Creating a user with the Administrator role allows that user
to gain full access to Failed Event Manager. For details on how to
create roles in Failed Event Manager, refer to Steps for creating custom users and roles for Failed Event Manager with Tomcat
Role-based security is available if you are using Tomcat with Failed Event
Manager. The actions you can perform with those failed events depends
on role-based security. Administrators can assign users one or more of
four default roles, and administrators have permission to create custom roles
for your specific team using Application Assembly Tool. The following
default roles are included:
- Administrator -- rights to view and resubmit failed events and to view
business object data.
- ViewAll -- rights to view events and business object data.
- ViewEvents -- rights to view events only, not business object data.
- SubmitEvents -- rights to view and resubmit events but not business object
data.
This section includes the following procedures:
Perform the following steps to manually install Failed Event Manager on
WebSphere Application Server 5.0.2. Prior to beginning
the steps below, ensure that WebSphere Application Server is running in
Administrator mode on your environment.
- With the WebSphere Application Server running, expand the Servers menu in
the left navigation frame of the Administration Console.
- Select the application server to configure under the Application
Servers link.
- Select Additional Properties > Process Definition > Java
Virtual Machine.
- In the Generic JVM Arguments dialog, enter the following
information:
-DORBNamingProvider=CosNaming -
Dorg.omg.CORBA.ORBClass=com.ibm.CORBA.iiop.ORB
- Dorg.omg.CORBA.ORBInitialPort=%ORB_PORT% -
Dorg.omg.CORBA.ORBInitialHost=%ORB_HOST%
where %ORB_PORT% & %ORB_HOST% matches the information included
in the ./bin/CWSharedEnv.bat file of the applicable
WebSphere InterChange Server.
- Select the Apply button.
- Select Additional Properties > Custom Properties >
New.
- In the Name field, enter FEM_HOME in the Name field
to designate where the log file will be stored.
- In the Value field, enter the fully-qualified path to the
installed application within the WebSphere product directory, for example,
C:\ProgramFiles\IBM\WebSphere\Express\AppServer\installedApps\DefaultNode\FailedEvents.war.ear\FailedEvents.war.
- Note:
- If the application is not installed already, either complete steps 9-20 and
come back to this step or type in the fully qualified path to a directory
where you would like the log file to be placed
- Select the Apply button.
- Select the OK button to return to the Java Virtual Machine
page.
- Select the Save button when the following message
appears:
Changes have been made to your local configuration. Click Save to
apply changes to the master configuration.
- Select the Save button again on the Master Configuration
screen.
- Select Environment > Update Web Server Plugin.
- Select the OK button on the Update web server plugin
configuration screen.
- On the Applications menu, select Install New
Application.
- Enter the fully qualified path to the FailedEvents.war
file located in the WebSphereICS\WBFEM directory.
- Enter FailedEvents in the Context Root field and select the
Next button.
- Select the Next button on the Preparing for the
application installation window to accept the default values.
- Select the Next button until you reach the end of the
installation process, and then select the Finish button.
- When you receive the Application Installed Successfully
message, select the Save to Master Configuration button.
- Select Start > Programs > IBM WebSphere Application Server
v5.0 > Stop the Server to stop the WebSphere Application
Server. Restart the server entering the following information at a
command prompt:
WAS_Product_dir\bin\startServer.bat <servername>
- To start the Failed Event Manager, open a browser window and enter the
following URL:
http://hostname:9080/FailedEvents.
- Note:
- 9080 is the default port for server1. To find specific ports for a
server, see Steps for identifying server ports.
Steps for identifying server ports
Perform the following steps to identify specific server ports for use with
the Failed Event Manager:
- With the WebSphere Application Server running, expand the Servers menu in
the left navigation frame.
- Select Application Servers.
- Select the server for which you require port information to expand the
listing.
- Select Additional Properties > WebContainer.
- Select Additional Properties > HTTP Transports. The
ports for the server display on the screen.
Perform the following steps to manually install Failed Event Manager on
Tomcat 4.1.24: Prior to beginning the steps below, ensure
that WebSphere Application Server is running in Administrator mode on your
environment.
- Under the Tomcat_home\webapps directory, create the
FailedEvents directory, where Tomcat_home is the Tomcat
installation path.
- Extract the FailedEvents.war file contents from the the
\WBFEM\Tomcat directory into the
Tomcat_home\webapps\FailedEvents directory.
- Open the setclasspath.bat file, located in
Tomcat_home\bin directory and set the JAVA_OPTS property
as follows:
set JAVA_OPTS=-DFEM_HOME=C:\Tomcat_home\webapps\FailedEvents -
DORBNamingProvider=CosNaming -
Dorg.omg.CORBA.ORBClass=com.ibm.CORBA.iiop.ORB
- Dorg.omg.CORBA.ORBInitialPort=%ORB_PORT% -
Dorg.omg.CORBA.ORBInitialHost=%ORB_HOST%
where %ORB_PORT% & %ORB_HOST% match what is in the
./bin/CWSharedEnv.bat file.
- Note:
- If Tomcat_home contains spaces, use quotes around the
FEM_HOME value.
- Start Tomcat using the following command line to ensure that
setclasspath.bat is called:
Tomcat_home/bin/startup.bat
- With the application server running, start the Failed Event Manager by
opening a browser window and entering the following URL:
http://hostname:8080/FailedEvents.
- Note:
- 8080 is the default port for the server. To change the port number,
you must edit the Tomcat_home\conf\server.xml file and
restart the application server.
The Failed Event Manager provides the ability to activate role-based
security on WebSphere Application Server and Tomcat. For more
information on the concepts and application of role-based access, see Administering role-based access control (RBAC).
Four basic roles exist for the Failed Events Manager.
- Administrator, which is the default role provided by the WebSphere
InterChange Server and grants all privileges to the user
- SubmitEvents, which grants the user the ability to view and manage, that
is, submit and delete, events. Users with this permission cannot view
business object data.
- ViewAll, which grants the user the ability to only view events and
business object data.
- ViewEvents, which grants the user the ability to only view events.
Users with this permission cannot view business object data.
The Administrator will create all but the default Administrator role,
giving each View Failed Events permission at the server level. You may
also create custom roles for use with the Failed Events Manager. For
more information, see Creating custom roles for Failed Event Manager
- Note:
- You must use the SubmitEvents role along with another custom role that has
permission to submit & delete failed events for collaborations and
connectors at the component level. The ViewAll and ViewEvents roles can
be used independently of another custom role.
Creating custom roles for Failed Event Manager
You can create custom roles in order to provide component level
access. For example, using custom roles at a component level, you can
restrict a user from viewing failed events that belong to a specific event
owner, collaboration, or connector. Create custom roles using the
Server Administration Tool in the System Manager., assigning View
Failed Events permission at the server level. When creating roles at
the component level, select the particular event owner, collaboration object
or connector object and assign both Submit Failed Events and Delete Failed
Events permission for each component.
Perform the following steps to create custom users and roles if you are
using Tomcat:
- Edit the tomat-users.xml file located under
Tomcat_Home\conf to make the following changes as needed:
- To add a new role, for example, Manager, add <role
rolename="Manager"/>.
- To create and assign a user, for example, Scott, to the role
Manager, add <user username="Scott"
password="tiger" roles="Manager"/>
- You can assign more than one role to a user by separating the roles with
commas, for example: <user username="Scott"
password="tiger" roles="Manager,
Employee"/>
- Save the file.
- Edit the web.xml file located under
Tomcat_Home\webapps\FailedEvents\WEB-INF to add the roles you added
to the tomat-users.xml file in step 1. Do the
following:
- Add the custom roles to the following xml element, which already contains
the default roles:
<auth-constraint id="AuthConstraint_1062537631424">
<description>SC1:+:</description>
<role-name>Administrator</role-name>
<role-name>ViewEvents</role-name>
<role-name>ViewAll</role-name>
<role-name>SubmitEvents</role-name>
<role-name>Manager</role-name>
</auth-constraint>
- At the end of the xml file add a new element and assign a security role id
that is unique:
<security-role id="SecurityRole_1068513225089">
<description>Can manage all events.</description>
<role-name>Manager</role-name>
</security-role>
- Edit the init param value of the Login servlet as one complete
string:
<servlet id="Servlet_1062537018298">
<servlet-name>Login</servlet-name>
<display-name>Login</display-name>
<servlet-class>
com.ibm.btools.itools.FailedEvents.servlets.Login
</servlet-class>
<init-param id="InitParam_1063835207426">
<param-name>ROLECOMPONENTS</param-name>
<param-value>
role1: event_owners
SourceToDestCollab
|role2:event_owners=Collab2*
bos=CUSTOMER2.Create#2/4
|role3:event_owners=SourceToDestCollab, Collab2
</param-value>
<description>
Roles and components (collabs or connectors) associated with these roles.
</description>
</init-param>
</servlet>
The parameter value is a string in the following format:
<RoleName1>:event_owners=<ownername>*connectors=<connectorName>
*bos=<boname.verb> #<CompositeKeyValue>+<CompositekeyValue2>/
<AnotherPossibleKeyValue> | <RoleName2>: .....
Where:
< | > - separates two roles
< : > - separates the role name from components of the
role
< * > - separates components within a role, for example,
connectors and business objects
< = > - separates the component name from its values
< , > - separates values within a component
< # >- separates business object name from its key values
< / >- separates different possible keys of a business object
< + >- separates the composite key of a business object (two or more
primary keys)
For example:
Role1:event_owners=collab1, collab2*connectors=conn1,
conn2*bos=bo1.create#55/67, bo2.delete#99/80 |
Role2:event_owners=collab3,collab4*connectors=conn3
*bos= bo4.create#59+9876/82, bo2.delete#56
In this example, "event_owners" refers to point of failure of the
event, either at the collaboration or at the connector.
- Save the file.
- Start Tomcat from the command line in order to call the
setclasspath.bat file:
Tomcat_home/bin/startup.bat.
Perform the following steps to log on to Failed Event Manager:
- Type one of the following URLs, depending on how Failed Event Manager was
set up for your team:
- If you are using WebSphere Application Server, type the URL:
http://HostName/FailedEvents
where HostName is the name of the computer on which WebSphere
Application Server is installed.
- You may have a port number as part of the URL. To access Failed
Event Manager, type the URL:
http://HostName:nnnn//FailedEvents
where HostName is the name of the computer on which WebSphere
Application Server is installed and nnnn is the port number.
- When Failed Event Manager is installed as part of WebSphere Application
Server, it is configured to use a default port number, 7089. You can
access Failed Event Manager with the following URL:
http://HostName:7089/FailedEvents.
- If you are using Failed Event Manager with Tomcat, it is configured to use
a default port number, 8080. You can access Failed Event Manager with
the following URL:
http://HostName:8080/FailedEvents.
- If security is enabled, you must type the Application Server user name and
password.
- At the Connect screen, type the Server Name, User
Name and Password, and click Login.
Figure 45. Failed Event Manager Connect screen

After you log on, the Query dialog box appears, as shown in Figure 46.
Figure 46. Failed Event Manager Query dialog box

Perform the following steps to view information about failed events in
Failed Event Manager:
- On the Query page, select the information about the failed events that you
want to view:
- Event Status: select whether you want to view events with
the status of Failed, In Transit, Possible
Duplicate, Deferred, or Any of those four status
categories.
- Point of Failure: select the component in which the
failure occurred.
- Business Object: select a name of a business
object.
- Source Connector: select a name of an adapter or other
source connector.
- Select Date: click Any Time, or click Between
and select a beginning and end date and time.
- No. of events/page: Select how may events you want
to be displayed on each page of Failed Event Manager.
- Click Submit.
A Table of Failed Events appears, as show in Figure 47.
Figure 47. Failed Event Manager Table of Failed Events

If you are not assigned to one of the roles that has access to viewing
business objects, the business object buttons may not be available in this
table, as shown in Figure 48.
Figure 48. Failed Event Manager Table of Failed Events without rights to view business objects

- If you want to view details for a particular failed event, select the
check box in the left column and click View in the
Details column.
The Event Details dialog box appears, as shown in Figure 49.
Figure 49. Failed Event Manager Event Details dialog box

- If you are assigned to a role that has access to the business object,
click the business object button in the Business Objects column to
view details about the business object. The Business Object Data dialog
box appears, as shown in Figure 50.
Figure 50. Failed Event Manager Business Object Data dialog box

Perform the following steps in a Table of Failed Events to process failed
events:
- Select the check box in the left column for the failed events that you
want to work with.
- Do one of the following:
- To send the events back to the destination application, click
Submit. This action is available if you are assigned to a
role that can submit events.
- To refresh the selected events and then send them back to the destination
application, click Refresh & Submit.This action is
available if you are assigned to a role that can submit events.
- To cancel the selected events if they are long-lived business processes,
click Cancel Waiting.
- To delete the selected events, click Delete.
Perform the following steps to check the roles you are assigned for Failed
Event Manager role-base security:
- log on to Failed Event Manager (see Steps for logging on to Failed Event Manager).
- On the query page that opens, click the Check your access
rights link in the bottom left.
A page appears listing the default roles available. You can type a
role name to see if you are assigned to that role.
To locate, view, and process failed events, use Flow Manager, a tool that
is installed with the IBM WebSphere InterChange Server product. Flow
Manager allows you to easily construct a query to locate and display
unresolved flows. After you display the unresolved flows, you can
select any flow in the display and submit it, discard it, or perform other
actions.
The following topics describe how to use Flow Manager for constructing the
queries, viewing the details, and processing the events:
Steps for starting Flow Manager
Steps for finding unresolved flows
"Steps for viewing details for unresolved flows"
Steps for processing unresolved flows
Perform the following steps to start Flow Manager:
- Click Start > Programs > IBM WebSphere Business Integration
> Toolset > Administrative > Flow Manager. The Connect
to WebSphere InterChange Server dialog box appears (see Figure 51.
Figure 51. Connect to InterChange Server dialog box

- Enter the server name, using any one of the following methods:
- Type the user name and password for the server you want to connect
to. If you check the Remember user name and password check
box, the user name and password are stored in the registry along with the
server name, and the password are encrypted. Click
Connect.
- Note:
- To remove unwanted users or servers from the registry, click Options.
This opens the Options dialog box, from which you can remove servers or
users.
The following figure shows the Options dialog box.
Figure 53. Options dialog box

After you click Connect in the Connect to WebSphere
InterChange Server dialog box, Flow Manager opens (see Figure 54).
Figure 54. Flow Manager

Perform the following steps in Flow Manager to find all unresolved
flows:
- Start Flow Manager. See Steps for starting Flow Manager.
- Do one of the following:
- If you want to locate and display all unresolved flows, accept the
defaults of Any for all the fields.
- If you want to construct a query to find specific flows, refer to the
following sections that describe the search options in each tab:
- After specifying your search criteria, click the Find button or
click Event > Find. The results appear in the bottom half
of the Flow Manager window (see Figure 55).
Figure 55. Flow Manager displaying filtered results

- To save the current filter information as a query, click Query >
Save. The query name you type appears in the Query
list.
Event Attributes tab
Click the Event Attributes tab to search according to the
characteristics of the unresolved event (see Figure 56).
Figure 56. Flow Manager Event Attributes tab

The following options are available from the Event Attributes
tab:
- Status: Select events according to their status, which
you can designate as one of the following:
- Any: Selects all unresolved events.
- Failed: Selects all unresolved events that are in the
Failed state.
- In Transit: Selects all unresolved events that are in the
In Transit state.
- Possible Duplicate: Selects all unresolved events that
are in the Possible Duplicate state.
- Deferred: Selects all unresolved events in which the
point of failure was a collaboration with a recovery mode setting of
Deferred.
- Waiting: Selects all unresolved events in which the point
of failure was a collaboration with a recovery mode setting of Waiting.
- Event Owner: Select a collaboration name or a connector
name to query for flows that failed within that collaboration or
connector. You can string together multiple selections by clicking in
the new empty field that is created below each existing selection. To
search all of your collaborations and connectors, select
Any.
- Event: For each collaboration or connector that you
select, select an event, as represented by a business object. You can
select one event, string together multiple events, or select
Any.
- Verb:
Chose the verb to query for each event.
- Source Connector
Select the source connector or connector whose flows you want to query, or
select Any.
Date & Time tab
Use the Date & Time tab to query only the flows that failed
during a specific time period (see Figure 57).
Figure 57. Date & Time tab

The following options are available from the Date & Time
tab:
- Any Time: Queries for all failed events, with no
restriction on when occurred
- Find all events: Queries for all failed events that
occurred within a specified time period:
- between (specified times)
- within (period of days)
- older than (number of days)
Error Text & Business Object Attributes tab
Use the Error Text & Business Object Attributes tab to
construct a query that includes only certain business objects, business object
attributes, and attribute values (see Figure 58).
Figure 58. Error Text & Business Object Attributes tab

Select values in the following columns:
- Business Object
- Attribute
- Operand
- Value
You can also query only unresolved flows that produce a message containing
specified text that you type in the Containing Error Text
field.
- Note:
- The keywords you type in the Containing Error Text field are not
case-sensitive.
Perform the following steps to view details for unresolved flows in Flow
Manager:
- Select a query from the Query list.
- Do one of the following:
- Click the Find button.
- Click Event > Find.
The results appear in the bottom half of the Flow Manager window (see Figure 55).
An unresolved flows table appears with a list of events and the following
information:
- Event Status
- Event Owner
- Point of Failure
- Connector
- Event
- Time
- Message
- Key Attributes
For the waiting events, the Event Status cell contains the
following information:
Waiting
[timeout expiration:...]
[scenario name:...]
[scenario node ID...]
- To access more information about any of the events, double-click the row
containing the event (or click Event > Select All). This
opens the Show Event Details dialog box (see Figure 59).
Figure 59. Flow Manager Show Event Details dialog box

- To access more information about the business object associated with the
selected event, click Event > Display Details. The Show
Business Object Data dialog box appears (see Figure 60).
Figure 60. Show Business Object Data dialog box

If you want to take action on any of the unresolved flows, refer to Steps for processing unresolved flows.
Perform one of the following steps to manage queries you created for
unresolved flows:
- To save the current filter information as a query, click Query >
Save. The query you type appears in the Query
list.
- To delete a selected query in the Query menu, click Query
> Delete.
- To show or hide the content of the query, click Query >
Show/Hide.
Perform the following steps to manage queries you created for unresolved
flows:
- In the results list in Flow Manager, select one or more events in the
results list.
- Do one of the following:
- To delete selected events, click Event > Delete.
- To save all the failed events in the results list in an Excel file, click
Event > Save.
- To print the selected events to a table, click Event >
Print. A dialog box appears with Print All Events or
Print Selected Events options.
- To display the number of events corresponding to the current query, click
Event > Get Count.
- To clear all the result events, close the result list, and refresh all the
filter controls, click Event > New Search.
Perform the following steps to process any failed events in the results
list in Flow Manager:
- In the results list in Flow Manager, select one or more events in the
results list.
- Do one of the following:
- To send the data of the events back to the destination application, click
Event > Submit.
- To cancel waiting events (long-lived business processes), click Event
> Cancel Waiting.
- To refresh the data and then send the events back to the destination
application, click Event > Refresh & Submit.
