### 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();
```
--------------------------------
### 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
```
--------------------------------
### 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
```
--------------------------------
### 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);
```
--------------------------------
### 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
```
--------------------------------
### 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
```
--------------------------------
### 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
```
--------------------------------
### 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}][¶ms={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
```
--------------------------------
### 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
```
--------------------------------
### 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);
```
--------------------------------
### 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
```
--------------------------------
### Install snapshot package
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=server-using-wsadmin-commands-generic-installation-packages
Installs a snapshot package on the Process Server.
```wsadmin
BPMInstallPackage('[-inputFile "C:\SnapS1.zip"]')
```
--------------------------------
### Install GUI libraries on Linux on System z
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=install-preparing-linux-systems-installation
Use the zypper command to install the required 32-bit libraries for the Installation Manager graphical interface.
```bash
zypper install libgtk-2_0-0-32bit
zypper install libgthread-2_0-0-32bit
```
--------------------------------
### Importing Selector Artifacts Example
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripting-importselectorartifactsjacl
Example command to import selector artifacts from a specific ZIP file.
```bash
wsadmin -f importSelectorArtifacts.jacl c:/artifacts/onlineorder.zip admin
```
--------------------------------
### Start an application using manageTemplates.py
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripts-managetemplatespy
Starts the process and task templates associated with the specified application.
```bash
wsadmin -f manageTemplates.py -start application_name
wsadmin.sh -f manageTemplates.py -start application_name
```
--------------------------------
### Start a task
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=calls-rest-api-authorization-task-actions
Starts a task instance.
```APIDOC
## PUT /task/{taskID}
### Description
Start a task.
### Method
PUT
### Endpoint
/task/{taskID}?action={string}
### Parameters
#### Path Parameters
- **taskID** (string) - Required - The ID of the task.
```
--------------------------------
### 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();
```
--------------------------------
### Install application interactively
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=applications-deploying-bpel-process-human-task-interactively
Initiates the interactive installation process for an enterprise archive file.
```wsadmin
$AdminApp installInteractive application.ear
```
--------------------------------
### BPMExtractSourceInformation Usage Examples
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=utilities-bpmextractsourceinformation
Examples of running the utility on Linux and Windows environments.
```bash
BPMExtractSourceInformation -backupFolder /tmp/snapshot -propertiesFile /opt/BPMV8.6.0/util/migration/resources/source_migration.properties
```
```cmd
BPMExtractSourceInformation -backupFolder c:\snapshot -propertiesFile "C:\BPM V8.6.0\util\migration\resources\source_migration.properties"
```
--------------------------------
### 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
```
--------------------------------
### Install process application package in a stand-alone environment
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=utilities-installprocessapppackage
Syntax for running the installation utility in a stand-alone environment.
```shell
installProcessAppPackage.bat
{optional_parameters}
install_package_name
user_name
user_password
```
--------------------------------
### 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.
```
--------------------------------
### 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
```
--------------------------------
### Start clustered environment components
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=windows-migrating-business-space-v620x-data
Commands to start the deployment manager, node, and servers in a clustered environment.
```batch
startManager.bat
startNode.bat
startServer.bat server_name (start all servers on the node in sequence)
```
--------------------------------
### 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();
```
--------------------------------
### Create Repository Tables via wsadmin
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=choreographer-configuring-people-substitution
Use the setupIdMgrPropertyExtensionRepositoryTables task to initialize the database tables for substitution properties.
```tcl
$AdminTask setupIdMgrPropertyExtensionRepositoryTables {
-reportSqlError true
-schemaLocation install_root\etc\wim\setup
-laPropXML install_root\etc\wim\setup\wimlaproperties.xml
-databaseType db2
-dbURL jdbc:DB2://host:port/name
-dbDriver com.ibm.db2.jcc.DB2Driver
-dbAdminId userID
-dbAdminPassword password }
```
```tcl
$AdminTask setupIdMgrPropertyExtensionRepositoryTables {
-reportSqlError true
-schemaLocation install_root/etc/wim/setup
-laPropXML install_root/etc/wim/setup/wimlaproperties.xml
-databaseType db2
-dbURL jdbc:DB2://host:port/name
-dbDriver com.ibm.db2.jcc.DB2Driver
-dbAdminId userID
-dbAdminPassword password }
```
--------------------------------
### 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
Error occurred in phase: {0}
SU: {1} {2}
IU: {3}
Message: {4}
install
com.ibm.ws.db2exp.winia64.core
9.7.3.20111109_0314
db2exp.winia64.exec null->9.7.3000</ag>
Installation of DB2 Express has failed.
Log location: D:\IBM\BPM85\logs\db2install.log
Installation failure reason: Invalid command line argument.
```
--------------------------------
### 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]')
```
--------------------------------
### 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
```
--------------------------------
### BPMMigrate Execution Examples
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=utilities-bpmmigrate
Examples of running the BPMMigrate command on Linux and Windows environments.
```text
BPMMigrate -backupFolder /tmp/snapshot -propertiesFile /opt/BPMV8.6.0/util/migration/resources/target_migration.properties
```
```text
BPMMigrate -backupFolder C:\snapshot -propertiesFile "C:\BPM V8.6.0\util\migration\resources\target_migration.properties"
```
--------------------------------
### 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
```
--------------------------------
### 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"
}
]
}
}
```
--------------------------------
### Start process and task templates
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=abptt-stopping-starting-process-task-templates-using-administrative-scripts
Execute these commands to start all process and task templates within a specified application.
```shell
wsadmin -f manageTemplates.py -start application_name
wsadmin.sh -f manageTemplates.py -start application_name
```
--------------------------------
### 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
```
--------------------------------
### 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
```
--------------------------------
### Install an offline package
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=server-using-wsadmin-commands-custom-installation-packages
Execute this command on the process server to install the snapshot from the provided .zip file.
```wsadmin
AdminTask.BPMInstallPackage('[-inputFile C:/myProcessApps/SHSV856.zip -showSnapshotInfo true]')
```
--------------------------------
### 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
```
--------------------------------
### 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
```
--------------------------------
### Create Database Upgrade Archive
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=utilities-bpmcreatedatabaseupgradeutilities
Examples of executing the utility on Unix-based and Windows systems.
```bash
BPMCreateDatabaseUpgradeUtilities.sh upgradeUtilities.zip /MigrationSnapshots/ProcSrv01
```
```cmd
BPMCreateDatabaseUpgradeUtilities upgradeUtilities.zip c:\MigrationSnapshots\ProcSrv01
```
--------------------------------
### 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
```
--------------------------------
### 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 /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
```
--------------------------------
### 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/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
```
--------------------------------
### GET /rest/bpm/federated/htm/v1/systems
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=deprecated-systems-metadata-task-resources
Retrieves metadata about one or more WebSphere Process Server installations.
```APIDOC
## GET /rest/bpm/federated/htm/v1/systems
### Description
Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
### Method
GET
### Endpoint
/rest/bpm/federated/htm/v1/systems
```
--------------------------------
### 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]
```
--------------------------------
### GET /bpm/apps
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=applications-get
Retrieves a list of all process applications currently installed in the system.
```APIDOC
## GET /bpm/apps
### Description
Retrieves a list of process applications, including their IDs, names, and installed snapshots.
### Method
GET
### Endpoint
/bpm/apps
### Response
#### Success Response (200)
- **processAppsList** (array) - A list of process applications.
- **ID** (string) - The unique identifier of the process application.
- **shortName** (string) - The short name of the application.
- **name** (string) - The display name of the application.
- **installedSnapshots** (array) - List of snapshots installed for this application.
#### Response Example
200
2066.23d3ecec-6fdb-4033-9c57-e931aa13761f
TWP
Process Portal
```
--------------------------------
### GET /v1/globalTeams
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=apis-rest-interface-bpd-related-resources
Retrieve information about teams that have been defined to the IBM BPM installation.
```APIDOC
## GET /v1/globalTeams
### Description
Retrieve information about teams that have been defined to the IBM BPM installation.
### Method
GET
### Endpoint
/v1/globalTeams
### Parameters
#### Query Parameters
- **filter** (string) - Optional
- **size** (integer) - Optional
```
--------------------------------
### Export installation package
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=server-using-wsadmin-commands-generic-installation-packages
Creates an installation package for a specific snapshot on the IBM Process Center server.
```wsadmin
AdminTask.BPMExportInstallPackage('[
-containerAcronym "HSS"
-containerTrackAcronym "Main"
-containerSnapshotAcronym "S1"
-outputFile "C:\SnapS1.zip"]')
```
--------------------------------
### On Load Event Example
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-date-time-picker
Example usage for the On Load event, which triggers when the control is initialized.
```javascript
var workerStart = ${StartDate}.getDate(); me.setStart(workerStart);
```
--------------------------------
### 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
```
--------------------------------
### GET /v1/users
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=apis-rest-interface-bpd-related-resources
Retrieve information about users defined in the IBM BPM installation.
```APIDOC
## GET /v1/users
### Description
Retrieve information about users that have been defined to the IBM BPM installation.
### Method
GET
### Endpoint
/v1/users
### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter criteria.
- **maxresult** (integer) - Optional - Maximum number of results.
- **assignTaskidFilter** (string) - Optional - Filter by assigned task ID.
- **collabTaskidFilter** (string) - Optional - Filter by collaborative task ID.
- **includeTaskExperts** (boolean) - Optional - Include task experts.
- **sort** (boolean) - Optional - Sort results.
- **includeInternalMemberships** (boolean) - Optional - Include internal memberships.
- **namesonly** (boolean) - Optional - Return names only.
- **parts** (string) - Optional - Parts to include.
- **refreshUser** (boolean) - Optional - Refresh user data.
- **includeFilter** (string) - Optional - Include filter.
```
--------------------------------
### GET /v1/systems
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=apis-rest-interface-bpel-related-process-resources
Retrieve metadata about one or more WebSphere Process Server installations.
```APIDOC
## GET /v1/systems
### Description
Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
### Method
GET
### Endpoint
/v1/systems
```
--------------------------------
### Get bound data example
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-ecm-file-revisions
Retrieves the bound data associated with the view.
```javascript
var dec1 = MyDecimal.getData();
```
--------------------------------
### Start wsadmin with LifecycleServices classpath
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=at-setting-monitor-model-lifecycle-step-consistent-state-using-setmodelstep-method
Command to initialize the wsadmin environment with the required lifecycle SPI JAR.
```bash
wsadmin -lang -wsadmin_classpath /plugins/com.ibm.wbimonitor.lifecycle.spi.jar
```
--------------------------------
### Execute BPMStop via wsadmin
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripting-bpmstop
Example of establishing a SOAP connection and executing the BPMStop command using Jython.
```jython
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython
wsadmin>AdminTask.BPMStop('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1]')
```
--------------------------------
### Get folder tree
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=systems-data-mapping-in-enterprise-content-management-operations
Retrieves a tree structure of folders starting from a specified folder.
```APIDOC
## Get folder tree
### Description
Retrieves folder objects contained within the specified folder and its descendants.
### Parameters
- **Folder ID** (ECMID) - Required - A unique identifier of a folder indicating the top level of the tree.
- **Depth** (Integer) - Optional - The number of levels of folders to return. Default is -1 (all descendants).
- **Server name** (String) - Required - The name of the server containing the folder.
### Response
- **Folders** (ECMFolder []) - The folder objects contained within the specified folder and its level of descendants.
```
--------------------------------
### Full 100Custom.xml configuration example
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=events-event-flow
Example of the 100Custom.xml file structure including the common element and the monitor-event-emission property.
```xml
false
```
--------------------------------
### GET /rest/bpm/wle/v1/user/{userNameOrID}
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=resources-user
Retrieve information about a user that has been defined to the IBM BPM installation.
```APIDOC
## GET /rest/bpm/wle/v1/user/{userNameOrID}
### Description
Retrieve information about a user that has been defined to the IBM BPM installation.
### Method
GET
### Endpoint
/rest/bpm/wle/v1/user/{userNameOrID}
### Parameters
#### Path Parameters
- **userNameOrID** (User) - Required - A value representing either the userName or userID of the user. To retrieve details about the current user, specify current.
```
--------------------------------
### Package Process Federation Server installation
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=configuration-creating-master-archive
Use this command in the pfs_install_root/bin directory to create an archive of the server configuration. The --include=all parameter ensures runtime binaries and relevant files are included.
```bash
server package server_name --archive=package_file_name.jar --include=all
```
--------------------------------
### JSON Example Response
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=filter-get
A sample JSON response body returned by the GET request.
```json
{
"status":"200",
"data":{
"exposedItemsList":[
{
"type":"process",
"itemID":"25.8403dd37-e049-46f5-8952-b7a46f0d198f",
"processAppID":"2066.931b0053-02bd-4f47-ac72-4eb527457383",
"snapshotID":"2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"snapshotName":"version 1.0.4",
"display":"HR Open New Position",
"ID":"2015.204",
"startURL":"/rest/bpm/wle/v1/process?action=start&bpdId=25.8403dd37-e049-46f5-8952-b7a46f0d198f&processAppId=2066.931b0053-02bd-4f47-ac72-4eb527457383",
}
]
}
}
```
--------------------------------
### GET /definitions
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=definitions-get
Retrieves a list of alert definitions configured in the IBM BPM installation.
```APIDOC
## GET /definitions
### Description
Retrieves a list of all alert definitions defined in the IBM BPM installation.
### Method
GET
### Endpoint
/definitions
### Response
#### Success Response (200)
- **status** (string) - The HTTP status code.
- **data** (object) - The container for the alert definitions list.
- **definitions** (array) - A list of alert definition objects.
#### Response Example
{
"status": "200",
"data": {
"definitions": [
{
"id": "2040.1006",
"displayName": "Active Instances",
"category": "INSTANCE",
"instanceStatus": "ACTIVE",
"thresholdOperator": "GREATER",
"thresholdValue": "100"
}
]
}
}
```
--------------------------------
### Start wsadmin scripting client
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=installation-customizing-bpm-work-web-server
Initiate the wsadmin tool from the deployment manager profile bin directory using the Jython language.
```jython
wsadmin -conntype none -lang jython
```
--------------------------------
### Accessing the perfDWTool directory
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=mbpdw-using-performance-data-warehouse-command-line-tool-perfdwtool
Example path to the directory containing the perfDWTool executable on a Windows installation.
```text
C:\IBM\WebSphere\AppServer\profiles\Node1Profile\bin
```
--------------------------------
### startUpload()
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-ecm-file-uploader
Starts uploading the document that is currently selected.
```APIDOC
### startUpload()
### Description
Starts uploading the document that is currently selected.
```
--------------------------------
### Service Model Example Response
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=sm-get
A sample JSON response body for a successful GET request.
```json
{
"status":"200",
"data":{
"header":{
"type":"HUMAN",
"name":"Submit Requisition",
"UUID":"guid:23232f55fe1ae6b3:2db5e661:12e6d119f84:-7ed5"
},
"diagram":{
"adhocs":[
"Initialize Output"
],
"step":[
{
"name":"Position type",
"x":429,
"y":167,
"type":"Switch",
"ID":"ProcessItem.7be7fd5e-41ec-4796-81eb-855a633fe9ff"
},
{
"name":"Confirm job position",
"x":571,
"y":219,
"type":"Coach",
"ID":"ProcessItem.374e086a-825f-4271-8a88-de6d3d03e944"
},
{
"name":"Create job requisition",
"x":253,
"y":152,
"type":"Coach",
"ID":"ProcessItem.e73c6fc9-6944-4595-9d53-88fbc1741243"
},
{
"name":"Initialize Output",
"x":112,
"y":152,
"type":"Script",
"ID":"ProcessItem.313f9bd7-b14e-49e7-9868-b9374cb29540"
}
```
--------------------------------
### startUpload()
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-bpm-file-uploader
Starts uploading the document that is currently selected.
```APIDOC
## startUpload()
### Description
Starts uploading the document that is currently selected.
```
--------------------------------
### Install process application package in a network deployment environment
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=utilities-installprocessapppackage
Syntax for running the installation utility in a network deployment environment, requiring host, port, node, and server parameters.
```shell
installProcessAppPackage.bat
{optional_parameters}
-host host_name
-port port_name
-nodeName node_name
-serverName server_name
install_package_name
user_name
user_password
```
--------------------------------
### GET /rest/bpm/wle/v1/group/{groupNameOrID}
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=group-get
Retrieves information about a specific group defined in the IBM BPM installation.
```APIDOC
## GET /rest/bpm/wle/v1/group/{groupNameOrID}
### Description
Retrieve information about a group that has been defined to the IBM BPM installation.
### Method
GET
### Endpoint
/rest/bpm/wle/v1/group/{groupNameOrID}
### Parameters
#### Path Parameters
- **groupNameOrID** (string) - Required - The name or ID of the group to retrieve.
#### Query Parameters
- **parts** (string) - Optional - A string indicating which parts of the response data should be returned. Values: `members`, `all` (default), or `none`.
- **includeDeleted** (boolean) - Optional - A flag indicating whether group information should be retrieved even if the group is logically deleted. Default: `false`.
### Response
#### Success Response (200)
- **groupID** (integer) - The group ID of the group.
- **groupName** (string) - The group name of the group.
- **displaylName** (string) - The display name of the group.
- **description** (string) - The description of the group.
- **members** ([string]) - List of users which are members of the group.
- **managerGroupName** (string) - The group name of the manager group associated with this object.
#### Response Example
{
"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"
}
}
```
--------------------------------
### Get Label Placement Example
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-text-area
Checks the current label placement and toggles it if it is set to Left.
```javascript
if(me.getLabelPlacement == "L"){me.setLabelPlacement("T");}
```
--------------------------------
### Initialize Business Rule Management Example
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=examples-example-retrieve-print-business-rule-groups-rule-sets-decision-tables
Sets up the necessary imports and class structure for interacting with the Business Rule Management API.
```java
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.OperationSelectionRecord;
import com.ibm.wbiserver.brules.mgmt.OperationSelectionRecordList;
import com.ibm.wbiserver.brules.mgmt.Property;
import com.ibm.wbiserver.brules.mgmt.PropertyList;
import com.ibm.wbiserver.brules.mgmt.query.QueryOperator;
import com.ibm.wbiserver.brules.mgmt.ruleset.RuleSet;
public class Example2
{
status Formatter out = new Formatter();
static public String executeExample2()
{
try
{
out.clear();
```
--------------------------------
### Timeout exception log message
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=tsi-preventing-timeout-out-memory-exceptions-during-installation-deployment
Example of the server log message indicating a timeout during the installation job.
```text
CWPFD2064W: A timeout occurred during processing of the job
With a root cause: WTRN0124I: When the timeout occurred the thread with which the transaction ... sun.misc.Unsafe.park(Native Method)
```
--------------------------------
### GET /rest/bpm/htm/v1/systems
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=ribrtr-systems-metadata
Retrieves metadata about one or more WebSphere Process Server installations (single server or cluster).
```APIDOC
## GET /rest/bpm/htm/v1/systems
### Description
Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
### Method
GET
### Endpoint
/rest/bpm/htm/v1/systems
```
--------------------------------
### POST /rest/bpm/wle/v1/service/{instanceId}
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=resources-service
Starts a service instance.
```APIDOC
## POST /rest/bpm/wle/v1/service/{instanceId}
### Description
Use this method to start a service.
### Method
POST
### Endpoint
/rest/bpm/wle/v1/service/{instanceId}
### Parameters
#### Path Parameters
- **instanceId** (Service) - Required - Service Identifier.
```
--------------------------------
### GET /rest/bpm/bfm/v1/systems
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=ribrpr-systems-metadata
Retrieves metadata about one or more WebSphere Process Server installations (single server or cluster).
```APIDOC
## GET /rest/bpm/bfm/v1/systems
### Description
Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
### Method
GET
### Endpoint
/rest/bpm/bfm/v1/systems
```
--------------------------------
### GET /rest/bpm/federated/bfm/v1/systems
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=deprecated-systems-metadata-process-resources
Retrieves metadata about one or more WebSphere Process Server installations (single server or cluster).
```APIDOC
## GET /rest/bpm/federated/bfm/v1/systems
### Description
Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
### Method
GET
### Endpoint
/rest/bpm/federated/bfm/v1/systems
```
--------------------------------
### Launch wsadmin Utility
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=cmde-configuring-security-domains-1
Starts the wsadmin scripting tool using Jython with administrative credentials.
```bash
wsadmin -lang jython -user AdminUserID - password AdminUserIDPassword
```
--------------------------------
### Retrieve Process Applications via GET
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=applications-get
The endpoint used to fetch the list of installed process applications.
```http
GET /rest/bpm/wle/v1/processApps
```
--------------------------------
### Run BPMConfig to create profiles
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=installations-installing-configuring-swinging-profiles-environment
Execute the configuration command using the symbolic link to create the deployment environment.
```bash
/opt/BPMCommonArea/BPMLink/bin/BPMConfig.sh -create -de /opt/Advanced-PCSingleCluster-DB2.properties
```
--------------------------------
### Add a child process dependency
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=javascript-adding-dependent-relationship
Example of starting a process and establishing a dependency relationship without authorization checks.
```javascript
1 var process = tw.system.startProcessByName("Test BPD", null, false);
2 var relation = process.addDependencyOnProcess(processInstanceID, "relationship to a child process", false);
```
--------------------------------
### Locate Sample Configuration Files
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=environment-using-bpmconfig-command
Path to the directory containing sample configuration files for the BPMConfig command.
```text
install_root/BPM/samples/config
```
--------------------------------
### Retrieve multiple variables using GET
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=service-get-getdata
Example of using the fields parameter to retrieve a comma-separated list of variables.
```http
..../v1/service/?action=getData&fields=orderNumber,customerNumber,customerName
```
--------------------------------
### GET /rest/bpm/wle/v1/toolkit
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=resources-toolkits
Retrieves a list of toolkits installed in the system. Only toolkits for which the calling user has read permission are returned.
```APIDOC
## GET /rest/bpm/wle/v1/toolkit
### Description
Retrieves the toolkits that are installed in the system. Only the toolkits for which the calling user has read permission are returned in the response.
### Method
GET
### Endpoint
/rest/bpm/wle/v1/toolkit
```
--------------------------------
### Start servers in a clustered environment
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=unix-migrating-business-space-v620x-data
Use these commands to start the deployment manager, node, and servers in sequence for a clustered environment.
```shell
startManager.sh
startNode.sh
startServer.sh server_name (start all servers on the node in sequence)
```
--------------------------------
### StartProcess
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=apis-bpmn-web-service-api-reference
Starts a process and creates a new process instance.
```APIDOC
## StartProcess
### Description
Starts a process and creates a new process instance.
### Parameters
- **process** - The process to start
- **inputs** - The input variables to use when starting the process
### Response
- **Output** (object) - The started process instance
```
--------------------------------
### Get Poll Count on Location Requested
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=api-geo-location
Example usage of the getPollCount method within the On Location Requested event.
```JavaScript
me.getPollCount()
```
--------------------------------
### Example BPMConfig export command execution
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=icmbpm-using-bpmconfig-command-export-database-information-performance-analysis
Concrete examples of running the export command with specified profiles, deployment environments, and output directories.
```bash
BPMConfig.bat -export -profile DmgrProfile -de De1 -db E:\performanceAnalysis.properties -outputDir E:\output
BPMConfig.sh -export -profile DmgrProfile -de De1 -db /home/user/performanceAnalysis.properties -outputDir /home/user/output
```
--------------------------------
### Execute BPMGroupMembershipFullUpdateTask via wsadmin
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripting-bpmgroupmembershipfullupdatetask
Example of starting the wsadmin client and executing the task to enforce dynamic group updates.
```jython
wsadmin -conntype SOAP -port 8880 -host PC1.mycompany.com -user admin -password admin -lang jython
wsadmin>AdminTask.BPMGroupMembershipFullUpdateTask('[-dynamicGroupUpdate always]')
```
--------------------------------
### Install an offline package via wsadmin
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=scripting-bpminstallofflinepackage
Establishes a SOAP connection to the Process Server and executes the installation command for a specified snapshot file.
```bash
wsadmin -conntype SOAP -port 8880 -host ProcessServer.mycompany.com -user admin -password admin -lang jython
wsadmin>AdminTask.BPMInstallOfflinePackage('[-inputFile C:/myProcessApps/BillingDispute.zip]')
```
--------------------------------
### GET /rest/bpm/bfm/processTemplate/{ptid}/operationTemplates?type=start
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=tasks-business-flow-manager-api-comparison
Retrieves information about activities that can start a process instance from the specified process template.
```APIDOC
## GET /rest/bpm/bfm/processTemplate/{ptid}/operationTemplates?type=start
### Description
Retrieves information about activities that can start a process instance from the specified process template.
### Method
GET
### Endpoint
/rest/bpm/bfm/processTemplate/{ptid}/operationTemplates
### Parameters
#### Path Parameters
- **ptid** (string) - Required - The process template identifier.
#### Query Parameters
- **type** (string) - Required - Must be set to 'start'.
```
--------------------------------
### POST /v1/service/{instanceId}
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=apis-rest-interface-bpd-related-resources
Starts a service with specified parameters and actions.
```APIDOC
## POST /v1/service/{instanceId}
### Description
Use this method to start a service.
### Method
POST
### Endpoint
/v1/service/{instanceId}
### Parameters
#### Path Parameters
- **instanceId** (string) - Required - The ID of the service instance.
#### Query Parameters
- **action** (string) - Required - The action to perform.
- **createTask** (boolean) - Optional - Whether to create a task.
- **parts** (string) - Optional - Parts to include.
- **params** (string) - Optional - Parameters for the service.
- **snapshotId** (string) - Optional - Snapshot ID.
- **callerTaskId** (string) - Optional - Caller task ID.
- **callerModelId** (string) - Optional - Caller model ID.
- **callerProcessId** (string) - Optional - Caller process ID.
- **callerModelBranchId** (string) - Optional - Caller model branch ID.
- **callerModelSnapshotId** (string) - Optional - Caller model snapshot ID.
```
--------------------------------
### Retrieve a single variable using GET
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=service-get-getdata
Example of using the field parameter to retrieve a specific variable from a service instance.
```http
..../v1/service/?action=getData&field=orderNumber
```
--------------------------------
### GET /rest/bpm/federated/v1/launchableEntities
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=server-process-federation-rest-apis
Retrieves a federated list of processes, services, and BPEL invocation tasks that can be started by the current logged-on user.
```APIDOC
## GET /rest/bpm/federated/v1/launchableEntities
### Description
Provides a federated list of the processes, services, and BPEL invocation tasks that can be started by the current logged-on user.
### Method
GET
### Endpoint
https://pfsHost.mycompany.com:9443/rest/bpm/federated/v1/launchableEntities
```
--------------------------------
### Start the wsadmin scripting tool
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=ctpap-configuring-httpprotocolonly-property-desktop-process-designer-deprecated-1
Initiate the wsadmin tool in local mode to perform configuration operations.
```jython
Dmgr_HOME\bin>wsadmin -conntype NONE -lang jython
WASX7357I: By request, this scripting client is not connected to any server proc
ess. Certain configuration and application operations will be available in local
mode.
WASX7031I: For help, enter: "print Help.help()"
```
--------------------------------
### GET /rest/bpm/wle/v1/social/task/{taskId}/experts
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=experts-get
Retrieves information about the expert users that have been identified for a task and defined to the IBM BPM installation.
```APIDOC
## GET /rest/bpm/wle/v1/social/task/{taskId}/experts
### Description
Retrieves information about the expert users that have been identified for a task and defined to the IBM BPM installation.
### Method
GET
### Endpoint
/rest/bpm/wle/v1/social/task/{taskId}/experts
### Parameters
#### Path Parameters
- **taskId** (string) - Required - The ID of the task.
#### Query Parameters
- **parts** (string) - Optional - A string indicating which parts of the response data should be returned. Values: 'all' (default), 'none'.
### Response
#### Success Response (200)
- **systemIdentifiedUsers** (array) - List of users identified by the system.
- **expertParticipantGroupUsers** (array) - List of users in the expert participant group.
- **expertParticipantGroupDetails** (object) - Optional details about the expert participant group.
#### Response Example
{
"status": "200",
"data": {
"systemIdentifiedUsers": [{
"userID": 0,
"userName": "tw_admin",
"fullName": "Internal TW Admin user"
}],
"expertParticipantGroupUsers": [{
"userID": 1,
"userName": "tw_admin",
"fullName": "Internal TW Admin user"
}],
"expertParticipantGroupDetails": {
"groupID": 1303,
"displayName": "Expert Participant Group 1 v1"
}
}
}
```
--------------------------------
### EventService Startup Error Log
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=troubleshooting-cannot-start-application-event-service-deprecated
Example of the WSVR0501E error message indicating a failure to start the EventService due to a filter issue.
```text
[10/14/09 16:54:57:589 EDT] 00000000 ContainerHelp E WSVR0501E: Error creating component
com.ibm.ws.runtime.component.CompositionUnitMgrImpl@86e086e
com.ibm.ws.exception.RuntimeWarning: could not start application EventService because of filter
com.ibm.events.service.CeiApplicationFilter@4e2c4e2c
at com.ibm.ws.runtime.component.ApplicationMgrImpl.startApplication(ApplicationMgrImpl.java:686)
```
--------------------------------
### Initialize wsadmin Session
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=cr-updating-context-roots-in-existing-network-deployment-environment
Start the wsadmin tool using Jython for administrative tasks.
```bash
wsadmin -lang jython -user AdminUserID - password AdminUserIDPassword
```
```bash
wsadmin -lang jython -user AdminUserID -password AdminUserIDPassword
```
--------------------------------
### Example of Activity Monitoring Event Sequence
Source: https://www.ibm.com/docs/en/bpm/8.6.0?topic=events-activity-monitoring
Shows the chronological order of events for a simple-looped activity, starting with READY and ending with COMPLETED.
```text
ACTIVITY_READY
ACTIVITY_LOOP_CONDITION_FALSE
ACTIVITY_LOOP_CONDITION_FALSE
ACTIVITY_LOOP_CONDITION_FALSE
ACTIVITY_LOOP_CONDITION_TRUE
ACTIVITY_COMPLETED
```
--------------------------------
### Start deployment environment using profile and name
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 specifying the profile and deployment environment name. The -de option can be omitted if only one deployment environment exists in the cell.
```cmd
BPM_home\bin\BPMConfig -start -profile DmgrProfile [-de De1]
```
```bash
BPM_home/bin/BPMConfig.sh -start -profile DmgrProfile [-de De1]
```