IBM BPM, V8.0.1, All platforms > Install IBM BPM > IBM BPM Advanced > Install IBM BPM Advanced > On Windows > Network deployment environment > Configure profiles and create an ND environment > Create an ND environment > Use the administrative console > Configure components > Configure additional components > Configure Process Portal > Configure the Business Space component for Process Portal > Configure Business Space to work with IBM Case Manager > Registering IBM Case Manager REST services in IBM BPM

addICMSystem command

Use the addICMSystem command to add the endpoints for IBM Case Manager services to the endpoint registry file for IBM BPM. This enables the federated REST API on the IBM BPM Advanced server to connect to the IBM Case Manager server.

This topic applies to the following products:

This command must be run where the IBM BPM federated REST API is deployed. If the application server is not running, include the -conntype NONE option when running this command.


Required parameters

-icmCellName cell_name

A parameter that specifies the name of the IBM Case Manager cell.

-icmNodeName node_name

A parameter that specifies the name of the IBM Case Manager node for the configuration. If you do not specify the icmClusterName parameter, you must specify both the icmServerName and icmNodeName parameters.

-icmServerName server_name

A parameter that specifies the name of the IBM Case Manager server for the configuration. If you do not specify the icmClusterName parameter, you must specify both the icmServerName and icmNodeName parameters.

-icmClusterName cluster_name

A parameter that specifies the name of the IBM Case Manager cluster for the configuration. For configuring Business Space on a cluster, you must specify the icmClusterName parameter without the icmServerName and icmNodeName parameters.

-PEConnectionName connection_name

A parameter that specifies the IBM Case Manager Process Engine connection name.

-icmHostName host_name

A parameter that specifies the name of the IBM Case Manager host.

-icmPort port

A parameter that specifies the port number of the IBM Case Manager host.

-icmTransportType http | https

A parameter that specifies whether the federated REST API uses the http or https protocol.


Optional parameter

-federateSystem true | false

If this is set to the value true, if the federation domain named BPM_ICM_Federation_Domain does not exist, it is created with two systems ICM and BPM. The default is false, which means no federation domain is created or modified. You can also manage the domain using the existing federation domain commands such as modifyBPMApiFederationDomain.


Example

The following examples uses the addICMSystem to add https endpoints for IBM Case Manager services on IBM BPM without adding the IBM Case Manager system to a federation domain.

Jython example: 

AdminTask.addICMSystem('[-icmCellName  cell_name
 -icmClusterName  cluster_name
 -PEConnectionName  connection_name
 -icmHostName  host_name
 -icmPort  port  -icmTransportType https
 -federateSystem false]')

Jacl example: 

$AdminTask addICMSystem {-icmCellName  cell_name
 -icmClusterName  cluster_name
 -PEConnectionName  connection_name
 -icmHostName  host_name
 -icmPort  port  -icmTransportType https
 -federateSystem false}

Commands (wsadmin scripting) for configuring the Business Space component for Process Portal

Registering IBM Case Manager REST services in IBM BPM


Related information:

Obtaining online help using wsadmin scripting
Administrative command invocation syntax using wsadmin scripting
Use the wsadmin scripting tool
Jython script library