Synchronizing monitor models

To keep monitor models synchronized in IBM® Business Monitor, you use the updateDEFConfig Jython scripts.

Before you begin

If no monitor model is deployed, no defconfig.xml file exists yet and running the updateDEFConfig script fails because the file is not found. Therefore, before you run one of the updateDEFConfig scripts to create the deployment environment, make sure that you complete the following steps:

Create and augment the deployment manager and custom profiles.
Federate the nodes into the deployment manager cell.
Run the deployment manager.
Restart the server or cluster for the modifications to take effect.

About this task

You need to keep the monitor models that are defined in the IBM Business Monitor defconfig.xml file synchronized with the list of the monitors that are currently installed, whether they are started or stopped. For this purpose, you can use the updateDEFConfig.sh or updateDEFConfig.bat script.

The following table lists the parameters that are available for the updateDEFConfig scripts.

Table 1. Parameters for the updateDEFConfig scripts
Parameter	Action	Required or Optional
`-?`, `-help`	Displays information about the options that are available with this command-line tool.	Optional
`-cellName`	Specifies the cell name to use to connect to Business Monitor	Required
`-profileName`	Specifies the profile name to use to connect to Business Monitor. This is the name of the deployment manager if Business Monitor is installed in a network deployment environment.	Required
`-user`	Specifies the user name for connecting to Business Monitor.	Required
`-password`	Specifies the password for connecting to Business Monitor.	Required
`-removeInactive`	This option instructs this command-line tool to also remove the monitor models that are installed in Business Monitor and are currently in InactiveSaveEvents consumption mode. Note: In the WebSphere® Application Server administration console, this mode is called Inactive or InactiveSaveEvents. The following values are valid: A list of one or more monitor models and versions that are in Inactive consumption mode. `ALL`, to process all the installed monitor models and versions that are in Inactive consumption mode.	Optional

Procedure

Run the script.

Use the -removeInactive option so that events that might still be sent to these monitor models that are in Inactive current consumption mode do not accumulate in the incoming event queue because they cannot be consumed.

Windows: business_monitor_install_dir\appserver_root\scripts.wbm\updateDEFConfig.bat
Run updateDEFConfig.bat -cellName cell_name -profileName profile_name -user user_name -password password [-removeInactive ALL|models_list]

The models_list argument is a list of one or more monitor models that have an Inactive consumption mode in the form model_name::model_version, separated by a ‘plus (+)’ character.
UNIX or Linux: business_monitor_install_dir/appserver_root/scripts.wbm/updateDEFConfig.sh
Run updateDEFConfig.sh -cellName cell_name -profileName profile_name -user user_name -password password [-removeInactive ALL|models_list]

The models_list argument is a list of one or more monitor models that have an Inactive consumption mode in the form model_name::model_version, separated by a ‘plus (+)’ character.

Messages that log the results of running the updateDEFConfig script are recorded in one of the following files:

Windows: business_monitor_install_dir\appserver_root\logs\updateDEFConfig\updateDEFConfig_timestamp_out.log
UNIX or Linux: business_monitor_install_dir/appserver_root/logs/updateDEFConfig/updateDEFConfig_timestamp_out.log

Results

The updateDEFConfig script retrieves the list of all the installed monitor models and compares it with the configured models that are listed in the defconfig.xml file. If some monitor models were uninstalled at some point, their corresponding DEF (Dynamic Event Framework) listeners and producers are still listed in this file. In that case, the updateDEFConfig script backs up the existing defconfig.xml file and removes the DEF listeners and producers for the models that are no longer installed.

If you added the -removeInactive option, the script also removes DEF producers and listeners from the existing defconfig.xml file for the installed monitor models that are in Inactive consumption mode.