Best practices for handling errors in Appian integrations

Hello,

I’m working on a bidirectional integration between Appian and an external system via a middleware gateway.

In this setup, we often encounter two categories of errors:

  • Technical issues

  • Data issues

  • Errors series (500 and 400)

QuestionMy question:
What are the best practices for functionally handling these types of errors on the Appian side?

Specifically:

  • Should we simply display messages to end users via pop-ups or alert banners?

  • Are there recommended design patterns or built-in Appian features we should consider (such as retry logic, logging strategies, fallback mechanisms, or dynamic UI error messages)?

  • Any advice for differentiating user-facing errors from those logged for admin troubleshooting?

Thanks in advance for your insights!

  Discussion posts and replies are publicly visible

Parents
  • 0
    Certified Lead Developer

    If you are calling the integration live from an interface, you could possibly display some kind of error to the user.

    If you are calling the integration in a process model, you can put some retry logic in your process model if the error is intermittent in nature and addressable via a retry. Otherwise you can either just have the process model error out so you can investigate.

    In addition, you can also choose to log the requests in order to be able to do some reporting on the occurence of certain errors.

Reply
  • 0
    Certified Lead Developer

    If you are calling the integration live from an interface, you could possibly display some kind of error to the user.

    If you are calling the integration in a process model, you can put some retry logic in your process model if the error is intermittent in nature and addressable via a retry. Otherwise you can either just have the process model error out so you can investigate.

    In addition, you can also choose to log the requests in order to be able to do some reporting on the occurence of certain errors.

Children
No Data