updateBPMExternalECM command

Edit online

Traditional:
When you add or remove cluster members either on Business Automation Workflow or 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. When you update the external Content Platform Engine, you must run the updateBPMExternalECM command to download the Content Platform Engine libraries on the Business Automation Workflow server. See the related topic Updating the Content Platform Engine client connector files. Run this command only if you have Business Automation Workflow configured with an external ECM server.

Note: This command retains the initial setting for content object support. However, if the Content Platform Engine version is earlier than 5.5.3, the command automatically disables content object support. If content object support is disabled and you upgrade Content Platform Engine to version 5.5.3 or later, you can manually enable content object support by using the BPMConfig command and the -update and -enableContentObjectSupport parameters, as described in the topic BPMConfig command-line utility. You can also use the same command and parameter to disable content object support regardless of the Content Platform Engine version.

If you are using Content Platform Engine as a container for integration with Business Automation Workflow and the Content Platform Engine version is 5.5.3, you must run the BPMConfig command and the -update and -enableContentObjectSupport parameters to disable content object support.

Prerequisites

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

In a network deployment environment, run the command on the deployment manager node. In a single-server environment, run the command on the stand-alone server.
In a network deployment environment, one or more application cluster members must be running. In a single-server environment, the stand-alone server must be running.
Run the command in connected mode with a user ID that has WebSphere Application Server configurator privileges. Do not use the wsadmin -conntype none option.

Location

Start the wsadmin scripting client from the dmgr_profile_root/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
-designObjectStoreName external_FileNet_design_object_store_name 
-clientDownloadServicePort port_number
-clientDownloadServiceHostname CPE_server_hostname
-backLinkUrl bpm_url
 V20.0.0.2  -targetObjectStoreName external_FileNet_target_object_store_name

Parameters

-de deployment_environment_name

A parameter that specifies the name of the current deployment environment. If there is only one deployment environment in the WebSphere cell, you can omit this parameter.

-ceUrl external_FileNet_content_engine_url

A required parameter that specifies the external FileNet Content Manager 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.

If IBM® Business Automation Workflow and Content Platform Engine are in the same WebSphere® Application Server cell, you can use the simpler corbaloc URI notation for this parameter, for example corbaloc:rir:/cell/clusters/your_websphere_cluster_name/FileNet/Engine. If you use this notation, you must specify the clientDownloadServiceHostname parameter for downloading Content Platform Engine client .jar files from the Content Platform Engine server.

-designObjectStoreName external_FileNet_design_object_store_name

A required parameter that specifies the external Content Platform Engine design object store name.

-clientDownloadServicePort port_number

A required parameter if you specify -ceUrl. This parameter provides the HTTP or HTTPS port number of the server where the external Content Platform Engine application is deployed. The default port numbers are 9080 and 9443. If you are using V19.0.0.2 or later, you must use the HTTPS port number, 9443.

To test the connection to the Client Download Servlet, enter the following URL in a web browser:

http://host_name:port_number/clientDownload?command=getVersion

This parameter checks whether the local Content Platform Engine client JAR files must be updated. If it updates the JAR files, it lists the updated files for you. Copy the files from the deployment manager to the same installation directory on each custom node in your deployment environment.

-clientDownloadServiceHostname CPE_server_hostname

A required parameter if you specify -ceURL using a corbaloc URI. This parameter specifies the hostname where the Content Platform Engine server is running. If this parameter is not specified, the first hostname that is extracted from the -ceUrl parameter is used to connect to the Content Platform Engine.

-backLinkUrl bpm_url

An optional parameter that specifies the URL address to connect from the external FileNet Content Manager server back to the Business Automation Workflow server. Use this parameter only if a cluster member on the Business Automation Workflow server has been added or removed.

Business Automation Workflow 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 Business Automation Workflow 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 Business Automation Workflow cluster member servers.

V20.0.0.2 -targetObjectStoreName external_FileNet_target_object_store_name

An optional parameter that specifies the default target object store (TOS) for your default project area. If you have multiple target object stores, you must designate one to be the default.

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>print AdminTask.updateBPMExternalECM(['-clientDownloadServicePort', '9444', '-de', 'De1', '-ceUrl', 'iiop://MigWPS7-856-T01.cn.ibm.com:2810/FileNet/Engine', '-designObjectStoreName', 'bpmdos'])
wsadmin>AdminConfig.save()

If this command copied JAR files from the external object store to the deployment manager profile, it lists the updated files for you. Copy the files from the deployment manager to the same installation directory on each custom node in your deployment environment.

The following Jython example is similar to the previous example. However, this example includes the -clientDownloadServiceHostname parameter, which you can use to specify the hostname of the Content Platform Engine server when it differs from the hostname that is extracted from the -ceUrl parameter.

wsadmin -user admin -password admin -lang jython
wsadmin>print AdminTask.updateBPMExternalECM(['-clientDownloadServicePort', '9444', '-clientDownloadServiceHostname', 'CPE_server_hostname', '-de', 'De1', '-ceUrl', 'iiop://MigWPS7-856-T01.cn.ibm.com:2810/FileNet/Engine', '-designObjectStoreName', 'bpmdos'])
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 Business Automation Workflow 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', '-ceUrl','iiop://MigWPS7-856-T01.cn.ibm.com:2810/FileNet/Engine', '-designObjectStoreName', 'bpmdos'])
wsadmin>AdminConfig.save()

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