setBPMProperty command

Edit online

Traditional:
Use the setBPMProperty command to set the value of an Business Automation Workflow custom property in the configuration repository. In stand-alone environments, such as the unit test environment of Integration Designer, the value of the custom property is set immediately when you run the command. In network deployment (ND) environments, the value of the custom property is set when the next node synchronization occurs. You might need to restart the server or cluster after running the command.

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

setBPMProperty
[-de deployment_environment_name]
-name custom_property_name
-value custom_property_value

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.

-name custom_property_name

A required parameter that specifies the name of an IBM BPM custom property. The format is component_name.property_name. The follow list contains the BPM custom properties:

BPC.ExternalActivityDefaultURL (String) See Adding a business process management system to a federated environment and Changing custom properties for Process Portal.
ProcessCenter.AdvancedDeploymentDEScoped (Boolean) See Isolating deployment environments.
ProcessCenter.BpdAutoTrackingEnabledDefault (Boolean) For an overview, see Tracking IBM Business Automation Workflow performance data.
ProcessCenter.BpdTrackingEnabledDefault (Boolean) For an overview, see Tracking IBM Business Automation Workflow performance data.
ProcessServer.AlertDefinitionsStatusEnabled (Boolean) See Disabling and enabling the checking of alerts.
ProcessServer.CompatibilityPortalNotificationSecurityCheck (Boolean)
ProcessServer.CustomURisVMM (Boolean)
ProcessServer.ExternalActivityDefaultURL (String) See Adding a business process management system to a federated environment and Changing custom properties for Process Portal.
ProcessServer.MinimumCoachViewRefreshInterval (Integer) See The coach view context object and Changing custom properties for Process Portal.
ProcessServer.ProvideOnlineStatusData (Boolean) See Changing custom properties for Process Portal.
ProcessServer.TimerCoachViewEnabled (Boolean) See The coach view context object and Changing custom properties for Process Portal.
ProcessServer.TimerCoachViewRefreshInterval (Integer) See The coach view context object and Changing custom properties for Process Portal.
ProcessServer.webService_InvalidXSDTypeThrowException (Boolean)
Security.AllowedHttpMethods (String). The value is a comma-separated list of acceptable HTTP methods, such as the methods GET,PUT,POST,DELETE,HEAD,OPTIONS that are set by default. Requests with a method that is not on the allowlist will be rejected with the message HTTP 403 (forbidden). For information about this property and other security-hardening properties, see Security-hardening properties.
Note: In Business Automation Workflow V8.6 2018.03, the security-hardening properties were changed from ProcessServer.property to Security.property. When you upgrade to V8.6 2018.03, these properties are automatically migrated to their new names. If you have automated scripts to set or read these properties using AdminTask.getBPMProperty(...) or AdminTask.setBPMProperty(...), the AdminTask will accept either name. However, names with ProcessServer.property for these security-hardening settings are deprecated.
Security.CsrfProtectionRefererWhitelist (String) in which the value is a comma-separated list of allowed REFERER headers to prevent cross-site request forgery attacks.
Security.CsrfSessionTokenProtectedUris (String)
Security.CsrfSessionTokenSalt (String)
Security.XFrameOptionsHeaderValue (String)

-value custom_property_value

A required parameter that specifies the value of the custom property that is specified for the -name parameter. The permitted values depend on the concrete custom property that is being updated. For example, if the parameter has a boolean flag, then the permitted values for the parameter are 'true' and 'false'.

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 setBPMProperty command to set the value of a custom property in the configuration repository:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.setBPMProperty(['-de', 'De1', '-name', 'ProcessServer.TimerCoachViewEnabled', '-value', 'true'])
wsadmin>AdminConfig.save()