addBPMSystem command

Use the addBPMSystem command to add an IBM® Business Process Manager system with a Business Process Execution Language (BPEL) or business process definition (BPD) engine to the local IBM Business Process Manager federated API.

The addBPMSystem command is run using the AdminTask object of the wsadmin scripting client.

Location

Start the wsadmin scripting client from the deployment_manager_profile/bin directory.

Syntax

addBPMSystem 
-bpmCellName cell_name
-bpmSystemType BPEL | BPD
-bpmHostName host_name
-bpmPort port
-bpmTransportType http | https
[-bpmNodeName node_name -bpmServerName server_name]
[-bpmClusterName cluster_name]
[-processServicesContextRoot context_root]
[-taskServicesContextRoot context_root]

Parameters

bpmCellName
The name of the system configuration cell for IBM Business Process Manager
bpmSystemType
The required system type for IBM Business Process Manager. Specify either BPEL or BPD.
bpmHostName
The required system's host name for IBM Business Process Manager.
bpmPort
The required system's port for IBM Business Process Manager.
bpmTransportType
The required transport type used by the Representational State Transfer (REST) calls. Specify either http or https.
bpmNodeName
The optional name of the system configuration node for IBM Business Process Manager . This parameter requires the specification of bpmServerName. Do not specify this parameter if the bpmClusterName parameter is specified.
bpmServerName
The optional configuration server name for IBM Business Process Manager. This parameter requires the specification of bpmNodeName. Do not specify this parameter if the bpmClusterName parameter is specified.
bpmClusterName
The optional configuration cluster name for IBM Business Process Manager. Do not specify this parameter if the bpmNodeName or the bpmServerName parameter is specified.
processServicesContextRoot
The optional context root for the process services endpoint. Specify a value for this parameter in the following cases:
  • the context root for the bfmrestapi.war file of the BPEContainer application was changed
  • the context root for the bpmrest.war file of the IBM_BPM_Teamworks application was changed
taskServicesContextRoot
The optional context root for the task services endpoint. Specify a value for this parameter in the following cases:
  • the context root for the taskrestapi.war file of the TaskContainer application was changed.
  • the context root for the bpmrest.war file of the IBM_BPM_Teamworks application was changed.

Examples

AdminTask.addBPMSystem('[-bpmCellName remoteCell
-bpmClusterName RemoteCell.AppCluster
-bpmSystemType BPEL -bpmHostName remoteHostname -bpmPort 443
-bpmTransportType https]')