Fault Codes - Web Services Publishing - English - Foundation 22.1 - OnBase

Fault Codes - Web Services Publishing - English - Foundation 22.1 - OnBase - external

Web Services Publishing

Platform

OnBase

Product

Web Services Publishing

Release

Foundation 22.1

License

A variety of fault codes can be generated if the published web service cannot be successfully consumed by the LOB system. In combination with the text of the fault message itself, the fault code generated can provide an indication of what caused the fault. The LOB application that needs to consume the published web service can then be customized by a developer to handle specific fault cases in different ways.

Fault Code	Description
hyland://hyland.integrations.adapter:HylandClientException	This fault code can be returned when a runtime exception occurs due to a data validation failure on input parameters required by the operation being used. For example: On a request to a Create Document operation, the Base64 string representing the document to be created is not provided in the request message. On a request to a Create Document operation, the Base64 string provided on the request does not match the Base64 format.
hyland://hyland.integrations.adapterHylandServerException	This fault code can be returned when a runtime exception occurs in the Application Server. Any exception thrown by the Application Server when processing a request can cause this fault code to be returned. For example: On a request to an Update Document operation, the value provided to update a Numeric (Up to 9 Digits) Keyword Type in OnBase is longer than nine characters. On a request to an Execute Workflow Ad Hoc Task operation contained in a web service using Highest security, the user calling the operation does not have the required privileges to access the task to be executed.

Fault Code

Description

hyland://hyland.integrations.adapter:HylandClientException

This fault code can be returned when a runtime exception occurs due to a data validation failure on input parameters required by the operation being used. For example:

On a request to a Create Document operation, the Base64 string representing the document to be created is not provided in the request message.
On a request to a Create Document operation, the Base64 string provided on the request does not match the Base64 format.

hyland://hyland.integrations.adapterHylandServerException

This fault code can be returned when a runtime exception occurs in the Application Server. Any exception thrown by the Application Server when processing a request can cause this fault code to be returned. For example:

On a request to an Update Document operation, the value provided to update a Numeric (Up to 9 Digits) Keyword Type in OnBase is longer than nine characters.
On a request to an Execute Workflow Ad Hoc Task operation contained in a web service using Highest security, the user calling the operation does not have the required privileges to access the task to be executed.