updateBPMExternalECM command

When you add or remove cluster members either on IBM® Business Process Manager or IBM FileNet® Content Manager, use the updateBPMExternalECM command. This command reconciles the change from the old list of cluster members and servers to the new list of cluster members and servers. You use this command only if you have IBM BPM configured with an external ECM server.

Prerequisites

The updateBPMExternalECM command is run by using the AdminTask object of the wsadmin scripting client. The following conditions must be met:

The command must be run on the deployment manager node.
One or more application cluster members must be running.
Run the command in connected mode. Do not specify the wsadmin -conntype none option.
You must connect to the deployment manager with a user ID that has WebSphere Application Server operator privileges.

Location

Start the wsadmin scripting client from the deployment_manager_profile/bin directory. The updateBPMExternalECM 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

updateBPMExternalECM
-de deployment_environment_name
-ceUrl external_FileNet_content_engine_url 
-backLinkUrl bpm_url

Parameters

-de deployment_environment_name

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

-ceUrl external_FileNet_content_engine_url

An optional parameter that specifies the external FileNet Content Manager URL address. Use this parameter only if a cluster member on the FileNet Content Manager server has been added or removed. 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 Manager server back to the IBM BPM server. Use this parameter only if a cluster member on the IBM BPM server has been added or removed.

IBM BPM automatically calculates the URL, so only specify the URL if the calculated URL is incorrect. If you previously entered a URL but want to return to having the URL automatically calculated, enter "".

If you did not specify the -backLinkUrl parameter when you ran the setBPMExternalECM admin task, you do not need to specify it with the updateBPMExternalECM admin task. The list of available IBM BPM cluster member servers is maintained automatically.
If you specified a list of cluster member servers by using the -backLinkUrl parameter when you ran the setBPMExternalECM admin task, specify this same parameter with the updateBPMExternalECM admin task. You are responsible for updating the list of available IBM BPM cluster member servers.

The -ceUrl parameter or the -backLinkUrl parameter or both parameters must be provided. The value you specify is used for the update. If you do not specify one or both values, the previous values are used.

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 updateBPMExternalECM command to update the current list of cluster members and servers if a cluster member was added or removed from the FileNet Content Manager site.

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.updateBPMExternalECM(['-de', 'De1', '-ceUrl', 'iiop://CE.mycompany.com:2809/FileNet/Engine'])
wsadmin>AdminConfig.save()

The following Jython example uses the updateBPMExternalECM command to update the current list of cluster members and servers if a cluster member was added or removed from the IBM BPM site and the -backlinkUrl parameter was explicitly set.

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.updateBPMExternalECM(['-de', 'De1', '-backLinkUrl', 'corbaloc:iiop:BPM.mycompany.com:9010'])
wsadmin>AdminConfig.save()

The following Jython example uses the updateBPMExternalECM command to set the -backlinkUrl parameter back to an automatic calculation.

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.updateBPMExternalECM(['-de', 'De1', '-backLinkUrl', ''])
wsadmin>AdminConfig.save()

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

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