setBPMExternalECM command

Use the setBPMExternalECM command to configure IBM® Business Process Manager to use an external Enterprise Content Management server.

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

Prerequisites

The following conditions must be met:

Before the setBPMExternalECM command is run, the IBM BPM system must be at version 8.5.6 or higher with any necessary upgrade or migration procedures already completed. If the startDocumentStoreMigration command needs to be run, it must be run before you run the setBPMExternalECM command.
The command must be run on the deployment manager node.
If the deployment manager is stopped, use the wsadmin -conntype none option to run the command in disconnected mode.
If the deployment manager is running, you must connect with a user ID that has WebSphere Application Server configurator privileges. Do not use the wsadmin -conntype none option.
The FileNet Content Platform Engine must not be shut down.

Location

Start the wsadmin scripting client from the deployment_manager_profile/bin directory. The setBPMExternalECM command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you find exception stack traces and other information.

Syntax

setBPMExternalECM
-de deployment_environment_name
-ceUrl external_FileNet_content_engine_url 
-backLinkUrl bpm_url
-ecmEnvironment NEW_EXTERNAL_OBJECT_STORE | REASSIGN_OBJECT_STORE | REASSIGN_DOMAIN
-domainName external_FileNet_domain_name
-objectStoreName external_FileNet_object_store_name

Parameters

-de deployment_environment_name

A required parameter that specifies the name of the current deployment environment.

-ceUrl external_FileNet_content_engine_url

A required parameter that specifies the external FileNet Content Platform Engine URL address. For a highly available configuration that uses an application server cluster, see Content Platform Engine in an application server cluster by using EJB transport.

-backLinkUrl bpm_url

An optional parameter that specifies the URL address to connect from the external FileNet Content Platform Engine server back to the IBM BPM server. In many cases, you would not use this parameter. If the parameter is omitted, the URL address is computed based on the current topology. It includes all IBM BPM application cluster members with their respective host names and bootstrap port numbers.

-ecmEnvironment NEW_EXTERNAL_OBJECT_STORE | REASSIGN_OBJECT_STORE | REASSIGN_DOMAIN

A required parameter that specifies in what way an external Enterprise Content Management server is used.

NEW_EXTERNAL_OBJECT_STORE is used if you created a new object store on an existing external FileNet Content Platform Engine. Select this option if you followed the instructions in Using a new object store.
REASSIGN_OBJECT_STORE is used if you used the FileNet Deployment Manager on an external FileNet Content Platform Engine to connect to the IBM BPM content store in IBM BPM. Then, you moved IBM BPM content store to a FileNet Content Platform Engine domain. Select this option if you followed the instructions in Reassigning the IBM BPM content store.
REASSIGN_DOMAIN is used if you created a new installation of FileNet Content Platform Engine that contains IBM BPM content store in a FileNet Content Platform Engine domain. Select this option if you followed the instructions in Configuring IBM BPM with a new external ECM server.

-domainName external_FileNet_domain_name

A required parameter if you select NEW_EXTERNAL_OBJECT_STORE or REASSIGN_OBJECT_STORE. This parameter specifies the external FileNet Content Platform Engine domain name. This parameter is not required if you select REASSIGN_DOMAIN.

-objectStoreName external_FileNet_object_store_name

A required parameter if you select NEW_EXTERNAL_OBJECT_STORE or REASSIGN_OBJECT_STORE. This parameter specifies the external FileNet Content Platform Engine object store name. The default object store name, docs, cannot be specified as a value. This parameter is not required if you select REASSIGN_DOMAIN.

Examples

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.

The following Jython example uses the setBPMExternalECM command to configure IBM BPM to use an existing external FileNet Content Platform Engine server. The optional -backLinkUrl parameter is not used.

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.setBPMExternalECM(['-de', 'De1', '-ceUrl', 'iiop://CE.mycompany.com:2809/FileNet/Engine', '-ecmEnvironment', 'NEW_EXTERNAL_OBJECT_STORE', '-domainName', 'bpm', '-objectStoreName', 'bpmdocs'])
wsadmin>AdminConfig.save()

The following Jython example uses the setBPMExternalECM command to configure IBM BPM to move IBM BPM content store to an external FileNet Content Platform Engine domain. The optional -backLinkUrl parameter is not used.

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.setBPMExternalECM(['-de', 'De1', '-ceUrl', 'iiop://CE.mycompany.com:2809/FileNet/Engine', '-ecmEnvironment', 'REASSIGN_OBJECT_STORE', '-domainName', 'bpm', '-objectStoreName', 'bpmdocs'])
wsadmin>AdminConfig.save()

The following Jython example uses the setBPMExternalECM command to configure IBM BPM to use an external server with a new installation of FileNet Content Platform Engine. The optional -backLinkUrl parameter is explicitly used.

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.setBPMExternalECM(['-de', 'De1', '-ceUrl', 'iiop://CE.mycompany.com:2809/FileNet/Engine', '-backLinkUrl', 'corbaloc:iiop:BPM.mycompany.com:9010', '-ecmEnvironment', 'REASSIGN_DOMAIN'])
wsadmin>AdminConfig.save()

Example of a ceUrl parameter URL: iiop://<external FileNet Content Engine server>:2809/FileNet/Engine

Example of a ceUrl parameter URL in a clustered environment: corbaloc:iiop:<FileNet Content Engine clustermember1-hostname:bootstrapaddr>,iiop:<FileNet Content Engine clustermember2-hostname:bootstrapaddr>[,...]/cell/clusters/<clusterName>/FileNet/Engine where hostname is the host name of a FileNet Content Engine cluster member and bootstrapaddr is the BOOTSTRAP_ADDRESS port of a FileNet Content Engine cluster member. Since iiop is the default protocol, in this example it can be optionally omitted.

Example of a backLinkUrl parameter URL: corbaloc:iiop:<Business Process Manager cluster member>:9010 where 9010 is the BOOTSTRAP_ADDRESS port of an IBM BPM application cluster member.

Example of a backLinkUrl parameter URL in a clustered environment: BPMclustermember1-hostname:bootstrapaddr>,<BPMclustermember2-hostname:bootstrapaddr>, ... corbaloc:iiop:<Business Process Manager cluster member1-hostname:bootstrapaddr>,iiop:<Business Process Manager cluster member2-hostname:bootstrapaddr>[,...] where hostname is the host name of an IBM BPM application cluster member and bootstrapaddr is the BOOTSTRAP_ADDRESS port of an IBM BPM application cluster member. Since iiop is the default protocol, in this example it can be optionally omitted.

A configuration changes over time. For example, a cluster member is added. Use the updateBPMExternalECM command to update your configuration. See updateBPMExternalECM command.