IBM Business Automation Workflow

https://www.ibm.com/docs/en/baw/25.0.x
Admin
IBM Business Automation Workflow is an enterprise automation platform that enables organizations to...
Tokens:4,425,573
Snippets:59,669
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example of starting a service with parameters

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=s-post-start

This example demonstrates how to start a service using the `action` and `params` parameters. The `params` are provided as a JSON string.

```http
POST http://myhost.mycompany.com:9080/rest/bpm/wle/v1/service/<serviceModelID>

HTTP Headers:
Content-Type: application/x-www-form-urlencoded
Accept: application/json

HTTP Request Body:
action=start&params={"orderNumber":"5","customerName":{"firstName":"John","lastName":"Doe"}}
```

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

### Deploy and Start Applications

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=files-example-ant-script

Installs EAR files and starts the corresponding applications on the server.

```xml
<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" />
        <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}" />
```

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

### Install IBM Process Federation Server Example

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=server-installing-silently-by-using-command-line

Example command for installing IBM Process Federation Server, WebSphere Application Server Liberty, and IBM SDK on Linux.

```shell
imcl install com.ibm.bpm.pfs.v85,ProcessFederationServerPFS 
com.ibm.websphere.liberty.ND.v85,liberty com.ibm.java.jdk.v8 -acceptLicense -
installationDirectory /usr/IBM/PFS -repositories /usr/tmp/BPM/repository  -
showVerboseProgress -log silentinstall.log
```

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

### Example imcl installation command

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=fixes-installing-interim-silently

A concrete example of the imcl command with placeholder paths replaced for a Windows environment.

```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
```

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

### Configure UMS Server Variables

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=service-specifying-basic-user-management-configuration-settings

Example XML configuration for a quick start UMS server setup.

```xml
<server>

    <variable name="hostname" value="localhost" />
    <variable name="http_port" value="-1" />
    <variable name="https_port" value="9443" />
 	<variable name="external_hostname" value="${hostname}" />

    <variable name="admin.user" value="adminUser" />
    <variable name="admin.password" value="password" />

    <variable name="ssl_keystore_password" value="keystorePassword" />

 	<variable name="oidc.jwt.keystore.location" value="resources/security/key.p12" /> 
 	<variable name="oidc.jwt.keystore.password" value="${ssl_keystore_password}" /> 
 	<variable name="oidc.jwt.keystore.type" value="PKCS12" /> 
 	<variable name="oidc.jwt.keyAliasName" value="default" />
 
    <variable name="db.type" value="derby" />

    <variable name="oauth.datasource.id" value="${db.type}OAuthDataSource" />
    <variable name="oauth.db.name" value="" />
    <variable name="oauth.db.hostname" value="" />
    <variable name="oauth.db.port" value="1521" />
    <variable name="oauth.db.user" value="" />
    <variable name="oauth.db.password" value="" />

</server>
```

```xml
<server>

    <variable name="hostname" value="localhost" />
    <variable name="http_port" value="-1" />
    <variable name="https_port" value="9443" />
 	<variable name="external_hostname" value="mypublicaddress.example.com" />
    <variable name="admin.user" value="adminUser" />
    <variable name="admin.password" value="password" />

    <variable name="ssl_keystore_password" value="keystorePassword" />
    
 	<variable name="oidc.jwt.keystore.location" value="resources/security/jwtkey.p12" />
```

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

### Example Process Applications Response

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=pa-get-4

An example of the JSON response returned when invoking the GET method for the Process Applications Resource. It shows a list of installed process applications with their details.

```JSON
{
   "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"
         },
         {
            "shortName":"HSS",
            "name":"Hiring Sample",
            "description":"Hiring Sample",
            "defaultVersion":"Main",
            "installedSnapshots":[
               {
                  "name":"Hiring Sample 3",
                  "acronym":"HS3",
                  "active":true,
                  "activeSince":"2011-04-26T18:50:06Z",
                  "ID":"2064.30c63e29-aacd-4b3b-803f-a09ce65486d2"
               }
            ],
            "ID":"2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
         }
      ]
   }
}

```

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

### Install cert-manager and license-manager

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=deployment-optional-mirroring-installing-your-own-curated-catalog

Execute the `setup_singleton.sh` script with appropriate flags to install cert-manager and license-manager services. Ensure the `<absolute path to files>` is correctly specified.

```bash
./setup_singleton.sh --license-accept --enable-licensing -v 1 -c v4.2
```

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

### GET /process/applications

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=ribrpr-process-applications

Retrieves a list of all process applications installed in the system. This endpoint is available starting from version 7.5.1.

```APIDOC
## GET /process/applications

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

### Method
GET

### Endpoint
/process/applications

### Parameters
#### Query Parameters
There are no query parameters for this endpoint.

#### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
- **applications** (array) - A list of installed process applications. Each application object may contain details such as name, version, and status.

#### Response Example
```json
{
  "applications": [
    {
      "name": "ExampleApp1",
      "version": "1.0.0",
      "status": "deployed"
    },
    {
      "name": "ExampleApp2",
      "version": "2.1.0",
      "status": "undeployed"
    }
  ]
}
```
```

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

### GET /processapps

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=deprecated-process-applications-process-resources

Retrieves a list of all process applications installed in the system. This endpoint is available starting from version 7.5.1.

```APIDOC
## GET /processapps

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

### Method
GET

### Endpoint
/processapps

### Parameters
#### Query Parameters
This endpoint does not have any query parameters.

#### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
- **processApps** (array) - A list of installed process applications.
  - **name** (string) - The name of the process application.
  - **version** (string) - The version of the process application.

#### Response Example
```json
{
  "processApps": [
    {
      "name": "SampleApp",
      "version": "1.0.0"
    },
    {
      "name": "AnotherApp",
      "version": "2.1.0"
    }
  ]
}
```
```

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

### Start Machine Learning Server

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=server-changing-machine-learning-configuration

Use this command to start the server with initialization and license acceptance.

```bash
./bin/ba-ml-server-start --init --acceptLicense
```

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

### Get Installation Status API

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=deprecated-governance-service-flows

Gets the installation status during long-running installations. This service flow retrieves the current installation status.

```APIDOC
## Get Installation Status

### Description
Gets the installation status during long-running installations.

### Method
GET

### Endpoint
/api/installation/status/get

### Parameters
#### Query Parameters
- **processServerID** (String) - Required - The ID of the process server.
- **snapshotID** (String) - Required - The ID of the snapshot.

### Response
#### Success Response (200)
- **status** (String) - The current installation status.
- **description** (String) - A description of the current status.

### Request Example
```
GET /api/installation/status/get?processServerID=server123&snapshotID=snapshotABC
```

### Response Example
```json
{
  "status": "In Progress",
  "description": "Installation is currently running."
}
```

### Notes
- If an installation attempt fails, call the Cancel Snapshot Installation service flow to clear the status in Process Center.
```

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

### Start deployment environment

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=utilities-bpmconfig-command-line-utility

Starts the specified deployment environment.

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

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

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

### Start Quick Start console on Linux/UNIX

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=configuring-starting-your-environment-by-using-quick-start

Use this command in a Linux or UNIX environment to start the Quick Start console. Ensure you are in the installation_root/bin directory.

```bash
BPMQuickStart.sh <deployment_environment_name> <profile_name> <admin_user_name> <admin_user_password>
```

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

### Example ServerAccessToken GET Response Content

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=s-get-1

This is an example of the JSON content returned by the ServerAccessToken GET method. It includes a status, and a data object containing the accessToken and a success message.

```json
{
  "status": "200",
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im50LWVrX1FIY1JOand6SWZTUlNxcG1VeGJSQk1jZ3BpX0N2RmlZZk5haEkifQ.eyJ1c2VybmFtZSI6ImNwNGFkbWluIiwicm9sZSI6IlVzZXIiLCJwZXJtaXNzaW9ucyI6WyJjYW5fYWRtaW5pc3RyYXRlX2J1c2luZXNzX3RlYW1zIl0sImdyb3VwcyI6WzEwMDAwXSwic3ViIjoiY3A0YWRtaW4iLCJpc3MiOiJLTk9YU1NPIiwiYXVkIjoiRFNYIiwidWlkIjoiMTAwMDMzMTAwMiIsImF1dGhlbnRpY2F0b3IiOiJleHRlcm5hbCIsImlhbSI6eyJhY2Nlc3NUb2tlbiI6IkpIUHBTTkxwUUN2VHhTYW1JZ1EySUxyd2d6cXJuNWVrUDlobXlPN3dHbFRyNE5wekhqUlBxZG5tWGxNUnh6RnNtODZkT2tlRU16TUxxV05YRlBja0xhT1AycXVtbVZTVWh5ZUZ0M1lQZENPZUpsazBFNzZJdk5YbzM3dFI4cnl1SlVGWnp2dzhGWFltZlVqckN1emN4czJtNjBjRWs3aVhrNzg5T3UyZ0I5U2RuMlEzaVdvS2lSZnAyR0F4R1hzeWhBMVo0cFVzR0pqSnVnaU96WnRiTTBkR3FObmFmVEtIdlpOVFdQRGlWUk1CaVZqN0ttTnpoWHIxTWlpdHU4ZVFtdW8yWjNjQXZMQ3FXSTVQTUxvZHRGOUdVMFZ6NllNdkxGZjRSb3ZFdTA3a2Jra1VnRU1rMEVTb2tNUFVmckZFZ20wdkxKZ1JjVkxFTHB4ZmNoQzF0V205cjA0b0U4ZjFqcHNNQ2h3Sm9XMm5MMXdwcnFTNndzZ0kyWlR4QU1xbWdTUWtDaWdmSElkWWpIckt0VkY1OUlqeEVncHNpbmRwTXE5dnc5MUZJR0tLZ3RPTmk1OUJGem5taDdKTGc0RTY1dnFjZFppUGpPNENoR3llVDZNRXNHREpUT3RTS3RKaU0zRG5aT3lqZ3NmazhJQWhFTmR2In0sImRpc3BsYXlfbmFtZSI6ImNwNGFkbWluIiwiaWF0IjoxNjY5MDQ1Mjk5LCJleHAiOjE2NjkwODg0NjN9.LjM9LLYZjFSfoEBYhMuJoZ-UaRLkVP4gp7ulepVsUCxuUd6gqZi39TUHMksqSU2oikQCfOb2hssJAMloa9T3fmAnWIjgb0gxe6mVexhZebvC7wwHebNNHg1g0mLaDig9vR9r-uwISXid5SAWls-ijXFFFVplO2RQpRYBZl4JYYkjuQaQW6XTihelO01mEO56pj60gYUTKzbmki8LEHzAyUEs4eC2jDQVn1FMiWzUC--iR98_T09rMko6gTebZFOd2ZSQ28yOEBqcntEt11uTYFVqUB_je-zE8vWTvdkYgKaUmnibwdG1m7JEwshVGPAtRp-CAiHSS2mL6SsnWGXbuQ",
    "message": "success"
  }
}

```

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

### Start Liberty server

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=service-configuring-web-server

Navigate to the `wlp/bin` directory and use the `server start` command to start a Liberty server instance, specifying the server name.

```bash
server start ums1
```

```bash
server start ums2
```

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

### Get DatePicker Start Date

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=api-date-picker-deprecated

Retrieves the currently set start date for the calendar.

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

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

### Start Quick Start console on Windows

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=configuring-starting-your-environment-by-using-quick-start

Use this command in a Windows command prompt to start the Quick Start console. Ensure you are in the installation_root/bin directory.

```batch
BPMQuickStart.bat <deployment_environment_name> <profile_name> <admin_user_name> <admin_user_password>
```

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

### ServerAccessToken Example Response

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=serveraccesstoken-get

An example of a successful JSON response from the ServerAccessToken GET method.

```json
{
  "status": "200",
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im50LWVrX1FIY1JOand6SWZTUlNxcG1VeGJSQk1jZ3BpX0N2RmlZZk5haEkifQ.eyJ1c2VybmFtZSI6ImNwNGFkbWluIiwicm9sZSI6IlVzZXIiLCJwZXJtaXNzaW9ucyI6WyJjYW5fYWRtaW5pc3RyYXRlX2J1c2luZXNzX3RlYW1zIl0sImdyb3VwcyI6WzEwMDAwXSwic3ViIjoiY3A0YWRtaW4iLCJpc3MiOiJLTk9YU1NPIiwiYXVkIjoiRFNYIiwidWlkIjoiMTAwMDMzMTAwMiIsImF1dGhlbnRpY2F0b3IiOiJleHRlcm5hbCIsImlhbSI6eyJhY2Nlc3NUb2tlbiI6IkpIUHBTTkxwUUN2VHhTYW1JZ1EySUxyd2d6cXJuNWVrUDlobXlPN3dHbFRyNE5wekhqUlBxZG5tWGxNUnh6RnNtODZkT2tlRU16TUxxV05YRlBja0xhT1AycXVtbVZTVWh5ZUZ0M1lQZENPZUpsazBFNzZJdk5YbzM3dFI4cnl1SlVGWnp2dzhGWFltZlVqckN1emN4czJtNjBjRWs3aVhrNzg5T3UyZ0I5U2RuMlEzaVdvS2lSZnAyR0F4R1hzeWhBMVo0cFVzR0pqSnVnaU96WnRiTTBkR3FObmFmVEtIdlpOVFdQRGlWUk1CaVZqN0ttTnpoWHIxTWlpdHU4ZVFtdW8yWjNjQXZMQ3FXSTVQTUxvZHRGOUdVMFZ6NllNdkxGZjRSb3ZFdTA3a2Jra1VnRU1rMEVTb2tNUFVmckZFZ20wdkxKZ1JjVkxFTHB4ZmNoQzF0V205cjA0b0U4ZjFqcHNNQ2h3Sm9XMm5MMXdwcnFTNndzZ0kyWlR4QU1xbWdTUWtDaWdmSElkWWpIckt0VkY1OUlqeEVncHNpbmRwTXE5dnc5MUZJR0tLZ3RPTmk1OUJGem5taDdKTGc0RTY1dnFjZFppUGpPNENoR3llVDZNRXNHREpUT3RTS3RKaU0zRG5aT3lqZ3NmazhJQWhFTmR2In0sImRpc3BsYXlfbmFtZSI6ImNwNGFkbWluIiwiaWF0IjoxNjY5MDQ1Mjk5LCJleHAiOjE2NjkwODg0NjN9.LjM9LLYZjFSfoEBYhMuJoZ-UaRLkVP4gp7ulepVsUCxuUd6gqZi39TUHMksqSU2oikQCfOb2hssJAMloa9T3fmAnWIjgb0gxe6mVexhZebvC7wwHebNNHg1g0mLaDig9vR9r-uwISXid5SAWls-ijXFFFVplO2RQpRYBZl4JYYkjuQaQW6XTihelO01mEO56pj60gYUTKzbmki8LEHzAyUEs4eC2jDQVn1FMiWzUC--iR98_T09rMko6gTebZFOd2ZSQ28yOEBqcntEt11uTYFVqUB_je-zE8vWTvdkYgKaUmnibwdG1m7JEwshVGPAtRp-CAiHSS2mL6SsnWGXbuQ",
    "message": "success"
  }
}
```

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

### Start Deployment Environment (Linux/Unix)

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

Use this command to start a deployment environment on Linux/Unix by referencing a properties file. Ensure BPM_home is correctly set.

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

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

### Execute setup script for command line

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=sign-removing-single-authentication-delegation

Run the appropriate setup script based on your operating system to prepare the command-line environment for configuration changes.

```shell
./setupCmdLine.sh
```

```batch
setupCmdLine.bat
```

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

### BPMInstallPackage - Install Snapshot

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=scripting-bpminstallpackage

Installs a snapshot of a process application or case solution. This example shows how to install a snapshot and retrieve information about it.

```APIDOC
## POST /api/packages/install

### Description
Installs a snapshot of a process application or case solution onto the Workflow Center server.

### Method
POST

### Endpoint
/api/packages/install

### Parameters
#### Query Parameters
- **inputFile** (String) - Required - The absolute path of the offline installation package.
- **showSnapshotInfo** (Boolean) - Optional - If true, returns the acronyms of the process application, case solution, track, and snapshot that were installed.
- **inactive** (Boolean) - Optional - If true, disables automatic activation of a snapshot after it is deployed.
- **caseDosName** (String) - Optional - The design object store for case artifacts. Required if the deployment package contains a case solution and the design object store is not named "dos".
- **caseProjectArea** (String) - Optional - The target environment or project area for case artifacts. Required if the deployment package contains a case solution and no default project area is configured.
- **caseOverwrite** (Boolean) - Optional - Specifies to overwrite artifacts in the case store if they already exist. Defaults to false.

### Request Example
```json
{
  "inputFile": "C:/myProcessApps/BillingDispute.zip",
  "showSnapshotInfo": true
}
```

### Response
#### Success Response (200)
- **snapshotInfo** (Object) - Details about the installed snapshot if `showSnapshotInfo` is true.
- **message** (String) - Confirmation message of the installation.

#### Response Example
```json
{
  "snapshotInfo": {
    "processAppAcronym": "BillingDispute",
    "caseSolutionAcronym": "",
    "trackAcronym": "",
    "snapshotAcronym": "1.0.0"
  },
  "message": "Snapshot installed successfully."
}
```
```

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

### Get Blackout Date Start for DatePicker

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=api-datetime-picker

Retrieves the disabled start date for the DatePicker control.

```javascript
me.getBlackoutDateStart();
```

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

### Start Deployment Environment

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=utilities-bpmconfig-command-line-utility

The -start command initiates the deployment environment. It can be run by specifying the deployment manager profile name and deployment environment name, or by using a configuration properties file. The -de option is optional if only one deployment environment exists.

```bash
-start [-profile profile_name [-de DE_name]] | properties_file
```

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

### Get Item Text by Value Example

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=api-radio-button-group

Retrieves the display text for a given item value. The value must exist in the selection list. This example shows how to get text for a specific key and for the currently selected item.

```javascript
rdbtgrp.getItemText("Key1") // returns "Option 1" (for a selection item with value="Key1" and name="Option 1")
```

```javascript
rdbtgrp.getItemText(rdbtgrp.getSelectedItem()) // returns the text of the selected item
```

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

### POST /start

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=riprr-service

Starts a new service instance.

```APIDOC
## POST /start

### Description
Use this method to start a service.

### Method
POST

### Endpoint
/start
```

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

### Generate Solution Deployment Configuration Example

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=ds-deploying-legacy-case-solution-production-target-object-store-by-using-command-line

Example of generating a deploysolution.xml file for an existing case deployment profile named 'deploy_solution'.

```bash
configmgr_cl generateConfig 
 -task deploysolution
 -profile deploy_solution
```

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

### Start Deployment Environment (Windows)

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

Use this command to start a deployment environment on Windows by referencing a properties file. Ensure BPM_home is correctly set.

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

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

### Cancel Snapshot Installation API

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=deprecated-governance-service-flows

Cancels a snapshot installation request that is in progress (i.e., waiting for approval). If the installation has already started, the cancel request is ignored. This service flow calls the Java API for installation.

```APIDOC
## Cancel Snapshot Installation

### Description
Cancels the installation request that is in progress (that is, waiting for approval). After the installation has started, the cancel request is ignored.

### Method
POST

### Endpoint
/api/cancel/snapshot/installation

### Parameters
#### Request Body
- **installRequest** (object) - Required - The processAppInstallation object containing IDs that must not be null or zero length.

### Request Example
```json
{
  "installRequest": { ... }
}
```

### Notes
- If cancel is called multiple times for the same installation request, all calls after the first are ignored.
- If cancel is called against a process application for which governance is not enabled, the request is ignored.
- If there is not an active installation request for the snapshot and workflow server combination, the request cannot succeed.
- If the snapshot or workflow server is not properly identified, it cannot be found in Process Center.
```

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

### Start Deployment Manager

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=mei-switching-edition-java-used-in-business-automation-workflow

Starts the deployment manager server.

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

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

### Start Kafka Services

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=configuration-configuring-event-output-kafka

Run these commands to start the ZooKeeper and Kafka server. Ensure Kafka is installed and configured before executing.

```bash
./bin/zookeeper-server-start.sh config/zookeeper.properties
./bin/kafka-server-start.sh config/server.properties
```

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

### POST /start

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=resources-process

Starts a BPD instance.

```APIDOC
## POST /start

### Description
Use this method to start a BPD instance.

### Method
POST

### Endpoint
/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None specified in the source text.

### Request Example
None specified in the source text.

### Response
#### Success Response (200)
Details not specified in the source text.

#### Response Example
None specified in the source text.
```

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

### Example Rollback Command

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=fixes-rolling-back-fix-packs-silently

An example of the rollback command with specific values for offering ID, installation directory, and log file.

```bash
C:\Program Files\IBM\Installation Manager\eclipse\tools>imcl rollback com.ibm.bpm.EXP.v85_8.5.0.20130504_0134 -installationDirectory C:\IBM\BPM\v8.5 -log silent_rollback.txt
```

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

### Start document store migration using wsadmin

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=store-migrating-document-attachments-bpm-document

Use the `startDocumentStoreMigration` command with the `wsadmin` scripting client to initiate the migration of documents. Ensure you are connected to the deployment manager and have operator privileges.

```jython
AdminTask.startDocumentStoreMigration(appName, options)
```

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

### Identify Installation Manager Log Error

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

Example of the XML-formatted error message found in the Installation Manager log when a DB2 installation fails due to invalid command line arguments.

```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->9.7.3000</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>
```

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

### Example URL with Required Filters

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=pqto-get-1

This example demonstrates how to construct a URL for a performance query using both 'bpd' and 'snapshot' filters.

```text
...v1/performance/query?filter=bpd|<my-bpd-id>&filter=snapshot|<my-shapshot-id>
```

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

### Start Applications on Server

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=manager-configuring-ant-script

Starts installed applications on the WebSphere server. Requires application name, server, node, and user credentials.

```xml
<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}" />
```

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

### Start WebSphere Application Server

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=system-restarting-components-in-single-server-environment

Run the start script from the profile bin directory to initialize the application server.

```bash
./startServer.sh server1
```

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

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

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=pa-get-1

Retrieves the 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

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
A list of process applications.
- **processAppsList** (array) - Contains a list of installed process applications.
  - **shortName** (string) - The ProcessApp short name.
  - **name** (string) - The ProcessApp name.
  - **installedSnapshots** (array) - The list of installed snapshots associated with this ProcessApp.

#### Response Example
```json
{
  "processAppsList": [
    {
      "shortName": "ExampleApp1",
      "name": "Example Process Application 1",
      "installedSnapshots": []
    },
    {
      "shortName": "ExampleApp2",
      "name": "Example Process Application 2",
      "installedSnapshots": []
    }
  ]
}
```

### Error Response
Detailed error information.
- **errorNumber** (string) - Message ID of the exception.
- **errorMessage** (string) - Message text of the exception.
- **errorMessageParameters** (array[string], optional) - Message text parameters of the exception.
- **programmersDetails** (object, optional) - Additional, exception details, for example, a stack trace.

#### Error Response Example
```json
{
  "errorNumber": "BPM0001",
  "errorMessage": "An unexpected error occurred.",
  "errorMessageParameters": [],
  "programmersDetails": {}
}
```

### Status Codes
- **200 OK**: Success completion.
- **400 Bad Request**: The parameters are not valid or they are missing.
- **401 Unauthorized**: The caller is not authorized for this request.
- **406 Not Acceptable**: The requested content type or content encoding is not supported.
- **500 Internal Server Error**: A severe problem has occurred. Programmer's details are provided.
```

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

### Example: Delete Specific Process Instances

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=objects-deleting-bpel-process-instances

Example command to delete finished process instances on a specific cluster started by a specific user.

```shell
wsadmin.sh -f deleteCompletedProcessInstances.py 
        -cluster myCluster 
        -finished
        -startedBy Anita
```

```shell
wsadmin -f deleteCompletedProcessInstances.py 
        -cluster myCluster 
        -finished
        -startedBy Anita
```

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

### Example Output of BPMCreateRemoteMigrationUtilities

Source: https://www.ibm.com/docs/en/baw/25.0.x?topic=windows-copying-migration-utilities-source-computer

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

```text
C:\BPM25.x\bin>BPMCreateRemoteMigrationUtilities.bat C:\MigrationUtility.zip 
Buildfile: C:\BPM\util\migration\scripts\createMigrationUtilDisk.ant
create_zip_image:
      [zip] Building zip: C:\MigrationUtility.zip

BUILD SUCCESSFUL
Total time: 41 seconds
```
Tokens:
Raw