setBPMEndpoint command
Use the setBPMEndpoint command
to create or update an Business Automation Workflow endpoint.
In
stand-alone environments, such as IBM® BPM Express and
the unit test environment of Integration Designer, the value
of the endpoint is set immediately when you run the command. In network
deployment (ND) environments, the value of the endpoint is set when
the next node synchronization occurs. For both stand-alone and ND
environments, it is not necessary to restart the server or cluster
after running the command.
The setBPMEndpoint command is run using the AdminTask object of the wsadmin scripting client.
Prerequisites
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.
- If the deployment manager or stand-alone server is stopped, use
the
wsadmin -conntype none
option to run the command in disconnected mode (which is the recommended mode for this command). - If 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.
Location
Start the wsadmin scripting client from the profile_root/bin directory. The setBPMEndpoint 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 will find exception stack traces and other information.
Syntax
setBPMEndpoint
[-de deployment_environment_name]
-scenario scenario_name
[-strategies strategy_1,strategy_2]
[-virtualHost virtual_host_hostname]
[-url url]
Parameters
- -de deployment_environment_name
- An optional 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.
- -scenario scenario_name
- A required parameter that specifies the scenario of the endpoint. Tip: For a list of valid scenario values, see "Table 1" and "Table 3" in the topic Configuring endpoints to match your topology.
- -strategies strategy_1,strategy_2
- An optional parameter that specifies a comma-separated list of
strategies for the endpoint.Tip: For a list of valid strategy values, see "Table 2" in the topic Configuring endpoints to match your topology.
- -virtualHost virtual_host_hostname
- An optional parameter that specifies the name of the virtual host
for the endpoint.Important: If you set values for
virtualHost
andurl
, theurl
setting is used and thevirtualHost
setting is ignored. - -url url
- An optional parameter that specifies the URL of the endpoint.
Note: To reset the existing value for the strategies, virtualHost,
and url optional parameters, specify the parameter
but omit the value. An example is provided in the following section.
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 setBPMEndpoint command
to reset the existing value for the url parameter:
AdminTask.setBPMEndpoint( [ '-name', 'EXTERNAL_CLIENT', '-url' ] )
The
following Jython example uses the setBPMEndpoint command
to create or update an endpoint:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.setBPMEndpoint(['-de', 'De1', '-scenario', 'myScenario', '-strategies', 'myStrategy1,myStrategy2', '-virtualHost', 'myHostName', '-url', 'myURL'])
wsadmin>AdminConfig.save()
Note: You can specify multiple
strategies with the -strategies parameter, but
the strategies must be separated by commas (as shown in the above
example).