Change in TEWS Response to included error message key may causes a custom TEWS application to fail to parse the response

Products

• CA Identity Manager
• CA Identity Portal
• CA Identity Suite

Issue/Introduction

After applying 14.3 CP1, the TEWS Response for a failed TEWS Request now includes the message key from the IMSExceptions_XX.properties file as <tews:msgKey>####</tews:msgKey>, for example as highlighted below:

http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <soapenv:Fault>
         <faultcode>soapenv:Server</faultcode>
         <faultstring>Unknown processing error.</faultstring>
         <detail>
            <tews:ImsException version="6.0">
               <tews:exception>
                  <tews:name>com.netegrity.ims.exception.IMSException</tews:name>
                  <tews:code>700</tews:code>
                  <tews:description>Unable to copy object, object could not be found. key: Subject.0.UniqueName value: ######.</tews:description>
                  <tews:transaction>29594543-25df2690-a92f2ca7-4c7598</tews:transaction>
                  <tews:msgKey>5102</tews:msgKey>
               </tews:exception>
            </tews:ImsException>
         </detail>
      </soapenv:Fault>
   </soapenv:Body>
</soapenv:Envelope>

While the response back is valid, if the application is not expecting the response to have "<tews:msgKey>[MESSAGE key]</tews:msgKey>" then parsing of the response may fail.

Environment

Release : 14.3 CP1

Component : IdentityMinder(Identity Manager)

Cause

The change in the TEWS response was made to facilitate better error handling in Identity Portal (which also uses TEWS), and it is a configuration requirement in IP.

Resolution

Custom TEWS applications needing to parse an error response should be modified to handle this new information in the response.