a!integrationError() Function

Function

a!integrationError( title, message, detail )

Creates an integration error value. Use when configuring custom error handling for integration objects.

Parameters

Keyword	Type	Description
`title`	Text	A short summary of the error or the error type.
`message`	Text	A description of the error.
`detail`	Text	Technical details about the error, including error codes or underlying error messages.

Returns

Integration error value

Usage considerations

Get error values

fv!success, fv!error, and fv!result can be used to get response values from any errors.

Example

In a call to another system that does not support PUT, the following error message:

=a!integrationError(
  title: fv!error.title,
  message: fv!result.statusCode & "- " & fv!error.message,
  detail: fv!error.detail
)

Results in:

IntegrationError
    title: "The external system cannot support the request"
    message: "405 - The requested URL does not support the PUT method"
    detail: "HTTP/1.1 405 Method not allowed"

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Partially compatible	Can be used with offline mobile if it is loaded at the top of the form.
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Feedback

Was this page helpful?