Errors

RoboAppianError is the public exception boundary for Appian-specific automation failures.

If you are new to the library, start with the practical guide:

How to use RoboAppianError

The guide explains:

when to let pytest handle the error;
when to catch it;
how to use code, details, and to_dict();
how to preserve the original cause;
how to raise a well-formed Appian error from reusable helpers.

RoboAppianError

Bases: RoboAutomationError

Base exception for Appian-specific automation failures.

Catch this exception when a caller wants to handle Appian component or Appian interaction failures separately from generic automation failures.

Parameters:

Name	Type	Description	Default
`message`	`str`	Clear description of what failed.	required
`code`	`str \| None`	Optional stable machine-readable error code.	`None`
`details`	`Mapping[str, Any] \| None`	Optional structured context that helps diagnose the failure.	`None`

RoboAppianNavigationError

RoboAppianNavigationError is the specialized Appian error used when a lower-level browser navigation failure is translated through the Appian boundary.

Application code can catch it specifically when navigation requires special recovery, or simply catch RoboAppianError to handle all Appian failures together.

from robo_appian import RoboAppianError, RoboAppianNavigationError

try:
    run_navigation()
except RoboAppianNavigationError as error:
    print(error.code)
except RoboAppianError:
    raise

RoboAppianNavigationError

Bases: RoboAppianError

Appian navigation failure translated from robo-automation.

RoboAppianTimeoutError

RoboAppianTimeoutError represents an Appian wait that did not complete in time. Its user_message is intended for business-facing reports; the original browser exception remains available through normal Python exception chaining.

RoboAppianTimeoutError

Bases: RoboAppianError

Appian wait failure with a business-readable report message.