IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Developing monitor models > Create monitor models > Generate monitor models

Generate monitor models from applications located in the workspace

When you generate a monitor model from an application in the Integration Designer workspace, you can choose which pieces of the application will be represented in the generated monitor model and how they will be implemented.

Before you can generate a monitor model from an Integration Designer application in the workspace, the following prerequisites must be met:

See Types of applications for generating monitor models for the available applications and information about turning on events for monitoring.

To generate a monitor model:


Procedure

  1. Right-click the business integration module or mediation module and click Generate Monitor Model. You can choose to generate monitor models only at the application level, not at the level of individual components.

  2. Select a location for the new monitor model. You can select a project from the list of existing business monitoring projects or type a name to create a new business monitoring project. After you have selected or created a project, type a name for the new monitor model and click Next.

  3. Select the elements that you want to monitor. In the tree showing the application to be monitored, click any node to see the template and event information for that element. The Monitoring Templates tab shows the common monitoring templates that are available for the selected element. Choose one or more templates to create the appropriate monitoring constructs in the generated model. (See Common monitoring templates for IBM BPM Advanced and WebSphere Enterprise Service Bus for more information.) The Emitted Events tab shows all of the events that the selected element can emit. You can either select events individually, or you can right-click in the tree at any level and click Select all events at this level or Select all events at this level and below.

    Events that can carry business information, which is often called the business payload (see Events that can carry business payload), are shown with a flag and package icon

    . Events that can never carry business information are shown with a flag icon

    .

    You cannot remove an event if you have chosen a template that requires that event. The event is shown as selected but unavailable.

    By default, all the events that you select are automatically enabled for emission in the application that you will be monitoring. If the application has already been deployed and, therefore, the set of events that the application emits cannot be changed, or if you want to restrict the selection to the events that the application currently indicates will be emitted, from the Select events with an option list, select Include only the events that have been turned on in the application.

    You can also select Include all selected events. If you select this option and select an event that is not currently emitted, you will see a warning in the Problems view after you have generated the monitor model. Using the information in the warning message, you can find the event that is currently turned off and update the application to turn on the event. To remove the synchronization warning from the Problems view, you can then synchronize the monitor model with the application.

    After you have finished selecting events and templates, click Next.

  4. Select how the monitored elements will be implemented. In general, accept the default implementations. The tree on this page shows only the elements you have chosen to monitor. Specifically, the tree shows the event sources that you selected events for and the event sources that are ancestors of those event sources. If you did not select any templates or events for the ancestor event sources, the default implementation is None whenever possible. (It is not always possible to specify None because some event sources contain information that is needed by events that are emitted from descendent event sources.) In the second column, select the monitoring implementation that you want for each element. Based on the element, you might have some or all of the following choices:

    • None. The element will not be represented in the generated monitor model. This option is available only if there are no inbound events at the selected or descendant levels that require the selected element to be present. If you click this option, all descendant levels are also set to None.
    • Monitoring context. A monitoring context will be created for the element, complete with keys and a corresponding cube. This option is available only if the selected application element has a lifecycle and an identity that events can use to find it.
    • Event group. An event group will be created for the element. All inbound events at the selected level and all descendant levels will be collected in this new event group (that is, they will all be at the same level in the event group). This option is available only if there are no templates chosen that require a monitoring context at the selected or any descendant levels.

      If you choose this option, all descendants are set to "–" because all of the associated events will be collected into the event group. (See When to choose monitoring contexts versus event groups for more information.)

  5. To see a preview of the monitor model that you chose to create, click Next. To make changes and see how they affect your model, click Back to make changes and then click Next.

  6. When satisfied with your selections, click Finish. You are asked whether you would like to switch to the Business Monitoring perspective to begin editing the newly created monitor model. To open the new monitor model in the Monitor Model editor, select Yes.

    Important: Confirm that the Build Automatically option on the Project menu is enabled. If it is not, perform a clean build on the monitor model project after it is generated to ensure that the monitor model is validated.


Results

The newly created monitor model contains automatically generated elements that correspond to the common monitoring templates and inbound events that you selected. The Application element field shows the display name of the event source in the application that is linked to this monitoring context. If any of the elements in the monitoring context were generated from templates, the templates are shown in the table. Open a template to see the managed elements.

For example, if you open a Start Time template, you see a Start Time metric and inbound events for each event that can create a monitoring context.


What to do next

To refine the model as required to achieve your objectives, you can create additional metrics, inbound events, and triggers. You can also remove inbound events that were created automatically but are not applicable.

If you later turn on some of the events in the application and open the monitor model, you will see warnings in the Problems view until you synchronize with the Integration Designer module. To remove the warnings, right-click the monitor model in the Project Explorer view and click Synchronize with Application. For further information about the generated model, see Results of generating monitor models from IBM BPM Advanced and WebSphere Enterprise Service Bus applications.

Generate monitor models