BPMSetWebServiceServerProperties command

Edit online

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15

Use the BPMSetWebServiceServerProperties command to set the connection information to a web service server for a specific snapshot.

The BPMSetWebServiceServerProperties 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

BPMSetWebServiceServerProperties
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
-serverName server_name
[-wsdlUrl webserviceurl]
[-protectedWsdl {true | false}]
[-wsdlUsername wsdlusername]
[-wsdlPassword wsdlpassword]
[-overrideEndpoint {true | false}]
[-endpointAddress endpointaddress]
[-endpointPort endpointport_number]
[-securityMode {USE_BASIC_SECURITY | USE_POLICY_SET}]
[-policySet policyset]
[-policyBinding policybinding]
[-authentication {NONE | HTTP_AUTHENTICATION | USERNAME_TOKEN_PASSWORD_PLAINTEXT | USERNAME_TOKEN_PASSWORD_DIGEST}]
[-username username]
[-password password]
[-clientCertificateAlias clientcertificatealias]
[-signRequest {true | false}]
[-expectEncryptedResponse {true | false}]
[-serverCertificateAlias servercertificatealias]
[-encryptRequest {true | false}]
[-expectSignedResponse {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.
-wsdlUrl String: An optional parameter that identifies the URL of the web service.
-protectedWsdl String {true | false}: An optional parameter that identifies if the service is a protected service. A protected service requires a username and password.
-wsdlUsername String: If -protectedWsdl is set to true, an optional parameter that identifies a user name that can access the web service.
-wsdlPassword String: If -protectedWsdl is set to true, an optional parameter that identifies the password of the user name.
-overrideEndpoint String {true | false}: An optional parameter to indicate that you want to override the WSDL URL.
-endpointAddress String: An optional parameter that indicates the URL of the web service you want to use.
-endpointPort String: An optional parameter that indicates the port for the web service that you want to use.
-securityMode String {USE_BASIC_SECURITY | USE_POLICY_SET}: An optional parameter that identifies the type of security that is used.
-policySet String: An optional parameter if the security mode is to use a policy set. This parameter specifies the name of the application policy set.
-policyBinding String: An optional parameter if the security mode is to use a policy set. This parameter specifies the name of the general client policy set binding. This binding contains system-specific configuration parameters like username and password information.
-authentication String {NONE | HTTP_AUTHENTICATION | USERNAME_TOKEN_PASSWORD_PLAINTEXT | USERNAME_TOKEN_PASSWORD_DIGEST}: An optional parameter if the security mode is set to use basic security. This parameter identifies the type of security.
-username String: An optional parameter that identifies a user name that is registered at the server.
-password String: An optional parameter that identifies the password that is registered at the server.
-clientCertificateAlias String: An optional parameter that identifies the client certificate alias. This alias identifies where the client certificate is located.
-signRequest String {true | false}: An optional parameter to indicate that you require messages from the client to be signed.
-expectEncryptedResponse String {true | false}: An optional parameter to indicate if the client expects an encrypted response message.
-serverCertificateAlias String: An optional parameter that identifies the server certificate alias. This alias identifies where the server certificate is located.
-encryptRequest String {true | false}: An optional parameter to indicate that you require an encrypted request message from the client.
-expectSignedResponse String {true | false}: An optional parameter to indicate if the server expects a signed response message.

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 web service server connection variables on the web service server for the http://mycorp.com/usafinance?wsdl URL. These variables are in a snapshot of the AmericanFinance process application. Basic security is used with no authentication. When a property value is set to null, the command does not update the property value. In the next example, the URL is changed to http://mycorp.com/newyorkfinance?wsdl. The next example shows the short form of the same example. The last example removes the wsdlUrl 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.BPMSetWebServiceServerProperties('[-containerAcronym AMERICANFINANCE -containerSnapshotAcronym V001 -serverName WEBSERVICE_SERVER
 -wsdlUrl http://mycorp.com/usafinance?wsdl -protectedWsdl true -wsdlUsername admin -wsdlpassword admin -overrideEndpoint false 
-endpointAddress null -endpointPort null -securityMode USE_BASIC_SECURITY -policySet null -policyBinding null -authentication NONE 
-username null -password null -clientCertificateAlias null -signRequest null -expectEncryptedResponse null 
-serverCertificateAlias null -encryptRequest null -expectSignedResponse null]')

wsadmin>AdminTask.BPMSetWebServiceServerProperties('[-containerAcronym AMERICANFINANCE -containerSnapshotAcronym V001 -serverName WEBSERVICE_SERVER
 -wsdlUrl http://mycorp.com/newyorkfinance?wsdl -protectedWsdl null -wsdlUsername null -wsdlpassword null -overrideEndpoint null 
-endpointAddress null -endpointPort null -securityMode null -policySet null -policyBinding null -authentication null 
-username null -password null -clientCertificateAlias null -signRequest null -expectEncryptedResponse null 
-serverCertificateAlias null -encryptRequest null -expectSignedResponse null]')

wsadmin>AdminTask.BPMSetWebServiceServerProperties('[-containerAcronym AMERICANFINANCE -containerSnapshotAcronym V001 -serverName WEBSERVICE_SERVER
 -wsdlUrl http://mycorp.com/newyorkfinance?wsdl]')

wsadmin>AdminTask.BPMSetWebServiceServerProperties('[-containerAcronym AMERICANFINANCE -containerSnapshotAcronym V001 -serverName WEBSERVICE_SERVER
 -wsdlUrl ""]')