### 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
```
--------------------------------
### Example: imcl install for IBM Business Automation Workflow on Windows
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=fixes-installing-fix-packs-silently
This example updates IBM Business Automation Workflow on Windows. It installs the specified package IDs and uses the -acceptLicense flag. The command includes the installation directory and repositories.
```shell
imcl install com.ibm.bpm.ADV.v85 com.ibm.websphere.ND.v85 -acceptLicense -installationDirectory C:\IBM\BPM -repositories D:\temp\BPM856\repository,D:\temp\WAS8552\repository showVerboseProgress -log silentinstall.log
```
--------------------------------
### 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
```
--------------------------------
### Example imcl install command for Linux
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=server-installing-silently-by-using-command-line
This example installs IBM Process Federation Server, WebSphere Application Server Liberty Network Deployment, and IBM SDK Java Technology Edition Version 8.0 for Liberty on Linux. It uses the -acceptLicense flag and specifies the installation directory and repository.
```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
```
--------------------------------
### Start the deployment manager (startManager.bat)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=candp-federating-nodes-deployment-manager-2
Starts the deployment manager from its Quick Start console or command line. Replace profile_root with the installation location of the deployment manager profile.
```batch
profile_root\bin\startManager.bat
```
--------------------------------
### Start Kafka locally with zookeeper-server-start.sh and kafka-server-start.sh
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=configuration-configuring-event-output-kafka
Starts the Kafka Zookeeper and server processes locally. Run these commands in the Kafka installation directory after downloading and installing the Kafka binary files.
```shell
./bin/zookeeper-server-start.sh config/zookeeper.properties
./bin/kafka-server-start.sh config/server.properties
```
--------------------------------
### Ant target deploy: install and start applications
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=files-example-ant-script
Installs the generated EAR files on the server using wsInstallApp and then explicitly starts each application with wsStartApplication. Depends on the generateEAR target. The applications are named by appending "App" to the module names.
```xml
```
--------------------------------
### BPMQueryDeploymentConfiguration example for Windows
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmquerydeploymentconfiguration
Example command for Windows systems that extracts the deployment configuration for profile1 in the BPM620 source installation root directory to c:\MigrationSnapshots\ProcServer620\profiles\profile1.
```batch
BPMQueryDeploymentConfiguration.bat "C:\Program Files\IBM\WebSphere\ProcServer620" profile1 c:\MigrationSnapshots\ProcServer620
```
--------------------------------
### BPMQueryDeploymentConfiguration example for Unix
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmquerydeploymentconfiguration
Example command for Unix systems that extracts the deployment configuration for profile1 in the BPM620 source installation root directory to /MigrationSnapshots/ProcServer620/profiles/profile1.
```bash
BPMQueryDeploymentConfiguration.sh /opt/ibm/WebSphere/ProcServer620 profile1 /MigrationSnapshots/ProcServer620
```
--------------------------------
### Start server with script for signal capture (Windows)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=tips-capturing-javacore
On Windows, a launch script must be used to start the server process to allow a signal to be passed. This requires special setup before starting the server. The server process will start in a command window; check logs to verify successful start since the intermediate JVM process is not used.
```shell
\bin\startServer.bat server1 -script SERVER1.bat
```
```shell
SERVER1.bat
```
--------------------------------
### Start Profile Management Tool from command line
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=cadmp-augmenting-deployment-manager-profiles-using-profile-management-tool-1
Command to start the Profile Management Tool from the command line. Replace installation_root with the actual installation directory.
```plaintext
installation_root\bin\ProfileManagement\pmt.bat
```
--------------------------------
### 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();
```
--------------------------------
### 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
```
--------------------------------
### 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);
```
--------------------------------
### 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
200
2066.23d3ecec-6fdb-4033-9c57-e931aa13761f
TWP
Process Portal
Main
7.5.0
7.5.0
2064.64bbda3f-b456-486a-9679-87d81c4366dd
true
2011-04-26T18:49:13Z
2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0
HSS
Hiring Sample
Hiring Sample
Main
Hiring Sample 3
HS3
2064.30c63e29-aacd-4b3b-803f-a09ce65486d2
true
2011-04-26T18:50:06Z
```
--------------------------------
### 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]')"
```
--------------------------------
### Response from install request
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=installing-offline-server-by-calling-rest-apis
This is a sample response from the install request, showing the state and result of the operation.
```json
{"state":"success","result":{"container":"PA1","server":"OffLn1","version":"SN03"},"last_modified":"2022-01-18T22:11:25.367Z"}
```
--------------------------------
### 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 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:///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
```
--------------------------------
### 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);
```
--------------------------------
### 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
```
--------------------------------
### 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
```
--------------------------------
### 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"
```
--------------------------------
### 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 imcl uninstall command with actual values
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=fixes-uninstalling-interim-silently
Shows a complete example of the uninstall command with a specific fix ID, installation directory, and log file name. This example is run from the Installation Manager tools directory.
```shell
C:\Program Files\IBM\Installation Manager\eclipse\tools>imcl uninstall 8.5.5.0-WS-BPMADVWESB-IFJR39658 -installationDirectory C:\IBM\BPM -log logfix.txt
```
--------------------------------
### 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
```
--------------------------------
### JSON response example for GET tasks
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=tasks-get
Example JSON response content for the GET method. Shows a list of tasks with fields like activationTime, dueTime, state, and assignedTo.
```json
{
"status": "200",
"data": {"tasks": [ {
"activationTime": "2014-02-05T11:56:08Z",
"atRiskTime": "2014-02-05T12:50:08Z",
"clientTypes": ["IBM_WLE_Coach"],
"completionTime": null,
"containmentContextID": "53",
"description": "",
"displayName": "Step: AdHocActivity 1",
"dueTime": "2014-02-05T12:56:08Z",
"isAtRisk": false,
"kind": "KIND_PARTICIPATING",
"lastModificationTime": "2014-02-05T11:56:08Z",
"name": "AdHocActivity 1",
"originator": "tw_admin",
"owner": null,
"priority": 30,
"startTime": "2014-02-05T11:56:08Z",
"state": "STATE_READY",
"tkiid": "53",
"piid": "53",
"processInstanceName": "DemoCaseType:53",
"status": "Received",
"priorityName": "Normal",
"assignedTo": "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.ae125e04-9c2a-43aa-80ed-ed8c53798a94",
"assignedToDisplayName": "All Users",
"assignedToType": "group",
"data": {"variables": {"variable1": null}},
"processData": {"businessData": []},
"serviceID": "1.c8d7cf04-ec94-43f8-aa57-d183e1c49503",
"flowObjectID": "ed6633a1-ed57-4cd7-8ab4-5b4bd04dc950",
"nextTaskId": null,
"collaboration": {
"status": false,
"currentUsers": []
}
}]}
}
```
--------------------------------
### Install with imcl command line
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=ibaw-installing-silently-using-command-line
Installs the product with Installation Manager. Requires accepting licenses via -acceptLicense. Run as administrator on Windows. Use the package IDs and features from the table, specifying features with syntax packageID,feature,feature. Keep installation path short to avoid 255-character path limit issues.
```text
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 SLA Get Response (JSON)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=sla-get
Example response for a successful SLA get request, showing status 200 and the SLA data structure with trigger, conditions, and consequence.
```json
{
"status":"200",
"data":{
"slaId":"47.557b57e7-d7b3-41be-bd4b-c707d93467c3",
"name":"SLA1",
"desc":"",
"trigger":{
"percent":10,
"timeUnit":{
"unitType":"MONTHS",
"rollingTime":true,
"timeCount":4
},
"occurrenceType":"VIOLATED_PERCENT_OF_TIME_OVER_PERIOD"
},
"conditions":[{
"scope":"SumOfValuesOverTime",
"kpi":{
"kpiId":"49.67cbb213-0032-4f14-be44-7e9c7a1a146f",
"kpiName":"Total Time (Clock)",
"snapshotId":"2064.74f9ea10-a351-4c42-ada5-b3dce7145330",
"branchId":null
},
"kpiUnit":"TIME",
"trueOrfalse":true,
"activities":[],
"startTime":{
"unitType":"DAYS",
"rollingTime":true,
"timeCount":1
},
"relation":"EqualTo",
"compareTarget":{
"percent":102,
"type":"PercentAboveThreshold",
"thresholdType":"MaximumThresholdValue"
}
}
],
"consequence":{
"fireBPD":false,
"sendEmail":false,
"emailAddress":""
}
}
}
```
--------------------------------
### BPMEnablePostInstaller.sh -ifix example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmenablepostinstaller
Runs the post-installation scripts for a specific fix, identified by its interim fix name. The fix name is provided as a comma-separated list.
```shell
BPMEnablePostInstaller.sh -ifix 8.6.10019001-WS-BPM-IFJR00000
```
--------------------------------
### setStart(start) example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=api-datetime-picker
Sets the available start date programmatically. Dates prior to the specified start date are disallowed.
```javascript
me.setStart(date);
```
```javascript
me.setStart(new Date("06/01/2015"));
```
--------------------------------
### Example for a network deployment environment
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=scripting-bpmupdatesystemapp
Commands to start wsadmin in disconnected mode and invoke AdminTask.BPMUpdateSystemApp with the updated system toolkit file and cluster name.
```jython
wsadmin -lang jython -conntype none -javaoption -Xms256m -javaoption -Xmx1024m
wsadmin>AdminTask.BPMUpdateSystemApp( [ '-twxFile', 'install_root/BPM/Lombardi/imports/system-toolkit.twx', '-clusterName', 'PC_clusterName' ] )
```
--------------------------------
### BPMConfig -start: Start deployment environment (two forms)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmconfig-command-line-utility
Starts a deployment environment, either by specifying profile and deployment environment name or using a properties file. The two commands are interchangeable alternatives.
```text
BPMConfig -start -profile DmgrProfile -de De1
```
```text
BPMConfig -start myenvironment.properties
```
--------------------------------
### Retrieve column display names from query result set
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=method-query-results
Shows how to get the display names of the result set columns. These names are either the column names of the view or the name defined by the AS clause in the query. In this example, the display names are STARTED, NAME, WIID, and REASON.
```java
resultSet.getColumnDisplayName(1) returns "STARTED"
resultSet.getColumnDisplayName(2) returns "NAME"
resultSet.getColumnDisplayName(3) returns "WIID"
resultSet.getColumnDisplayName(4) returns "REASON"
```
--------------------------------
### Example response for GET managedGlobalTeams
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=mr-get
Example response content for the GET /rest/bpm/wle/v1/managedGlobalTeams method. Shows a status of 200 and a list of three teams with their IDs, names, descriptions, and process application details.
```json
{
"status":"200",
"data":{
"teams":[
{
"teamId":"24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
"teamName":"Human Resources",
"teamDescription": "People in the human resources department.",
"processAppName":"Hiring Sample",
"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
},
{
"teamId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
"teamName":"GeneralManagers",
"teamDescription": "People who have authority to approve new positions.",
"processAppName":"Hiring Sample",
"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
},
{
"teamId":"24.cd97937f-06ab-43cc-8067-17dea489fdb3",
"teamName":"HiringManagers",
"teamDescription": "People who have a department that needs a new position or have an existing position that needs to be filled.",
"processAppName":"Hiring Sample",
"processAppId":"2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0"
}
]
}
}
```
--------------------------------
### Run install with post-install_64.xml for existing installation
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=configuration-launching-installation-manager-directly-64-bit-systems
Use this command when Installation Manager is already installed. It launches Installation Manager with the correct products preselected.
```shell
install -input post-install_64.xml
```
--------------------------------
### GET method: example parameters for filtering by object and event types
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=chr-get-method
Shows how to combine ObjectTypes and EventTypes in the GET request to return only additions of documents and folders. This is an example URL parameter string.
```text
&ObjectTypes=Document+CmAcmCaseFolder+CmAcmCaseSubfolder&EventTypes=Creation
```
--------------------------------
### Example listTemplates.py command (Unix)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=administration-listing-information-about-process-task-templates
Example that lists all versions of application myApp on cluster myCluster, including instance counts. Uses the wsadmin.sh Unix variant.
```shell
wsadmin.sh -f listTemplates.py -cluster myCluster -application myApp -all -countInstances
```
--------------------------------
### Example JSON Response for GET Process Apps
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=applications-get
Example JSON response content for the GET method. Shows a status of 200 and a data object containing a list of 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"
}
]
}
}
```
--------------------------------
### Example listTemplates.py command (Windows)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=administration-listing-information-about-process-task-templates
Example that lists all versions of application myApp on cluster myCluster, including instance counts. Uses the wsadmin Windows variant.
```shell
wsadmin -f listTemplates.py -cluster myCluster -application myApp -all -countInstances
```
--------------------------------
### Run install with install_64.xml for fresh installation
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=configuration-launching-installation-manager-directly-64-bit-systems
Use this command when Installation Manager is not yet installed. It launches Installation Manager with the correct products preselected.
```shell
install -input install_64.xml
```
--------------------------------
### Java: Example8 change default business rule and publish
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=examples-example-8-change-default-business-rule-business-rule-group
Code excerpt from the example showing the setup, retrieval, modification, and publication. It retrieves the business rule group 'DiscountRules', gets the operation 'calculateShippingDiscount', finds an alternative available target, sets it as the default, publishes, and verifies.
```java
package com.ibm.websphere.sample.brules.mgmt;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import com.ibm.wbiserver.brules.mgmt.BusinessRule;
import com.ibm.wbiserver.brules.mgmt.BusinessRuleGroup;
import com.ibm.wbiserver.brules.mgmt.BusinessRuleManagementException;
import com.ibm.wbiserver.brules.mgmt.BusinessRuleManager;
import com.ibm.wbiserver.brules.mgmt.Operation;
import com.ibm.wbiserver.brules.mgmt.query.QueryOperator;
public class Example8
{
static Formatter out = new Formatter();
static public String executeExample8()
{
try
{
out.clear();
// Retrieve a business rule group by target namespace and name
List brgList = BusinessRuleManager
.getBRGsByTNSAndName(
"http://BRSamples/com/ibm/websphere
/sample/brules",
QueryOperator.EQUAL,
"DiscountRules",
QueryOperator.EQUAL, 0, 0);
if (brgList.size() > 0)
{
out.printlnBold("Business Rule Group before publish:");
// Get the first business rule group from the list
// This should be the only business rule group in the list as
// the combination of target namespace and name are unique
BusinessRuleGroup brg = brgList.get(0);
out.print("Business Rule Group: ");
out.println(brg.getName());
// Get the operation of the business rule group that
// will have its default business rule updated
Operation op =
brg.getOperation("calculateShippingDiscount");
```
--------------------------------
### JSON example response for GET group
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=g-get-2
Example JSON response body for a successful GET request. Shows status 200 and group details including groupID, groupName, displayName, description, members, and managerGroupName.
```json
{
"status":"200",
"data":{
"groupID":3,
"groupName":"tw_admins",
"displayName":"tw_admins",
"description":"Group for people with full access to Teamworks.",
"members":[
"tw_admin"
],
"managerGroupName": "mTeam_T_8d643861-ec74-4877-a18b-0728ad57033e.e0b4a6b9-12eb-4565-8857-831847d11ad9"
}
}
```
--------------------------------
### Install product with imcl
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=workflow-installing-silently-using-command-line
Use this command to install the product. Replace the placeholder values with your actual package IDs, installation location, repository, and properties. The -acceptLicense flag acknowledges acceptance of all licenses.
```text
extract_directory/IM64/tools/imcl install list_of_package_IDs -acceptLicense -installationDirectory location -repositories repository -properties key=value,key=value -showVerboseProgress -log logName.log
```
--------------------------------
### Get installation plans
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=deployment-optional-mirroring-installing-your-own-curated-catalog
Checks for installation plans that are waiting for approval, especially when subscriptions are set to manual.
```bash
oc get installPlan
```
--------------------------------
### Start deployment manager
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=candpd-federating-nodes-deployment-manager-deprecated-1
Starts the deployment manager from its bin directory. Use this command when the deployment manager is not running before federating a node.
```shell
profile_root/bin/startManager.sh
```
--------------------------------
### Get start date of DatePicker calendar
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=api-date-picker-deprecated
Returns the currently set start date of the calendar, if available.
```javascript
me.getStart();
```
--------------------------------
### BPMConfig migration command example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=windows-migrating-configuration-from-source-environment
An example of the BPMConfig command used to migrate a deployment environment from a source installation.
```batch
BPMConfig.bat -migrate -wasHome E:\IBM\BPM751Std -profile Dmgr01 -de PSDE -outputDir C:\751configuration
```
--------------------------------
### BPMExtractSourceInformation example (Unix paths)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmextractsourceinformation
Example command for a Unix-like environment. The -backupFolder parameter is set to /tmp/snapshot and the -propertiesFile parameter points to the source migration properties file.
```plaintext
BPMExtractSourceInformation -backupFolder /tmp/snapshot -propertiesFile /opt/BPM26.x/util/migration/resources/source_migration.properties
```
--------------------------------
### Example Response Data for Task Start
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=ta-get
Shows an example of the response data returned by a task start operation. The response includes a status of 200 and a data element of type TaskActions, listing task identifiers and available actions.
```xml
200
tkiid
53
ACTION_GETTASK
ACTION_GETUISETTINGS
ACTION_CREATEMESSAGE
56
ACTION_GETTASK
ACTION_GETUISETTINGS
ACTION_CREATEMESSAGE
57
ACTION_GETTASK
ACTION_GETUISETTINGS
ACTION_CREATEMESSAGE
```
--------------------------------
### Start web application server with startServer.sh
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=system-restarting-components-in-single-server-environment
Command to start the web application server (server1) from the profile_root/bin directory.
```bash
./startServer.sh server1
```
--------------------------------
### Install a snapshot with BPMInstall command
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=server-using-wsadmin-commands
Runs the BPMInstall command in the profile_root/bin directory to install a snapshot. The example uses containerAcronym HSS, containerSnapshotAcronym SHSV856, containerTrackAcronym Main, serverName ProcessServer01, and skipGovernance false. If the process application is already installed, running instances are given the Leave migration option.
```wsadmin
AdminTask.BPMInstall('[-containerAcronym HSS -containerSnapshotAcronym SHSV856 -containerTrackAcronym Main -serverName ProcessServer01 -skipGovernance false]')
```
--------------------------------
### Example: createWXSDefinition with security
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=scripting-createwxsdefinition
Example invocation of createWXSDefinition with all parameters, including security settings.
```unknown
`AdminTask.createWXSDefinition('[-name mydefName -description "my description"
-catalogServiceEndpoints localhost:2089 -gridName Mygrid -securityEnabled true -credentialGenerator UserPassword -authAlias NEW_AUTH_ALIAS]') `
```
--------------------------------
### Example fields parameter
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=instance-get-getdata
Example of the fields parameter in a GET request to retrieve specific variables: orderNumber, customerNumber, and customerName.
```http
..../v1/task/?action=getData&fields=orderNumber,customerNumber,customerName
```
--------------------------------
### getItemAt method example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=api-breadcrumbs
Gets the item at a specified index from the breadcrumbs control. The example retrieves the name of the first item.
```javascript
var breadcrumb = page.ui.get("breadcrumbs1"); var name = breadcrumb.getItemAt(0).name; //returns the name of the first item in the breadcrumbs control
```
--------------------------------
### setBlackoutDateStart(date) example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=api-datetime-picker
Blocks out dates starting from and including the specified date. The date parameter is a {date} object; dates after the start date, including the start date, are blocked.
```javascript
me.setBlackoutDateStart(date);
```
```javascript
me.setBlackoutDateStart(new Date("01/01/2018"));
```
```javascript
me.setBlackoutDateStart();
```
--------------------------------
### BPMExtractSourceInformation example (Windows paths)
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmextractsourceinformation
Example command for a Windows environment. The -backupFolder parameter is set to c:\snapshot and the -propertiesFile parameter points to the source migration properties file, with the path quoted because it contains spaces.
```plaintext
BPMExtractSourceInformation -backupFolder c:\snapshot -propertiesFile "C:\BPM 26.x\util\migration\resources\source_migration.properties"
```
--------------------------------
### getBPMProperty Jython example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=scripting-getbpmproperty
Use this Jython example to get the value of a custom property from the configuration repository. The example includes variable values and is not meant to be reused as a snippet of code.
```jython
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.getBPMProperty(['-de', 'De1', '-name', 'ProcessServer.TimerCoachViewEnabled'])
```
--------------------------------
### getBlackoutDates example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=api-datetime-picker
Gets the list of disabled dates.
```javascript
me.getBlackoutDates();
```
--------------------------------
### Example command to generate input file for listing properties
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=features-creating-list-object-store-properties-document-classes
Example command that creates the input file at C:\propertylist\propertylist.txt. The file is created after running this command.
```shell
configmgr_cl generate_input_sa -operation list
-file "C:\propertylist\propertylist.txt"
```
--------------------------------
### getBlackoutDateEnd example
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=api-datetime-picker
Gets the disabled end date.
```javascript
me.getBlackoutDateEnd();
```
--------------------------------
### BPMConfig start command
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-bpmconfig-command-line-utility
Starts the deployment environment. Must be run on the deployment manager machine after manual startup of remote node agents. Starts deployment manager, local node agents, and cluster members. Can omit -de if only one deployment environment exists. Command may return before all servers are started; verify in Process Admin.
```text
-start [-profile profile_name [-de DE_name] | properties_file
```
--------------------------------
### Example response for application/json
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=pas-get
Example content showing a sample response with project defaults, project dependencies, and environment variables.
```json
{
"status":"200",
"data":{
"projDefaults":{
"projectDefaultsId":"63.4f12afdb-4ee4-4e74-b053-305c70e3a7b2",
"defaultXsl":"CoachDesigner.xsl",
"defaultXslRef":"7692552a-ea18-49ce-bd93-a1dd62100cd9/61.140920b1-a53c-4d72-b6bb-60776f49f7f2",
"name":"Process App Settings",
"acronym":"HSS",
"isIidOptimized":false
},
"projDeps":[{
"projectId":"2066.1b351583-e5cb-43b7-baee-340a63130ea7",
"projectName":"System Data",
"snapshotId":"2064.74f9ea10-a351-4c42-ada5-b3dce7145330",
"snapshotName":"7.5.1"
},
{
"projectId":"2066.03167964-4fe5-4611-8ae7-a71c2a4eb9e0",
"projectName":"TestToolkit1",
"snapshotId":"2064.3adf10fe-7947-43b6-8c96-d0c019b80008",
"snapshotName":"v1"
}
],
"envVars":[{
"name":"var1Key",
"varDefaults":[{
"type":"development",
"value":"var1Development"
},
{
"type":"test",
"value":"var1Test"
},
{
"type":"staging",
"value":"var1Staging"
},
{
"type":"production",
"value":"var1Production"
}
],
"default":"var1Default"
},
{
"name":"var2Key",
"varDefaults":[{
"type":"development",
"value":"var2Development"
},
{
"type":"test",
"value":"var2Test"
}
],
"default":"var2Default"
},
{
"name":"",
"default":""
}
]
}
}
```
--------------------------------
### DBUpgrade migration example from IBM BPM Advanced
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=utilities-dbupgrade
Example command for migrating from IBM BPM Advanced, using -propertiesFile and -backupFolder parameters.
```shell
install_root/bin/DBUpgrade.sh -propertiesFile /opt/BPM/util/migration/resources/target_migration.properties -backupFolder /tmp/snapshot
```
--------------------------------
### Run start-docker.bat to start the server
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=components-installing-workflow-authoring-assistant-server
Starts the Docker container for the Workflow Authoring Assistant server. Run this script from the installation directory.
```batch
start-docker.bat
```
--------------------------------
### BPMInstallPackage command to install snapshot
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=server-using-wsadmin-commands-custom-installation-packages
Run this command in the profile_root/bin directory to install the snapshot. The command uses inputFile and showSnapshotInfo parameters. Note that BPMInstallOfflinePackage is an alternative that handles only custom installation packages.
```wsadmin
AdminTask.BPMInstallPackage('[-inputFile C:/myProcessApps/SHSV856.zip -showSnapshotInfo true]')
```
--------------------------------
### startDocumentStoreMigration command syntax
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=store-migrating-document-attachments-bpm-document
Returns the command syntax for starting document migration.
```jython
AdminTask.startDocumentStoreMigration('[-deName myDeName]')
```
--------------------------------
### Start server
Source: https://www.ibm.com/docs/en/baw/26.0.x?topic=server-creating-process-federation
Starts the Process Federation Server. Run from the pfs_install_root/bin directory.
```shell
server start server_name
```