Tactical activation Messaging API response message

A response message is returned when the Business Rules engine has completed tactical activation. The response message indicates whether the Business Rules engine was able to successfully activate all of the releases affected by the request message.

This example tactical activation response message shows the results of attempting to update the active Business Rules releases when the Business Rules Manager is not running. Releases cannot be updated when the Business Rules Manager is not running.

<ibmPaymentsDirectorBridge>
   <header>
      <msgDesc>Service_Response</msgDesc>
      <msgType>activateBusinessRules</msgType>
      <version>1.0.0</version>
      <messageTime>2017-05-31T19:20:24.059Z</messageTime>
      <sourceId>Business Rules Engine</sourceId>
      <destinationId>TestClient</destinationId>
      <ibmPaymentsDirectorContext>
         <msgIdStack>
            <msgId>ID:414d512046544d2e514d414e414745521d3722592002dc02</msgId>
         </msgIdStack>
      </ibmPaymentsDirectorContext>
      <errorCode>201</errorCode>
      <errorMessage>
         0 release(s) were successfully activated. 1 release(s) resulted in an exception.
      </errorMessage>
   </header>
   <contents>
      <rules>
         <summary success=0 exception=1/>
         <release id='1' environment='SAMPLE' result='exception'>
            com.ibm.fxh.businessrules.exception.ActivateException: com.ibm.fxh.businessrules.exception.ActivateException: java.rmi.ConnectException: Connection refused to host: localhost; nested exception is: ..java.net.ConnectException: Connection refused: connect
         </release>
      </rules>
   </contents>
</ibmPaymentsDirectorBridge>

Table 1 describes the XML elements that may be in the tactical activation response message.

Table 1. Tactical activation response message XML format
Node Name	Parent elements	Node type	Description
ibmPaymentsDirectorBridge	None, this is the root element	ELEMENT	The Messaging API XML root element for the tactical activation response message.
header	ibmPaymentsDirectorBridge	ELEMENT	Contains the Messaging API header information.
msgDesc	header	TEXT	The message description must be set to `Service_Response`.
msgType	header	TEXT	The message type must be set to `activateBusinessRules`.
sourceId	header	TEXT	The ID of the source of this message.
destinationId	header	TEXT	The ID of the recipient of this message. For example, `TestClient`.
errorCode	header	TEXT	The error code returned by tactical activation. An error code of zero indicates that the tactical activation request completed successfully. A non-zero error code indicates that the tactical activation request did not complete successfully and more information is available in the error message element of the header. Additional information about the tactical activation is provided in the contents element of this message.
errorMessage	header	TEXT	When a non-zero error code is returned, this element has an error message that displays the number of releases that were activated successfully and the number of releases that were not.
contents	ibmPaymentsDirectorBridge	ELEMENT	This element contains the contents of the message.
rules	contents	ELEMENT	This element contains the results for the tactical activation request.
summary	rules	TEXT	A summary of the results for the tactical activation request. This element has the following attributes: success the number of releases that were successfully activated. exception the number of releases that had an exception during activation.
release	rules	TEXT	The response message has a release element for each release that is affected by the tactical activation request. This element provides the results of activating each specific release and has the following attributes: id The ID of the release associated with these results. environment The name of the environment for the release. result The result of tactical activation for this release. Valid values for this attribute are: success The release was successfully activated. exception The release could not be activated successfully. The element text contains the name of the exception that occurred, followed by the message text of the exception.