setBPMExternalECM command

Edit online

Use the setBPMExternalECM command to configure IBM® Business Automation Workflow to use an external Enterprise Content Management 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 unavailable 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.

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 Business Automation Workflow system must be at version 8.5.6 or higher with any necessary upgrade or migration procedures already completed. You must run the setBPMExternalECM command before the startDocumentStoreMigration command.
In clustered environments, the command must be run on the deployment manager node. In nonclustered environments, the command must be run on the stand-alone server.
Ensure the deployment manager or stand-alone server 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 Content Platform Engine must not be shut down.

Important: Running this command in connected mode results in execution times that exceed the default timeout setting for wsadmin command execution. To change the default for the execution time, open the profile_root/properties/soap.client.props file and change the value for com.ibm.SOAP.requestTimeout to 0, which means no timeout. Remember to restore the previous value after you run the command.

Location

Start the wsadmin scripting client from the profile_root/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
-designObjectStoreName external_FileNet_design_object_store_name
-clientDownloadServicePort port_number
-clientDownloadServiceHostname CPE_server_hostname
[-targetObjectStoreName external_FileNet_target_object_store_name]
[-GraphqlEndpoint content_services_graphql_endpoint] 
[-omitBPMContentStoreValidation true]

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 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.

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.

-backLinkUrl bpm_url

An optional parameter that specifies the URL address to connect from the external Content Platform Engine server back to the Business Automation Workflow 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 Business Automation Workflow application cluster members with their respective hostnames and bootstrap port numbers.

-ecmEnvironment NEW_EXTERNAL_OBJECT_STORE | REASSIGN_OBJECT_STORE | REASSIGN_DOMAIN

A required parameter that specifies how the external Enterprise Content Management server is used.

NEW_EXTERNAL_OBJECT_STORE is used if you created a new object store on an existing external Content Platform Engine. Select this option if you followed the instructions in Configuring an existing external Content Platform Engine.
REASSIGN_OBJECT_STORE is used if you used the FileNet® Deployment Manager on an external FileNet Content Platform Engine to connect to the objects stores in Business Automation Workflow. Then, you moved the object stores to a Content Platform Engine domain. Select this option if you followed the instructions in Reassigning the BPM document store.
REASSIGN_DOMAIN is used if you created a new installation of Content Platform Engine that contains the object stores in a Content Platform Engine domain. Select this option if you followed the instructions in Configuring a new external Content Platform Engine.

-domainName external_FileNet_domain_name

A required parameter if you select NEW_EXTERNAL_OBJECT_STORE or REASSIGN_OBJECT_STORE. This parameter specifies the external 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 Content Platform Engine object store name. The name cannot be the Content Platform Engine design object store name or target object store name, and it also cannot be the default object store name, docs. It must be the name of a new object store that is used to store Business Automation Workflow business process definition (BPD) document attachments. This parameter is not required if you select REASSIGN_DOMAIN.

Tip: This parameter is case-sensitive.

-designObjectStoreName external_FileNet_design_object_store_name

A required parameter if you select NEW_EXTERNAL_OBJECT_STORE or REASSIGN_OBJECT_STORE. This parameter specifies the external Content Platform Engine design object store name, which is used for case solution design. This parameter is not required if you select REASSIGN_DOMAIN. For production profiles, this will be the staging object store name.

Tip: This parameter is case-sensitive.

-clientDownloadServicePort port_number

A required parameter that specifies 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.

-targetObjectStoreName external_FileNet_target_object_store_name

A 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.

-GraphqlEndpoint content_services_graphql_endpoint: A parameter that specifies the endpoint of the Content Services GraphQL for your Content Services toolkit. If you want to use the Content Services toolkit, this parameter is required.

-omitBPMContentStoreValidation true: An optional parameter that omits the check for whether the BPM content object store name already exists. If you are migrating from Business Automation Workflow to the same version on new hardware, you can specify this parameter to omit the check so that the BPM content object store can be reused.

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 Business Automation Workflow to use an existing external Content Platform Engine server. The optional -backLinkUrl parameter is not used.

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

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.setBPMExternalECM(['-clientDownloadServicePort', '9444', '-clientDownloadServiceHostname', 'CPE_server_hostname', '-de', 'De1', '-ceUrl', 'iiop://CE.mycompany.com:2809/FileNet/Engine', '-ecmEnvironment', 'NEW_EXTERNAL_OBJECT_STORE', '-domainName', 'p8domain', '-objectStoreName', 'bpmdocs', '-designObjectStoreName', 'bpmdos'])
wsadmin>AdminConfig.save()

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

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

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

wsadmin -user admin -password admin -lang jython
wsadmin>print 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::node1_hostname:BOOTSTRAP_ADDRESS, :node2_hostname:BOOTSTRAP_ADDRESS/cell/clusters/your_websphere_cluster_name/FileNet/Engine

where hostname is the hostname of a Content Platform Engine cluster member and BOOTSTRAP_ADDRESS is the bootstrap address port of a Content Platform Engine cluster member.

Example of a backLinkUrl parameter URL:

corbaloc:iiop:<Business Process Manager cluster member>:9010

where 9010 is the BOOTSTRAP_ADDRESS port of an Business Automation Workflow 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 hostname of an Business Automation Workflow application cluster member and bootstrapaddr is the BOOTSTRAP_ADDRESS port of an Business Automation Workflow 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.