ON_SUCCESS Event of SHIP_CONFIRM Transaction Not Fired

Resolving The Problem

This is caused by the createEnvironment() API being called without a progID corresponding to a valid Transaction_id.

The createEnvironment() API takes the parameters (VARIANT * vEnvHandle,[in]BSTR sProgID, [in]BSTR sUserID,[out, retval]int * iRetval). The Pre-Condition for this API is that the sProgID corresponds to a valid Transaction_id. If this is not the case, the API executes successfully, but is not able to trigger the corresponding event.

For example, in the case of SHIP_CONFIRM, the progID should be equal to "SHIP_CONFIRM". Usually, when a custom agent is written using confirmShipment(), it is recommended to create a new user transaction and specify it as a progID. In case of an error, this enables the error log to show that the error is not from Platform confirmShipment() call but from the custom agent calling the API.

A sample code using the COM version of this API is given below:

Private Sub testConfirmShipment(lenv As Variant, inXML As Variant, outXML As Variant, iRetVal As Long, errXML As Variant)
iRetVal = 0
Dim tempLenv As Variant
iRetVal = oUtil.createEnvironment(tempLenv, "SHIP_CONFIRM", "SHIP_CONFIRM")
iRetVal = oUtil.beginTransaction(tempLenv)
iRetVal = oUtil.confirmShipment(tempLenv, inXML, outXML, errXML)
If (iRetVal <> 0) Then
oUtil.rollback (tempLenv)
Else
oUtil.commit (tempLenv)
End If

End Sub