Generate custom monitor models for process applications

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

In IBM Integration Designer, you can generate an initial custom monitor model for a process application that includes IBM Process Designer artifacts and IBM BPM artifacts, such as business processes and human tasks. The purpose of these monitor models is to serve as a starting point for custom monitor model development. The artifacts that you select when you generate the initial monitor model can be included in the process application or in one or more of its referenced toolkits.

Before you can generate a monitor model for a process application in Integration Designer, you must ensure that the following prerequisite conditions have been met:

IBM Business Monitor is installed.
IBM BPM is installed and configured to send events to Business Monitor.
Integration Designer is connected to the Process Center repository.
The process application is displayed in the Business Integration view of Integration Designer.

Depending on the specific content of the process application, the following prerequisites must also be met:

For a process application with the following content: The following prerequisites must be met:
IBM BPM artifacts only

The process application includes one or more Service Component Architecture (SCA) modules.
The SCA modules include IBM BPM artifacts that are referenced by the process application.

Process Designer artifacts only

The process application includes at least one business process diagram.

References to a toolkit

The process application includes at least one business process diagram.
The toolkit includes at least one business process diagram that is referenced by a business process diagram in the process application.

References to a Blueprint

The process application includes at least one Blueprint.

Both IBM BPM artifacts and Process Designer artifacts

The process application includes one or more SCA modules.
The SCA modules include IBM BPM artifacts that are referenced by the process application.
The process application includes at least one business process diagram.

References to a toolkit that contains both IBM BPM artifacts and Process Designer artifacts

The process application includes at least one business process diagram.
The toolkit includes at least one business process diagram that is referenced by a business process diagram in the process application.
Both the process application and the toolkit are associated with at least one SCA module.
The SCA module includes IBM BPM artifacts.

References to a business process diagram that contains a subprocess

The process application or toolkit includes at least one business process diagram.
The business process diagram contains at least one subprocess.

References to a business process diagram that contains an event that contains a subprocess

The process application includes at least one business process diagram.
The business process diagram contains at least one event.
The event contains at least one subprocess.

When you have finished generating a monitor model and you have made any required changes or additions using the monitor model editor, you must associate the monitor model with a process application before you can deploy it. You should associate the business monitoring project with a different process application than the one that will be monitored, so that you can manage its lifecycle independently.
You can create a new process application in the Process Center perspective and associate your monitoring project with it.
If a monitor model is generated from a process application and it is stored in a monitor project that is subsequently associated with any process application, the project cannot contain any other monitor models. It is also the only project that can be associated with the process application.

Procedure

In the Business Integration view of Integration Designer, right-click your process application and click Generate Monitor Model. The Generate Monitor Model wizard opens.
In the Target monitor project field, accept the default name or type a different name. If the specified monitoring project does not exist, it is created.
In the Target monitor model name field, accept the default monitor model name or type a different name that you want to assign to the new monitor model.
Click Next. (If the specified business monitoring project does not already exist in the workspace, a window is displayed where you select whether you want to create a new project automatically or choose an existing project.) The Choose What to Monitor page opens.
In the Choose What to Monitor page:

In the Event Source tree, select an artifact that you want to monitor in the monitor model. In the Monitoring Templates tab, the monitoring templates are displayed for the selected artifact.
In the Event Source tree, right-click each root-level artifact and click Select All Templates > At This Level and Below to select all monitoring templates of the selected artifact and its child nodes. (Alternatively, in the Monitoring Templates tab, you can click Select All.) These selections ensure that a custom monitor model is generated that is identical to the auto-generated monitor model in Process Designer.

In the Generate Monitor Model wizard, you cannot customize individual steps of a business process diagram. However, in the monitor model editor, you can manually customize the generated metrics and key performance indicators (KPIs) and have them apply to only specific individual steps of the business process diagram.
Click Next. The Choose How to Monitor page opens.

On the Choose How to Monitor page, select the implementation type, as described in the topic Generate monitor models from applications located in the workspace.
Click Finish. A new monitor model is generated and the monitor model editor opens.
If necessary, use the monitor model editor to further customize the monitor model.
Save your changes and ensure that there are no errors in the custom monitor model.
Switch to the Process Center perspective of Integration Designer and create a new process application.
Import the process application for the monitor model into your workspace so that you can view it in the Business Integration perspective:

From the Process Center repository, select the process application.
Click Open in workspace.

In the Business Integration view, right-click the business monitoring project that was specified in the Target monitor project field and click Associate with Process Center. The Associate with Process Center wizard opens.
In the Select the process application or toolkit that will contain the projects list, select the name of the process application that you just created.
Click Finish. The monitor model is published to the Process Center server.
The user ID used to connect to the Process Center must have the Deployer role associated with it, as described in the topic Troubleshooting business monitoring for process applications.

What to do next
If you later choose to refactor the name of a business monitoring project that is associated with a published process application, you will need to first disassociate the monitoring project from its associated process application, then rename the monitoring project and once again associate it with the process application.
Your runtime administrator must enable SCA events to be emitted or all of the child BPEL business process events will be routed to the error queue. Information about enabling SCA events is found in the topic Considerations for monitoring SCA events from IBM BPM Advanced.
Additional information on generating monitor models is found in the topic Generate monitor models from applications located in the workspace.

Generate monitor models

For a process application with the following content:	The following prerequisites must be met:
IBM BPM artifacts only	The process application includes one or more Service Component Architecture (SCA) modules. The SCA modules include IBM BPM artifacts that are referenced by the process application.
Process Designer artifacts only	The process application includes at least one business process diagram.
References to a toolkit	The process application includes at least one business process diagram. The toolkit includes at least one business process diagram that is referenced by a business process diagram in the process application.
References to a Blueprint	The process application includes at least one Blueprint.
Both IBM BPM artifacts and Process Designer artifacts	The process application includes one or more SCA modules. The SCA modules include IBM BPM artifacts that are referenced by the process application. The process application includes at least one business process diagram.
References to a toolkit that contains both IBM BPM artifacts and Process Designer artifacts	The process application includes at least one business process diagram. The toolkit includes at least one business process diagram that is referenced by a business process diagram in the process application. Both the process application and the toolkit are associated with at least one SCA module. The SCA module includes IBM BPM artifacts.
References to a business process diagram that contains a subprocess	The process application or toolkit includes at least one business process diagram. The business process diagram contains at least one subprocess.
References to a business process diagram that contains an event that contains a subprocess	The process application includes at least one business process diagram. The business process diagram contains at least one event. The event contains at least one subprocess.