IBM Business Process Manager

https://www.ibm.com/docs/en/bpm/8.6.0
Admin
IBM Business Process Manager is a comprehensive business process management platform that provides a...
Tokens:2,507,608
Snippets:39,775
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Deploy and Start Applications

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=files-example-ant-script

Installs EAR files to the server and starts the applications using wsInstallApp and wsStartApplication.

```xml
<target name="deploy" depends="generateEAR">
        <!-- Install the apps on the server -->
        <wsInstallApp ear="${build.output.dir}/${module1}.ear"
                      user="${wps.username}"
                      password="${wps.password}"
                      failonerror="false" />
        <wsInstallApp ear="${build.output.dir}/${module2}.ear"
                      user="${wps.username}"
                      password="${wps.password}"
                      failonerror="false" />
        <wsInstallApp ear="${build.output.dir}/${testproject1}.ear"
                      user="${wps.username}"
                      password="${wps.password}"
                      failonerror="false" />
        <!-- After installing the apps they must be explicitly started -->
        <wsStartApplication application="${module1}App"
                            server="server1"
                            node="${wps.node}"
                            user="${wps.username}"
                            password="${wps.password}" />
        <wsStartApplication application="${module2}App"
                            server="server1"
                            node="${wps.node}"
                            user="${wps.username}"
                            password="${wps.password}" />
        <wsStartApplication application="${testproject1}App"
                            server="server1"
                            node="${wps.node}"
                            user="${wps.username}"
                            password="${wps.password}" />
    </target>
```

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

### Example execution of mmdeploy

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripts-headless-deployment-monitor-model

A concrete example of running the mmdeploy command from the installation directory.

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

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

### Start the Launchpad

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=dds-installing-configuring-process-center-1

Command to initiate the installation launchpad from the extracted directory.

```bash
extract_directory/launchpad.sh
```

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

### On Load Event Example

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-date-picker-deprecated

Example of setting the start date for the control when it is loaded.

```javascript
var workerStart = ${StartDate}.getDate();  me.setStart(workerStart);
```

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

### Get Start Date

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-date-picker-deprecated

Retrieves the currently set start date of the calendar.

```javascript
me.getStart();
```

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

### Start deployment environment using properties file

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=environments-starting-stopping-deployment-environment-using-command-line

Starts the deployment environment by referencing a specific configuration properties file.

```cmd
BPM_home\bin\BPMConfig -start my_environment.properties
```

```bash
BPM_home/bin/BPMConfig.sh -start my_environment.properties
```

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

### Start deployment environment

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=utilities-bpmconfig-command-line-utility

Starts the specified deployment environment.

```bash
BPMConfig -start -profile DmgrProfile -de De1
```

```bash
BPMConfig -start myenvironment.properties
```

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

### getStart Method Example

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-date-time-picker

Example usage for retrieving the currently set start date.

```javascript
me.getStart();
```

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

### List Application Template Information Example

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=administration-listing-information-about-process-task-templates

Example command to list all versions of a specific application on a cluster, including instance counts.

```bash
wsadmin.sh -f listTemplates.py  -cluster myCluster -application myApp -all -countInstances
```

```cmd
wsadmin -f listTemplates.py  -cluster myCluster -application myApp -all -countInstances
```

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

### Get Installation Status

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=governance-service-flows

Retrieves the current installation status for a specific snapshot on a process server.

```APIDOC
## Get Installation Status

### Description
Retrieves the installation status for a given process server and snapshot.

### Parameters
- **processServerID** (String) - Required
- **snapshotID** (String) - Required

### Output
- **status** (String) - The current installation status.
```

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

### Install a process application snapshot

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripting-bpminstallpackage

Establishes a SOAP connection to the Process Server and installs a snapshot from a specified file path.

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

wsadmin>AdminTask.BPMInstallPackage('[-inputFile C:/myProcessApps/BillingDispute.zip -showSnapshotInfo true]')
```

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

### Install a process application snapshot using wsadmin

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripting-bpminstall

Establishes a SOAP connection to the Process Center and executes the BPMInstall command with the specified container and server parameters.

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

wsadmin>AdminTask.BPMInstall('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName ProcessServer01 -skipGovernance false]')
```

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

### getStart()

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-date-picker-deprecated

Gets the start date of the calendar.

```APIDOC
## getStart()

### Description
Get the start date of the calendar that is currently set, if available.

### Example
me.getStart();
```

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

### Installation Manager Error Log

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=configuration-messages-known-issues-during-installation-profile-creation

Example of the error message generated in the Installation Manager log file when an invalid command line argument occurs during DB2 installation.

```xml
<message>
 <key>Error occurred in phase: {0}
 SU: {1} {2}
 IU: {3}
 Message: {4}</key>
 <arg>install</arg>
 <arg>com.ibm.ws.db2exp.winia64.core</arg>
 <arg>9.7.3.20111109_0314</arg>
 <arg>db2exp.winia64.exec null-&gt;9.7.3000&lt;/ag>
 <arg>Installation of DB2 Express has failed.
Log location: D:\IBM\BPM85\logs\db2install.log
Installation failure reason: Invalid command line argument. </arg>
</message>
```

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

### Start deployment manager

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=installation-switching-edition-java-used-in-bpm

Starts the deployment manager after switching the SDK version.

```bash
install_root/bin/startManager.sh -profileName DmgrProfile
```

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

### Adding a Dependency to a Started Process

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=javascript-adding-dependent-relationship

Example of starting a process and immediately adding a dependent relationship without authorization checks.

```javascript
 1  var process = tw.system.startProcessByName("Test BPD", null, false);
 2  var relation = process.addDependentProcess(processInstanceID, "relationship to a child process", false);
```

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

### Example silent installation command

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=fixes-installing-interim-silently

A concrete example of the imcl command used to apply a specific interim fix on a Windows system.

```bash
C:\Program Files\IBM\Installation Manager\eclipse\tools>imcl install 8.5.5.0-WS-BPMADVWESB-IFJR39658 -repositories C:\interimFix\8.5.5.0-WS-BPMADVWESB-IFJR39658 -installationDirectory C:\IBM\BPM -log logfix.txt
```

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

### Extract Deployment Configuration Examples

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=utilities-bpmquerydeploymentconfiguration

Examples of running the utility on Linux and Windows environments to extract profile deployment configurations.

```shell
BPMQueryDeploymentConfiguration.sh /opt/ibm/WebSphere/ProcServer620 profile1 /MigrationSnapshots/ProcServer620
```

```batch
BPMQueryDeploymentConfiguration.bat "C:\Program Files\IBM\WebSphere\ProcServer620" profile1 c:\MigrationSnapshots\ProcServer620
```

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

### Example silent uninstallation command

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=fixes-uninstalling-interim-silently

A concrete example of the command used to uninstall a specific interim fix from a specified installation directory.

```bash
C:\Program Files\IBM\Installation Manager\eclipse\tools>imcl uninstall 8.5.5.0-WS-BPMADVWESB-IFJR39658 -installationDirectory C:\IBM\BPM -log logfix.txt
```

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

### Example output of BPMCreateRemoteMigrationUtilities

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=lu-copying-migration-utilities-source-computer

Sample console output showing the successful creation of the migration utility zip file.

```text
/opt/IBM/BPM/bin>BPMCreateRemoteMigrationUtilities.sh /opt/MigrationUtility.zip
Buildfile: /opt/BPM/util/migration/scripts/createMigrationUtilDisk.ant
create_zip_image:
[zip] Building zip: /opt/MigrationUtility.zip

BUILD SUCCESSFUL
Total time: 41 seconds
```

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

### JConsole Launch Example

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=server-using-jconsole-access-mbeans

A concrete example of the JConsole launch command with specific file paths and truststore configurations.

```shell
jconsole -J-Djava.class.path=C:/IBM/Java/lib/jconsole.jar;C:/IBM/Java/lib/tools.jar;C:/IBM/wlp/clients/restConnector.jar 
-J-Djavax.net.ssl.trustStore=C:/IBM/wlp/usr/servers/pfs/resources/security/key.jks 
-J-Djavax.net.ssl.trustStorePassword=password -J-Djavax.net.ssl.trustStoreType=jks
```

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

### GET /rest/bpm/wle/v1/processApps

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=applications-get

Retrieves the process applications that are installed in the system.

```APIDOC
## GET /rest/bpm/wle/v1/processApps

### Description
Use this method to retrieve the process applications that are installed in the system. Only the process applications for which the calling user has read permission are returned in the response.

### Method
GET

### Endpoint
/rest/bpm/wle/v1/processApps

### Response
#### Success Response (200)
- **processAppsList** (array) - List of process apps installed in the system.

#### Response Example
{
   "status":"200",
   "data":{
      "processAppsList":[
         {
            "shortName":"TWP",
            "name":"Process Portal",
            "description":"",
            "defaultVersion":"Main",
            "installedSnapshots":[
               {
                  "name":"7.5.0",
                  "acronym":"7.5.0",
                  "active":true,
                  "activeSince":"2011-04-26T18:49:13Z",
                  "ID":"2064.64bbda3f-b456-486a-9679-87d81c4366dd"
               }
            ],
            "ID":"2066.23d3ecec-6fdb-4033-9c57-e931aa13761f"
         }
      ]
   }
}
```

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

### POST /rest/bpm/wle/v1/process (start)

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=calls-rest-api-authorization-process-instances

Starts a new BPD instance.

```APIDOC
## POST /rest/bpm/wle/v1/process

### Description
Starts a new BPD instance.

### Method
POST

### Endpoint
/rest/bpm/wle/v1/process?action={string}&bpdId={string}[&snapshotId={string}][&branchId={string}][&processAppId={string}][&params={string}][&parts={string}]

### Parameters
#### Query Parameters
- **action** (string) - Required
- **bpdId** (string) - Required
- **snapshotId** (string) - Optional
- **branchId** (string) - Optional
- **processAppId** (string) - Optional
- **params** (string) - Optional
- **parts** (string) - Optional
```

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

### GET /v1/systems

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=apis-rest-interface-bpd-related-resources

Retrieve metadata about IBM BPM installations.

```APIDOC
## GET /v1/systems

### Description
Retrieve metadata about one or more IBM BPM installations (single server or cluster).

### Method
GET

### Endpoint
/v1/systems
```

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

### Install a snapshot using BPMInstall

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=server-using-wsadmin-commands

Use this command to install a specific snapshot of a process application onto a connected server.

```jython
AdminTask.BPMInstall('[-containerAcronym HSS -containerSnapshotAcronym SHSV856 -containerTrackAcronym Main -serverName ProcessServer01 -skipGovernance false]')
```

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

### GET /v1/processApps

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=apis-rest-interface-bpel-related-process-resources

Retrieve the process applications that are installed in the system.

```APIDOC
## GET /v1/processApps

### Description
Use this method to retrieve the process applications that are installed in the system.

### Method
GET

### Endpoint
/v1/processApps
```

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

### Verify Server Startup

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=server-creating-process-federation

Console output confirming the server has started successfully.

```text
Starting server server_name
Server server_name started
```

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

### BPMInstall

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripting-bpminstall

Installs a process application snapshot to a specified server instance.

```APIDOC
## BPMInstall

### Description
Installs a process application snapshot to a specified Process Server instance using the wsadmin scripting client.

### Parameters
- **-containerAcronym** (string) - Required - The acronym of the process application.
- **-containerSnapshotAcronym** (string) - Required - The acronym of the process application snapshot.
- **-serverName** (string) - Required - The name of the Process Server instance.
- **-skipGovernance** (boolean) - Optional - If set to true, skips all governance processes (default is false).
```

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

### GET /rest/bpm/htm/v1/processApps

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=ribrtr-process-applications

Retrieves a list of all process applications installed in the system.

```APIDOC
## GET /rest/bpm/htm/v1/processApps

### Description
Use this method to retrieve the process applications that are installed in the system.

### Method
GET

### Endpoint
/rest/bpm/htm/v1/processApps
```

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

### GET /rest/bpm/bfm/v1/processApps

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=ribrpr-process-applications

Retrieves a list of all process applications that are installed in the system.

```APIDOC
## GET /rest/bpm/bfm/v1/processApps

### Description
Use this method to retrieve the process applications that are installed in the system.

### Method
GET

### Endpoint
/rest/bpm/bfm/v1/processApps
```

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

### Example Configuration Output

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=mrscp-using-wsadmin-commands-customize-process-server-settings-used-connect-process-center

Sample output showing the heartbeat interval and Process Center URL configuration.

```text
...
[heartBeatInterval 60]
...
[processCenterUrl https://hostname:9082/ProcessCenter]
```

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

### Create master installation directory

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=installations-installing-configuring-swinging-profiles-environment

Create the base directory for the master product installation.

```bash
mkdir -p /opt/BPMInstall/MASTER/AppServer
```

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

### GET /rest/bpm/federated/bfm/v1/processApps

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=deprecated-process-applications-process-resources

Retrieves the list of process applications that are installed in the system.

```APIDOC
## GET /rest/bpm/federated/bfm/v1/processApps

### Description
Use this method to retrieve the process applications that are installed in the system.

### Method
GET

### Endpoint
/rest/bpm/federated/bfm/v1/processApps
```

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

### GET /rest/bpm/wle/v1/users

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=resources-users

Retrieve information about users that have been defined to the IBM BPM installation.

```APIDOC
## GET /rest/bpm/wle/v1/users

### Description
Retrieve information about users that have been defined to the IBM BPM installation.

### Method
GET

### Endpoint
/rest/bpm/wle/v1/users
```

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

### Run BPMEnablePostInstaller

Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=installations-applying-interim-fix-by-swinging-profiles

Commands to enable post-installation scripts for specific interim fixes or all installed fixes.

```bash
BPMEnablePostInstaller.sh -ifix 8.6.0.0-WS-BPM-IFJR00000,8.6.0.0-WS-BPM-IFJR11111
```

```bash
BPMEnablePostInstaller.sh -ifix
```
Tokens:
Raw