updateBPMConfig command

Use the updateBPMConfig command to modify the IBM Process Server environment name or environment type. In network deployment (ND) environments, the modified values are set when the next node synchronization occurs. In stand-alone environments, such as IBM BPM Express and the unit test environment of IBM Integration Designer, the modified values are set immediately when you run the command.

The updateBPMConfig command is run using the AdminTask object of the wsadmin scripting client.

Prerequisites

The following conditions must be met:

In IBM BPM Standard and IBM BPM Advanced, the command must be run on the deployment manager node. In IBM BPM Express, the command must be run 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 updateBPMConfig 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

updateBPMConfig
-serverName server_name
-nodeName node_name
-clusterName cluster_name
[-environmentName environment_name]
[-environmentType environment_type]

Parameters

-serverName server_name: A required parameter that specifies the name of the application server where the IBM Process Server environment is located. If you specify the -serverName parameter, you must also specify the -nodeName parameter.
-nodeName node_name: A required parameter that specifies the name of the server node where the IBM Process Server environment is located. If you specify the -nodeName parameter, you must also specify the -serverName parameter.
-clusterName cluster_name: A required parameter that specifies the name of the application cluster where the IBM Process Server environment is located.
-environmentName environment_name: An optional parameter that specifies the name of the IBM Process Server environment. The -environmentName parameter changes the value that was specified in the bpm.de.psServerName configuration property during initial creation of the deployment environment. The parameter only pertains to Process Server deployment environments and does not pertain to Process Center deployment environments.
-environmentType environment_type: An optional parameter that specifies the name of the IBM Process Server environment type. The valid environment types are Development, Test, Staging, and Production. The -environmentType parameter changes the value that was specified in the bpm.de.psPurpose configuration property during initial creation of the deployment environment. The parameter only pertains to Process Server deployment environments and does not pertain to Process Center deployment environments.

You must specify the -clusterName parameter in an ND environment or specify both the -serverName and -nodeName parameters in a stand-alone environment. You must also specify one or both of the -environmentName and -environmentType parameters.

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 updateBPMConfig command and the -serverName and -nodeName parameters to set the environment name and environment type values for the IBM Process Server environment:

wsadmin -conntype none -lang jython
wsadmin>AdminTask.setBPMProperty(['-serverName', 'myServerName', '-nodeName', 'myNodeName', '-environmentName', 'de1', '-environmentType', 'Staging'])
wsadmin>AdminConfig.save()

The following Jython example uses the updateBPMConfig command and the clusterName parameter to set the environment name and environment type values for the IBM Process Server environment:

wsadmin -conntype none -lang jython
wsadmin>AdminTask.setBPMProperty(['-clusterName', 'myClusterName', '-environmentName', 'de1', '-environmentType', 'Staging'])
wsadmin>AdminConfig.save()