BPMSetECMServerProperties command

Use the BPMSetECMServerProperties command to set the connection information to an Enterprise Content Management (ECM) server for a specific snapshot.

The BPMSetECMServerProperties command is run using the AdminTask object of the wsadmin scripting client. The variables that are updated by this command must already exist.

Prerequisites

Important: In an environment with multiple security domains configured, use the PALService MBean instead of this wsadmin command. See The Process Application LifeCycle (PAL) MBean.

The following conditions must be met:

Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
In a network deployment environment, an application cluster member runs the Workflow Server and Workflow Center applications. Therefore, you must run this command on the node that contains that application cluster member. Do not run the command from the deployment manager profile.

Location

Start the wsadmin scripting client from the install_root/bin directory.

Syntax

BPMSetECMServerProperties
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
-serverName server_name
[-hostname hostname]
[-port port_number]
[-secureServer {true | false}]
[-contextPath context_path_of_server]
[-repository repository_name]
[-userId user_ID]
[-password password]
[-alwaysUseThisConnectionInformation {true | false}]
[-testConnection {true | false}]

Parameters

-containerAcronym process_application_acronym: A required parameter that identifies the process application acronym. For example, the BillingDispute process application might have an acronym of BILLDISP.
-containerSnapshotAcronym process_application_snapshot_acronym: A required parameter that identifies the process application snapshot acronym.
Note: Use the BPMShowProcessApplication command to obtain process application information, including the snapshot acronym.
-serverName server_name: A required parameter that identifies the server to be updated.
-hostname String: An optional parameter that identifies the hostname of the ECM server.
-port String: An optional parameter that identifies the port number of the ECM server.
-secureServer String {true | false}: An optional parameter that you set to true if you want your service to be secure; that is, if you want to use the Hypertext Transfer Protocol Secure (HTTPS) protocol. You will need to configure the security. Setting up HTTPS security is described in Accessing an Enterprise Content Management server using the Secure Socket Layer (SSL).
-contextPath String: An optional parameter that identifies the path to the application on the server.
-repository String: An optional parameter that identifies the name of your repository.
-userId String: An optional parameter that identifies the user ID to connect to the ECM server.
-password String: An optional parameter that identifies the password for the user ID that you are using to connect to the ECM server.
-alwaysUseThisConnectionInformation String {true | false}: An optional parameter that you set to true if you want only this user ID and password to be used for authentication.
-testConnection String {true | false}: An optional parameter that tests the connection to the ECM server with the updated server settings. If set to true and the connection is successful, then the updated properties are saved. If the connection fails, the provided property updates are ignored.

Tip: If you do not know the acronym for a required parameter, use the BPMShowProcessApplication command to list the details of a process application, including acronyms.

Example

The following examples first show how to set the ECM server connection variables on the ECM_SERVER server. These variables are in a snapshot of the GermanFinance process application. In the next example, the hostname is updated to berlin. When a property value is set to null, the command does not update the property value. The next example shows the short form of the same example. The last example removes the hostname value. To remove a value, use "" or do not pass a value to the property.

In the example, the user establishes a SOAP connection to the Workflow Center server.

Important: In a network deployment environment, use the port configured for the application cluster member that runs the Workflow Server or Workflow Center applications. To determine the correct port number, see the WebSphere administrative console Ports collection page (click Servers > Server Types > WebSphere application servers > server_name > Communications > Ports and find the value for SOAP_CONNECTOR_ADDRESS).

wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.BPMSetECMServerProperties('[-containerAcronym GERMANFINANCE -containerSnapshotAcronym V001 -serverName ECM_SERVER 
-hostname hostname -port 1234 -secureServer true -contextPath cp -repository repo -userId user -password password 
-alwaysUseThisConnectionInformation true -testConnection true]')

wsadmin>AdminTask.BPMSetECMServerProperties('[-containerAcronym GERMANFINANCE -containerSnapshotAcronym V001 -serverName ECM_SERVER 
-hostname berlin -port null -secureServer null -contextPath null -repository null -userId null -password null 
-alwaysUseThisConnectionInformation null -testConnection null]')

wsadmin>AdminTask.BPMSetECMServerProperties('[-containerAcronym GERMANFINANCE -containerSnapshotAcronym V001 -serverName ECM_SERVER 
-hostname berlin]')

wsadmin>AdminTask.BPMSetECMServerProperties('[-containerAcronym GERMANFINANCE -containerSnapshotAcronym V001 -serverName ECM_SERVER 
-hostname ""]')