jXchange Error Handling

jXchange Error Handling

In the process of moving information back and forth between a Third-Party Consumer and a Service Provider, it is occasionally necessary to provide notification of Errors arising in messaging protocol and submitted element values. In jXchange, Error handling has been designed into the messaging structure and involves notification through use of codes, categories, descriptions, and options for |Error overrides for non-fatal Errors. There are two main exception types that should be dealt with:

• General SOAP Fault Exceptions
• HdrFault types

SOAP Fault Exceptions are standard faults that can arise from various factors ranging from communication timeouts to invalid credentials. Both server and client originated faults may be returned to your code’s service call, depending on what failed and where. Once you are communicating with jXchange and have passed authentication with valid credentials, you see the jXchange Fault Type of HdrFault arise.

A fault of HdrFault Type is thrown as a general SOAP Fault Exception. The HdrFault structure appears in the details section. This fault type is returned for any Error against jXchange that occurs after you are successfully talking to jXchange web services. This Error message can include anything from an Account Not Found message returned from a Core provider, to an Access Denied message if you attempt to access an operation that your current credentials do not allow.

These fault types always originate from our services but are not always a fault of our services. For example, if you submit a request to our services that is missing a required element, a HdrFault is returned stating that the element was not found and which element was missing.

Error Handling

Error notification, like that caused by flawed element values being submitted, is returned within a message’s complex structure. Nested within the FaultRecInfoArray is the fault message complex (FaultMsgRec). The FaultMsgRec complex contains the following simple elements for description of the Error or fault:

• ErrCode: Error Code (Required)
• ErrCat: Error Category (Required)
• ErrDesc: Error Description (Required)

Properly handling the HdrFault exception type allows you to interrogate the Error response object and determine the reasons for a failure. During your initial development with the jXchange platform, code in a manner that ensures you can catch these faults as early as possible. Doing so helps you through the early stages of consuming jXchange services and properly forming requests.

For example, as you learn how to form an Account Inquiry properly to our service, if you are missing items or placing invalid content in an element, the system can usually tell you what is wrong.

Message Elements

Use the following message elements for Error handing in jXchange.

     </FaultHdr>
     <FaultRecInfoArray>
      <FaultMsgRec>
       <ErrCode>500019</ErrCode>
       <ErrCat>Fault</ErrCat>
       <ErrDesc>The CIF number for from account and to account are different</ErrDesc>
       <ErrElem>AcctIdFrom.FromAcctId</ErrElem>
       <ErrElemVal>10262021002</ErrElemVal>
       <ErrLoc>JHXFERADD</ErrLoc>
      </FaultMsgRec>
     </FaultRecInfoArray>

• ErrCode: Error Code (Required) - Whole, unique, system-wide integer created by the Service Provider to specify a specific message.
• ErrCat: Error Category (Required) - One of four string identifiers created to classify the fault. Canonical values include:
  • Warning: Successful transmission of requested response transmission, but information must be returned to the customer describing under what condition the successful response was able to be created.
  • Error: Failure condition that cannot be overridden and must be corrected before processing can be completed.
  • Fault: Failure condition that can be overridden.
  • Override: Specific Warning notifying the customer that the fault has been overridden.
  • FaultLookup: Fault where the element that is causing the fault can be sent to a service for a listing of the possible values.

Important: In the Error Message Response, the Service Provider is required to use Error elements listed in the XSD for use with jXchange. jXchange, by contract, is not required to translate Service Provider elements or values.

Important: If the ErrOvrRd element contains a maximum number of nines (9999999 value for a seven-digit integer), the Service Provider is notified that all faults should be overridden, if possible.

Responding to Category Type: Fault

In a standard message flow involving Errors with an ErrCat value of Fault responses, the message flow begins with a standard request message from the Third-Party Consumer to the Jack Henry bank’s Service Provider.

The condition is created by an element of the request message containing an incomplete or invalid value, which prevents the Service Provider from completing the requested action.

In response, the Service Provider returns an Error message to the consumer with a code, category, and description corresponding to the severity of the Error fault. Once an Error message has been returned to the consumer, the consumer can return an override request to the Service Provider. The override request is identical to the primary request for service, in addition to an ErrOvrRd element containing the Error codes that the consumer requests the Service Provider to overlook. The Error codes listed for override must contain only fault values that can be overridden. Error values only result in a fatal Error being issued for the second request with override.

If the second request is issued with an override value that is allowed to be overridden, the Service Provider accepts the second request, ignores the Error condition designated in the primary response, and honors the service request.

      <ErrOvrRdInfoArray>
        <ErrOvrRd>
          <ErrCode>500019</ErrCode>
        </ErrOvrRd>
      </ErrOvrRdInfoArray>

jXchange and iAdapter

iAdapter exists as an additional communication layer between the jXchange environment and the SilverLake and CIF 20/20 cores. To allow for better troubleshooting and Error handling the iAdapter provides a standardized set of Error messages when issues occur. Below is a reference lookup to allow a consumer to review and plan for these Errors.

iAdapter Error Codes