Appian Locator

AppianLocator represents a specific Appian element or a smaller section of an Appian page.

Most tests should begin with AppianPage. Use AppianLocator when you need to restrict an operation to a dialog, region, row, or other subtree so that similar controls elsewhere on the page are not matched accidentally.

from robo_appian import AppianLocator

When to use it

Use an AppianLocator when the same text or control appears more than once and you need to work inside one known section of the page.

Conceptually:

AppianPage
  ├─ main form
  ├─ dialog  ← AppianLocator can scope here
  └─ side panel

You normally do not create an AppianLocator just to fill a regular field. Prefer the simpler page APIs first:

page.textbox(label="Description").fill("Example")
page.button(name="Next").click()

Example

Use AppianLocator when you need to work with one specific area before performing an action:

from robo_appian import AppianLocator

user_options = AppianLocator(
    page,
    attributes={
        "role": "button",
        "aria-label": "User options",
    },
)

user_options.to_be_visible()
user_options.click()

For normal form fields and buttons, prefer the simpler page.textbox(...), page.dropdown(...), and page.button(...) APIs.

API

AppianLocator

Bases: RoboLocator

RoboLocator specialization reserved for Appian interaction semantics.