Tools for monitor model editing

The IBM® Business Monitor development toolkit provides the tools for creating monitor models for use with IBM Business Monitor. Monitor models are XML documents that specify how information should be extracted from Common Base Events at run time and collected, combined, and stored for representation on a dashboard.

The toolkit provides a mechanism to create and edit monitor models that can be transformed into executable code for Business Monitor. The toolkit does not distinguish between the sources of the monitor model, whether it was created from a Business Process Execution Language (BPEL) process, from WebSphere® Business Modeler, or in the Business Monitoring perspective of Integration Designer. All can be deployed and monitored in Business Monitor.

You can define the contents of the monitor model using either form editors or an XML text editor. The terminology in the form editors matches the terminology used in the XML document. The toolkit also includes an Integrated Test Client and a debugger.

Project Explorer view

Each business monitoring project can contain monitor models, event definitions, and Scalable Vector Graphics (SVG) files. Files with the extension .mm are categorized as monitor models, and files with the extensions .xsd (XML Schema Definition), .wsdl (Web Services Description Language), or .cbe (Common Base Event) are categorized as event definitions. Projects that contain only event definitions that are referenced by monitor models in business monitoring projects are shown with a flag icon.

Be careful when deleting monitoring support projects (identified with the flag icon) from the Project Explorer view. If you generate a monitor model from a project in Integration Designer, the Project Explorer view shows only the .xsd, .wsdl, and .cbe files in the monitoring support project. The rest of the information, such as the component implementations, is not relevant to the monitor model and is not shown. However, deleting the support project from the Project Explorer view will delete the entire project, including the files that are not specific to the monitor model.

Monitor Model editor

Double-clicking a monitor model or element of a monitor model in the Project Explorer view opens the Monitor Model editor in the editor pane. You can edit in the form editor, which is based on the type of element you chose, or in the XML editor. The following tabs are available:
  • Monitor Details Model (form editor)
  • KPI Model (form editor)
  • Dimensional Model (form editor)
  • Visual Model (form editor)
  • Events Model (form editor)
  • your_filename.mm (XML editor)

Event definition editors

Double-clicking an event definition in the Project Explorer view opens the default editor in the editor pane. For .xsd files, the default editor is the XML schema editor.

For Common Base Event files, the default editor in Integration Designer is the event definition editor. The default editor in Rational® Application Developer is the text editor.

Files with .wsdl extension can contain embedded XML schemas within the <wsdl:types> section, and the types in these schemas can be referenced by events emitted by BPEL processes and other Process Server components. You can also import industry-standard .wsdl files that contain types to be used as event part types. For .wsdl files, the default editor in Integration Designer is the interface editor. The default editor in Rational Application Developer is the WSDL editor.

A .xsd file can contain many types and elements. In fact, a single .xsd file can hold all the type information needed for a monitor model. (A .cbe file, however, can only contain one event definition.) You can think of a .xsd file as a library of type definitions that are all related to each other or used for a similar purpose.

Monitoring Flow view

The Monitoring Flow view shows, at a glance, the flow of control between objects in the model. When you click the Monitor Details Model tab and then click a node in the tree, the Monitoring Flow view shows what triggers the node and what the node triggers.

To see the name of the context that contains the element, hover your cursor over an element.

To locate the element in the editor, click an element.

In addition, the Business Monitoring perspective makes use of the following views that are provided by the Eclipse platform. For more information about these views, see "Business integration perspective and views" in the Integration Designer documentation.

Problems view

The Problems view shows the results of all validation that was performed on the monitor model and event definitions. Validation occurs whenever you make a change, and all validation errors or warnings are listed in this view. You must resolve all errors before generating the Java™ 5 Platform, Enterprise Edition (Java EE) projects.

To open the editor with the focus on the location of the error or warning, double-click a row. The form-based page of the Monitor Model editor opens if the error can be fixed in that editor; otherwise, the XML text editor opens.

To display only those errors that apply to the selected model, click the filter icon on the title bar of the Problems view.

To display only the errors for the currently selected monitor model, select On selected resource only.

To display the errors for the monitor model and everything in the folders under it, select On selected resource and its children.

Outline view and Properties view

Supplemental information

The Outline view and the Properties view are shown when the XML text editor is selected. The Outline view shows the structure of the model. Selecting a component in the Outline view shows the contents in the Properties view and places your cursor at that location in the XML text editor.

For information on the Integrated Test Client and debugger, follow the links below.