IBM Business Monitor

https://www.ibm.com/docs/en/business-monitor
Admin
IBM Business Monitor is an enterprise software solution for monitoring and managing business...
Tokens:1,068,199
Snippets:10,891
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Example mmdeploy Script Execution

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=scripts-headless-deployment-monitor-model

This example demonstrates how to run the mmdeploy script from the installation directory. It specifies the paths for the project interchange file, working directory, EAR file, and the monitor model file.

```bash
mmdeploy -pi C:\Models\StockTradeBPELV5PI.zip -w C:\workingDir -ear C:\Models\StocktradeBPELV5.ear -mm /StockTradeBPELMM/StockTradeBPELBRHTM.mm
```

--------------------------------

### Install Business Space Widgets on a Server

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=dashboards-installbusinessspacewidgets-command

This example demonstrates how to install, deploy, and register widgets on a specific server within IBM Business Space using the `installBusinessSpaceWidgets` wsadmin command.

```APIDOC
## POST /wsadmin/installBusinessSpaceWidgets (Server)

### Description
Installs, deploys, and registers Business Space widgets on a specified server. This command requires detailed path information for the widget zip file.

### Method
POST

### Endpoint
/wsadmin/installBusinessSpaceWidgets

### Parameters
#### Query Parameters
- **nodeName** (String) - Required - The name of the node where the server is located.
- **serverName** (String) - Required - The name of the server to install widgets on.
- **widgets** (String) - Required - The full path to the widget zip file (e.g., install_root/BusinessSpace/registryData/product_name/widgets/MyWidget.zip).

### Request Example
```
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-nodeName', 'node_name', '-serverName', 'server_name', '-widgets', 'install_root/BusinessSpace/registryData/product_name/widgets/MyWidget.zip' ] )
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message indicating successful widget installation.
```

--------------------------------

### Install Business Space Widgets on a Server (Jython)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=dashboards-installbusinessspacewidgets

This example demonstrates installing, deploying, and registering Business Space widgets on a server using the `installBusinessSpaceWidgets` command with Jython. It requires specifying the node name, server name, and the path to the widget zip file.

```jython
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-nodeName', 'node_name',
'-serverName', 'server_name', '-widgets',
'install_root/BusinessSpace/registryData/product_name/widgets/MyWidget.zip' ] )
```

--------------------------------

### Install Business Space Widgets on a Server using wsadmin

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=bscd-installbusinessspacewidgets

This example demonstrates how to use the installBusinessSpaceWidgets command via wsadmin to install, deploy, and register widgets on a specific server. It requires specifying the node name, server name, and the path to the widget zip file. The command is executed using Jython.

```Shell
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-nodeName', 'node_name',
'-serverName', 'server_name', '-widgets',
'install_root/BusinessSpace/registryData/product_name/widgets/MyWidget.zip' ] ) 
```

--------------------------------

### Example Arguments for instanceImport.jy

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=scripts-importing-instances

These examples demonstrate the expected arguments for the `instanceImport.jy` script. The first example shows a typical import using a model ID, version ID, and a directory. The second example illustrates importing from a specific CSV file.

```shell
instanceImport.jy Mymodel 2008-12-11T15:29:33 c:\instances
```

```shell
instanceImport.jy Mymodel 2008-12-11T15:29:33 c:\instances\Mymodel_20081211152933_MyMC_20081221121953.csv
```

--------------------------------

### Install Packages with Installation Manager (Linux/macOS)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=silently-using-command-line

This command installs specified IBM Business Monitor packages and features using Installation Manager on Linux or macOS. It requires accepting the license, specifying installation location, repositories, properties, and a log file. The `showVerboseProgress` option may not be available on systems without a graphical user interface.

```bash
extract_directory/IM64/tools/imcl install list_of_package_IDs -acceptLicense -installationDirectory location -repositories repository -properties key=value,key=value -showVerboseProgress -log logName.log
```

--------------------------------

### Start Profile Management Tool (Shell Script)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=tool-augmenting-stand-alone-profiles

This command initiates the Profile Management Tool using a shell script, typically found in the installation directory. It is the entry point for profile management operations on Unix-like systems.

```shell
install_root/bin/ProfileManagement/pmt.sh
```

--------------------------------

### Install Packages with Installation Manager (Windows)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=silently-using-command-line

This command installs specified IBM Business Monitor packages and features using Installation Manager on Windows. It requires accepting the license, specifying installation location, repositories, properties, and a log file. The command prompt must be run as an administrator.

```bash
extract_directory\IM64\tools\imcl install list_of_package_IDs -acceptLicense -installationDirectory location -repositories repository -properties key=value,key=value -showVerboseProgress -log logName.log
```

--------------------------------

### Example DataMigration Script Configuration (DB2)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=d-migrating-monitor-database-data

This provides a practical example of running the DataMigration script for a DB2 database. It uses default values for database name and schema ('MONITOR') and specifies example host, port, user, and password. This demonstrates the expected format for successful execution.

```bash
DataMigration -dbType DB2 -dbName MONITOR -dbSchema MONITOR -host dbhost -port 50000 -dbUser db2admin -dbPassword db2password
```

--------------------------------

### Starting Clustered Environment Components with startManager.sh, startNode.sh, startServer.sh

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=unix-migrating-business-space-v620x-data

This sequence of commands starts the deployment manager, node, and all servers in a clustered environment. They are executed from the profile_root/bin directory of the migration target server.

```shell
startManager.sh
startNode.sh
startServer.sh server_name (start all servers on the node in sequence)
```

--------------------------------

### Install Business Space Widgets on a Cluster

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=dashboards-installbusinessspacewidgets-command

This example shows how to install, deploy, and register widgets on a cluster in IBM Business Space using the `installBusinessSpaceWidgets` wsadmin command. It allows specifying a directory containing multiple widget zip files.

```APIDOC
## POST /wsadmin/installBusinessSpaceWidgets (Cluster)

### Description
Installs, deploys, and registers Business Space widgets on a specified cluster. This command can accept a directory path containing multiple widget zip files.

### Method
POST

### Endpoint
/wsadmin/installBusinessSpaceWidgets

### Parameters
#### Query Parameters
- **clusterName** (String) - Required - The name of the cluster to install widgets on.
- **widgets** (String) - Required - The directory path containing the widget zip files (e.g., X:/WPS/Temp).

### Request Example
```
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-clusterName', 'cluster_name', '-widgets', 'X:/WPS/Temp' ] )
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message indicating successful widget installation across the cluster.
```

--------------------------------

### XPath Reference Example for ReferenceType

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=description-referencetype

This example illustrates the format of the 'ref' attribute within ReferenceType. It shows an XPath expression used to reference a specific element within the model, starting from an absolute path.

```plaintext
/monitor_id/fixed id of a model (MDM, DMM, VM, etc.)/container id/child id/ ... /final target id
```

--------------------------------

### Install Business Space Widgets on a Cluster (Jython)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=dashboards-installbusinessspacewidgets

This example shows how to install, deploy, and register Business Space widgets on a cluster using the `installBusinessSpaceWidgets` command with Jython. It requires specifying the cluster name and the directory containing the widgets.

```jython
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-clusterName', 'cluster_name',
'-widgets', 'X:/WPS/Temp' ] )
```

--------------------------------

### Install IBM Business Monitor with Multiple Tasks

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=wsadmin-noninteractive-mode

Demonstrates the AdminApp.install command to deploy IBM Business Monitor with four configured tasks: Database, Cognos, Event Source, and Data Security. This example shows how to bundle multiple task configurations into a single installation command.

```python
AdminApp.install(earName,  ['-LifecycleClientDatabaseTask', [databaseTaskInfo], \
   '-LifecycleClientCognosTask', [cognosTaskInfo], \
   '-LifecycleClientEventSourceTask', [eventTaskInfo], \
   '-LifecycleClientDataSecurityTask', [securityTaskInfo] ]  )
```

--------------------------------

### DataMigration Script Example (SQL Server)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=ss-migrating-monitor-database-data

An example of how to run the DataMigration script for a SQL Server database. It demonstrates the correct format for specifying database name, schema, host, port, user, and password.

```bash
DataMigration -dbType SQLServer -dbName MONITOR -dbSchema MONITOR -host dbhost -port 50000 -dbUser databaseadmin -dbPassword databasepassword
```

--------------------------------

### Deploy Mortgage Lending BAM Application EAR

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=sample-installing-artifacts-creating-users-groups

Deployment command for the Mortgage Lending Business Activity Monitoring (BAM) application. This EAR file contains the sample model that needs to be installed on the monitor server.

```shell
<monitor_server>/installableApps.wbm/samples/mortgageLending/MortgageLendingBAMApplication.ear
```

--------------------------------

### List Available Java SDKs with managesdk

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=monitor-switching-edition-java-used-in-business

This command lists all available Java SDKs in the environment. It is the first step in the process of switching Java editions. No specific input is required, and the output displays the names of the SDKs.

```shell
install_root/bin/managesdk.sh -listAvailable

CWSDK1003I: Available SDKs:
CWSDK1005I: SDK name: 1.7.1_64
CWSDK1005I: SDK name: 1.6_64 
CWSDK1001I: Successfully performed the requested managesdk task.
```

--------------------------------

### Install Business Space Widgets on a Cluster using wsadmin

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=bscd-installbusinessspacewidgets

This example shows how to use the installBusinessSpaceWidgets command with wsadmin to install, deploy, and register widgets across a cluster. It requires specifying the cluster name and the directory containing the widgets. The command is executed using Jython.

```Shell
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-clusterName', 'cluster_name',
'-widgets', 'X:/WPS/Temp' ] ) 
```

--------------------------------

### Example: Export Instance Data by Creation Time Range (Linux/UNIX)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=scripts-exporting-instances

This example shows how to export IBM Business Monitor instance data by specifying a creation time range. The script will export instances created between the provided start and end times.

```shell
instanceExport.jy Mymodel 2008-12-11T15:29:33 /instances TerminationTime 2008-12-12T13:21:13 2008-12-22T15:21:13
```

--------------------------------

### Errors Starting Business Monitor Server (Java)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=troubleshooting-errors-when-starting-business-monitor-server

This snippet shows common Java exceptions that can occur when the IBM Business Monitor server starts on platforms that do not support the installation of IBM Cognos Business Intelligence. These errors typically relate to missing libraries or incompatible class changes.

```java
java.lang.UnsatisfiedLinkError: ibmgpu (libcudart.so.5.5: cannot open shared object file: No such file or directory) 
Exception in thread "Thread-19" java.lang.IncompatibleClassChangeError: com.caucho.hessian.io.Serializer
```

--------------------------------

### Start Commands for Clustered Environment (Windows)

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=windows-migrating-business-space-v620x-data

These commands are used to start the necessary components in a clustered environment for Business Space migration. This includes starting the deployment manager, the node, and all servers sequentially. All commands are located in the profile_root\bin directory.

```batch
startManager.bat
startNode.bat
startServer.bat server_name (start all servers on the node in sequence)
```

--------------------------------

### Emit Sample Events for Mortgage Lending

Source: https://www.ibm.com/docs/en/business-monitor/8.5_topic=sample-installing-artifacts-creating-users-groups

Command to emit sample events for the Mortgage Lending application. These events trigger instance data within the Business Monitor, allowing you to test the deployed sample model.

```shell
<monitor_server>/installableApps.wbm/samples/mortgageLending/events/allevents
```
Tokens:
Raw