IBM Business Automation Workflow

https://www.ibm.com/docs/en/baw/26.0.x
Admin
IBM Business Automation Workflow is an enterprise automation platform that combines business process...
Tokens:6,540,512
Snippets:51,702
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Example: Enable automatic starting on source environment (Unix)

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmmanageapplications

Example command for Unix systems that enables automatic starting on the source environment using a properties file. The path is an example; adjust to your environment.

```shell
./BPMManageApplications.sh -autoStart true -source -propertiesFile /opt/BPM26.x/util/migration/resources/source_migration.properties
```

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

### Example: Starting an application

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=scripts-managetemplatespy

Illustrates how to start the process and task templates that belong to the application, application_name.

```text
application_name
application_name
```

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

### Example imcl install command with actual values

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

Example of the imcl install command with actual values. This shows the command run from the Installation Manager's eclipse/tools directory on Windows.

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

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

### Quick start server.xml configuration with Derby database

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

Example server.xml configuration for a quick start setup using Derby database. Sets OIDC JWT keystore variables, db.type to derby, and OAuth datasource variables. Replace adminUser, password, and keystorePassword with actual values.

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

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

### Get start activities for a process template

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=sbp-running-microflow-that-contains-non-unique-starting-service

Determines the starting service to be called by getting the start activities for the first template found in the previous query. The example uses the first template that is found.

```java
ProcessTemplateData template = processTemplates[0];
ActivityServiceTemplateData[] startActivities = 
        process.getStartActivities(template.getID());
```

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

### Start deployment environment with configuration properties file

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

Run BPMConfig with the -start parameter and a configuration properties file. Use the Windows path on Windows and the .sh path on Linux/Unix.

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

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

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

### getBlackoutDateStart example

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

Gets the disabled start date.

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

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

### On load event: set start date

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

Example for the On load event handler. Gets the current date from the StartDate control and sets it as the start date.

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

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

### Start Machine Learning Server with acceptLicense and init

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=server-installing-business-automation-machine-learning

Run the start script with --acceptLicense. Add --init on first start to check for missing .env values and be prompted to enter them.

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

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

### Example success response for Applications GET API

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

Shows the XML response returned by the Applications GET API when the request succeeds. The response includes a list of process applications with their IDs, names, and installed snapshots.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data">
    <status>200</status>
    <data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sys="http://rest.bpm.ibm.com/v1/data/system" xsi:type="sys:ProcessApps">
        <processAppsList>
	    <ID>2066.23d3ecec-6fdb-4033-9c57-e931aa13761f</ID>
	    <shortName>TWP</shortName>
	    <name>Process Portal</name>
	    <description></description>
	    <defaultVersion>Main</defaultVersion>
	    <installedSnapshots>
		<name>7.5.0</name>
		<acronym>7.5.0</acronym>
		<ID>2064.64bbda3f-b456-486a-9679-87d81c4366dd</ID>
		<active>true</active>
		<activeSince>2011-04-26T18:49:13Z</activeSince>
	    </installedSnapshots>
	</processAppsList>
	<processAppsList>
	    <ID>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</ID>
	    <shortName>HSS</shortName>
	    <name>Hiring Sample</name>
	    <description>Hiring Sample</description>
	    <defaultVersion>Main</defaultVersion>
	    <installedSnapshots>
		<name>Hiring Sample 3</name>
		<acronym>HS3</acronym>
		<ID>2064.30c63e29-aacd-4b3b-803f-a09ce65486d2</ID>
		<active>true</active>
		<activeSince>2011-04-26T18:50:06Z</activeSince>
	    </installedSnapshots>
	</processAppsList>
    </data>
</bpm:ResponseData>
```

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

### Example startDocumentStoreMigration CLI execution

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

A concrete example of executing the migration command from a Windows directory.

```bash
C:\8500PC\STANDARD\deploy2\AppServer\profiles\DmgrProfile\bin>wsadmin -user tw_admin -password tw_admin -lang jython -c "print AdminTask.startDocumentStoreMigration('[-deName De1]')"
```

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

### Install cert-manager and license-manager with setup_singleton.sh

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

Runs the setup script to install the cert-manager and license-manager services. Requires accepting the license and enabling licensing.

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

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

### Download CASE files with oc ibm-pak get

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=deployment-downloading-case-files-cert-kubernetes-baw

Run this command to start the download of the CASE files. The <absolute path to file> must be a path that starts from '/', for example '/opt'. By default, the root directory used by the ibm-pak plug-in is $IBMPAK_HOME/.ibm-pak, so the CASE is downloaded to $IBMPAK_HOME/.ibm-pak/data/cases/$CASE_NAME/$CASE_VERSION.

```bash
oc ibm-pak get -c file://<absolute path to file>/cert-kubernetes-baw/scripts/airgap/baw-case-to-be-mirrored-26.0.0.txt
```

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

### Example success message after interim fix installation

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

Example of the command line message shown after a successful interim fix installation. The installation log specified by the -log parameter contains no error messages if the installation is successful.

```text
Installed 8.5.5.0-WS-BPMADVWESB-IFJR39658_0.0.0.20130525_1047 to the C:\IBM\BPM directory.
```

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

### JConsole launch example

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=mbeans-using-jconsole-access

Example command showing actual paths and truststore settings for launching JConsole. Replace the password with your own.

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

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

### Example: list all versions of myApp with instance counts

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=scripts-listtemplatespy

Example commands to list all versions of the application myApp deployed on cluster myCluster, including instance counts. The first uses wsadmin.sh (Unix) and the second uses wsadmin (Windows).

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

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

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

### Get start activities with getStartActivities

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=sbp-starting-long-running-process-that-contains-non-unique-starting-service

Gets the starting activities for a process template using its PTID. The result is an array of ActivityServiceTemplateData objects.

```java
Entity entity = (Entity) result.getEntities().get(0);
PTID ptid = (PTID) entity.getAttributeValue("PTID");
ActivityServiceTemplateData[] startActivities = process.getStartActivities(ptid);
```

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

### BPMEnablePostInstaller -iFix example

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmenablepostinstaller

Runs the post-installation scripts for all recently installed fixes. This is the required parameter without fix names.

```shell
BPMEnablePostInstaller -iFix
```

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

### startDocumentStoreMigration command with parameters

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

Syntax for specifying other parameters to startDocumentStoreMigration using wsadmin. Example shows Windows path and credentials.

```jython
profile_root\bin\wsadmin -user my_user_name -password my_password -lang jython -c "print AdminTask.startDocumentStoreMigration('[-deName myDeName]')"
```

```jython
C:\8500PC\STANDARD\deploy2\AppServer\profiles\DmgrProfile\bin>wsadmin -user tw_admin -password tw_admin -lang jython -c "print AdminTask.startDocumentStoreMigration('[-deName De1]')"
```

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

### Example: Disable automatic starting on target environment (Windows)

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmmanageapplications

Example command for Windows systems that disables automatic starting on the target environment using a properties file. The path is an example; adjust to your environment.

```batch
BPMManageApplications.bat -autoStart false -target -propertiesFile "E:\Upgrade Utilities\util\migration\resources\target_migration.properties"
```

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

### GET method response example

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=cnar-get-method

Shows a 200 OK response containing the launch step information required to add a user-created activity. The response includes attachments, system properties, workflow groups, data fields, and step processor details.

```json
HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
{
  "attachments": {},
  "systemProperties":
  {
    "responses": ["yes", "no"],
    "mapName": "Workflow",
    "stepId": 0,
    "stepName": "LaunchStep",
    "caseFolderId": "{8CA37883-9BA1-4513-AF94-120EA4255A2B}",
    "workflowName": "ETE_ETECase3_ETECase3Task1",
    "selectedResponse": "",
    "workObjectNumber": "D931E58C31E1DE44BDF519E88565614F",
    "subject": "ETE_ETECase3_ETECase3Task1",
    "authoredMapName": "Workflow",
    "instruction": ""
  },
  "workflowGroups":
  {
    "F_Trackers":
    {
      "value" : [],
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 64,
      "name": "F_Trackers",
      "isArray": true
    }
  },
  "dataFields":
  {
    "ETEProperty1":
    {
      "value": true,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 4,
      "name": "ETEProperty1",
      "isArray": false
    },
    "ETEProperty2":
    {
      "value": 163,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 1,
      "name": "ETEProperty2",
      "isArray":false
    },
    "ETEProperty3":
    {
      "value": "TestStringChoice1",
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 2,
      "name": "ETEProperty3",
      "isArray": false
    },
    "ETEProperty4":
    {
      "value": 3.1415926535,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 8,
      "name": "ETEProperty4",
      "isArray": false
    },
    "ETEProperty5":
    {
      "value": "2010-07-05T19:21:24Z",
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 16,
      "name": "ETEProperty5",
      "isArray":false
    }
  },
  "stepProcessor":
  {
    "width":800,
    "height":600,
    "applicationName":"",
    "appType":32,
    "id":455,
    "name":"ETE_LaunchPage",
    "processorType":4,
    "locations":{"8":"123456"}
  }
}

```

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

### Example: deploy query table with manageQueryTable.py

Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=tables-deploying-composite-supplemental-query

Example command to deploy a query table definition file. Replace myCluster and sample.qtd with your cluster name and file path.

```shell
wsadmin.sh -f manageQueryTable.py -cluster myCluster -deploy sample.qtd

```

```shell
wsadmin -f manageQueryTable.py -cluster myCluster -deploy sample.qtd

```
Tokens:
Raw