setBPMTargetSignificance command

Use the setBPMTargetSignificance command to set the target significance for all the outbound activation specification and outbound connection factories configured on the given cluster or server.

The target significance value determines how the applications interact with bus members defined to a messaging engine.

Remember: The system-generated Java Message Service (JMS) connection factory (named <moduleName>/<compName>_CF is shared for inbound and outbound. As a result, the target significance setting for the JMS connection factory is not changed when you run setBPMTargetSignificance. For the JMS, the connection factory used for Failed events (<moduleName><compName>/_FAILEDEVENT_REPLAY_CF) is changed when you run setBPMTargetSignificance.
After using the command, save your changes to the master configuration using one of the following commands:
  • For Jython:
    AdminConfig.save()
  • For Jacl:
    $AdminConfig save

Required parameters

clusterName clusterName
The name of the cluster on which you want to set target significance.
nodeName nodeName
The name of the node on which you are setting target significance.

If you specify this parameter, then you must also specify the serverName parameter. Do not specify this parameter if you have specified the clusterName parameter.

serverName serverName
The name of the server which you are setting target significance.

If you specify this parameter, then you must also specify the nodeName parameter. Do not specify this parameter if you have specified the clusterName parameter.

targetSignificance targetSignificance value
The value assigned to target significance. Valid values include:
  • Required

    For activation specifications, always set the significance to Required for best efficiency.

    A connection factory can be used to send or receive messages, and the destination(s) it will use are not known at configuration time. If the administrator knows that a particular connection factory will only be used to consume messages, then the same logic applies for activation specifications. A Required target should be set for the bus member that localizes the destination

  • Preferred
    If the connection factory will only be used to send messages, you can set the significance to Preferred to have better fault tolerance (the message will be sent if any messaging engine in the bus is available). Two exceptions to this are the cases below, which require a setting of Required:
    • Manageability / serviceability
    • Message ordering, or event sequencing.

      If the Preferred setting is used, an application might send messages through different paths if failures occur, which makes it impossible to guarantee the ordering of the messages as they arrive at the destination. If message ordering is a requirement, always use Required.

Optional parameters

printDetails true or false
The default value for this parameter is false. The value entered indicates whether or not to print details for setBPMTargetSignificance command.

If -printDetails = true, the command prints the current setting for targetSignificance used for all the activation specification and connection factories configured on the given cluster or server.

Examples

The following examples show how to use setBPMTargetSignificance.
Note: In the examples, the -printDetails property is set to true. If you do not want to print the target significance settings for all the activation specification and connection factories configured on the given cluster or server, set -printDetails to false.
  • Jython example:

    The example uses setBPMTargetSignificance to set the target significance value to Required for all the application resources deployed on a server (Server1) nodeName (Node2).

    AdminTask.setBPMTargetSignificance('[-serverName Server1 -nodeName Node2
    -targetSignificance Required -printDetails true]')
  • Jacl example:

    The example uses setBPMTargetSignificance to set the target significance value to Required for all the application resources deployed on a cluster (Cluster1):

    $AdminTask setBPMTargetSignificance {-clusterName Cluster1 
    -targetSignificance Required -printDetails true}