Using WebSphere Business Integration Monitor

WebSphere Business Integration Monitor is a standalone monitor that allows you to monitor a variety of servers, one of which is InterChange Server. WebSphere Business Integration Monitor is part of the WebSphere Business Integration Modeler & Monitor product. In order for WebSphere Business Integration Monitor to have the capability to monitor flows in InterChange Server, the following requirements must be met:

For WebSphere Business Integration Monitor installation and deployment instructions, refer to the Deployment guide in the WebSphere Business Integration Monitor documentation. For MQ Workflow adapter installation instructions, refer to the Adapter for MQ Workflow User Guide.

Important:
WebSphere Business Integration Monitor will not work with InterChange Server if InterChange Server if it is using Microsoft SQL Server as its database.

This section covers the following topics:

How WebSphere Business Integration Monitor works with InterChange Server

Steps for enabling flow monitoring in the MQWorkflow adapter

Configuring InterChange Server for flow monitoring

Steps for configuring tracing for flow monitoring

Note:
This guide does not cover instructions for administering WebSphere Business Integration Monitor. For WebSphere Business Integration Monitor administration instructions, refer to the Administration Guide in the WebSphere Business Integration Monitor documentation.

How WebSphere Business Integration Monitor works with InterChange Server

WebSphere Business Integration Monitor is able to monitor an InterChange Server system only when that InterChange Server system is configured with flow monitoring. Flow monitoring is a service that provides a view of the event information associated with each flow as it passes through a collaboration in InterChange Server.

Note:
WebSphere Business Integration Monitor monitors InterChange Server events only, not the business data associated with those events.

Steps for enabling flow monitoring in the MQWorkflow adapter

WebSphere Business Integration Monitor can monitor an InterChange Server system only when the MQWorkflow adapter is enabled for flow monitoring. Flow monitoring is a service that provides a view of the event information associated with each flow as it passes through a collaboration in InterChange Server.

Note:
You must configure WebSphere MQ to process BiDi data in order to enable communication with the BiDi environment. For more information, please refer to System Installation Guide for Windows.

Perform the following steps to enable the MQWorkflow adapter with flow monitoring.

  1. From System Manager, double-click the MQWorkflow connector. This opens Connector Configurator.
  2. In the Standard Properties tab, scroll to the EnableOidForFlowMonitoring property.
  3. In the Value column, select "true."
  4. Click File > Save > To Project.
  5. Deploy the repository to InterChange Server.
  6. Restart InterChange Server.

Configuring InterChange Server for flow monitoring

WebSphere Business Integration Monitor can monitor an InterChange Server system only when that InterChange Server system is first configured with flow monitoring. Flow monitoring is a service that provides a view of the event information associated with each flow as it passes through a collaboration in InterChange Server. The following sections describe how to configure InterChange Server for flow monitoring.

Steps for configuring the InterChange Server database for flow monitoring

Steps for configuring maximum queue depth for flow monitoring

Steps for configuring tracing for flow monitoring

Steps for configuring the InterChange Server database for flow monitoring

The InterChange Server database can be configured for flow monitoring only after the InterChange Server installation is complete. Two tools allow you to configure the InterChange Server database for flow monitoring: the InterChange Server Configuration Wizard and System Manager.

Perform the following steps to configure the InterChange Server database for flow monitoring, using either of these tools.

Important:
Flow monitoring cannot be configured on InterChange Server if Microsoft SQL Server is the InterChange Server database.
  1. Depending on which tool you use, open the tool using one of the following instructions:
    InterChange Server Configuration Wizard

    Click Start > Programs > IBM WebSphere InterChange Server > IBM WebSphere InterChange Server > IBM WebSphere InterChange Server Configuration Wizard.

    The InterChange Server Configuration Wizard opens.

    System Manager

    From the InterChange Server Component Management view of System Monitor, right-click the ICS instance whose database you want to set up with the flow monitoring service, then select Edit Configuration.

    The upper-right section of System Manager becomes a tool from which you can edit the InterchangeSystem.cfg file.

  2. Select the Database tab (of either the InterChange Server Configuration Wizard or the Edit Configuration window of System Manager), then scroll to the bottom of the window to see the Flow Monitoring section (see Figure 17 for the InterChange Server Configuration Wizard orFigure 18 for the Edit Configuration window of System Manager).
    Note:
    If you are using Microsoft SQL Server as your InterChange Server database, the Flow Monitoring section will be greyed out. Flow monitoring cannot be configured on InterChange Server if Microsoft SQL Server is your InterChange Server database.

    Figure 17. Database tab of the InterChange Server Configuration Wizard


    Figure 18. Database tab of the Edit Configuration window of System Manager


  3. Enter information in the Flow Monitoring fields, using the information in Table 8 as a guide.

    Table 8. Flow Monitoring configuration information

    Configuration information Description
    Host Name Host name of the machine where the database server resides
    Database Name of the database you created on your database server
    Schema Name Name of the database schema where the flow monitoring event tables reside. If you configure a custom schema name, you must grant CREATE, DELETE, and INSERT permission to the login identified by the schema name. For DB2 databases, the schema name can be arbitrary. For Oracle databases, the schema name is the same as the user who creates the table. The default schema name is the same as the login user name.
    Note 1:
    Valid values for the schema name field can contain up to 30 characters from the US-ASCII character set. The name must begin with a letter from A through Z and the first three characters cannot be SYS. Other characters in the name can include the letters A through Z and numbers 0 through 9.
    Note 2:
    The "Schema name" field is available only on 4.2.2.2 versions of InterChange Server.
    Max connections Maximum number of simultaneous connections to the database
    Login Database login name
    Password Database password
    Port number Port number of your database server

Steps for configuring maximum queue depth for flow monitoring

Maximum queue depth is a parameter that controls the maximum number of events allowed in the InterChange Server memory before collaborations wait to enqueue additional events. During flow monitoring, many events are recorded for every flow in a traced collaboration. This results in large amounts of database activity, which can degrade performance. To prevent excessive performance degradation, the collaboration flows write monitor events to an in-memory InterChange Server queue, then these flows are transferred to the database. In order to prevent the InterChange Server system from running out of memory, this queue depth can be limited by configuring the maximum queue depth parameter.

Perform the following steps to configure the maximum queue depth from System Manager.

Note:
The maximum queue depth parameter is configurable system-wide only, not on a per collaboration basis.
  1. From the InterChange Component Management view, right-click the InterChange Server instance whose maximum queue depth you want to configure, then select Edit Configuration. The upper-right section of the System Manager window becomes a tool from which you can edit the InterchangeSystem.cfg file.
  2. Click the Misc tab (see Figure 19).

    Figure 19. Mics tab of InterChange Server Edit Configuration window


  3. In the "Max flow queue depth" field of the Flow Monitoring section, enter a number that represents the maximum number of events you want to allow in the InterChange Server memory before collaborations wait to enqueue additional events. The default is 500. Alternatively, you can select the Max value check box. The maximum number of events allowed is 2147483647.

    The changes are saved immediately to the InterchangeSystem.cfg file, but do not take effect until the server is restarted.

Steps for configuring tracing for flow monitoring

When you configure flow monitoring for an InterChange Server system, you can set a desired trace level for traced events.

Perform the following steps to set the trace level for flow monitoring.

Note:
Setting the trace level for flow monitoring can be done only on a system-wide basis, not on a per collaboration basis.
  1. From the InterChange Component Management view, right-click the InterChange Server instance whose flow monitoring trace level you want to configure, then select Edit Configuration. The upper-right section of the System Manager window becomes a tool from which you can edit the InterchangeSystem.cfg file.
  2. Select the Tracing Levels tab.
  3. In the IBM WebSphere Business Integration System Trace Levels group box, look for the "Trace level" field for Flow Monitoring.
  4. In the Flow Monitoring Trace level field, select a number from 0-5 to represent the desired trace level. Table 9 describes the different trace levels for flow monitoring.

    Table 9. Flow monitoring trace levels

    Trace level Description
    0 No tracing
    1 At boot-time, display the configuration to the database
    2 Not used
    3 Show event enqueue/dequeue in-memory of the server
    4 Show event data details such as type or sequenceNumber after in-memory queue operation
    5 Add database writes

Copyright IBM Corp. 1997, 2004