Appian Selenium API

Overview

The library contains methods which allow you to interact with Appian components in a browser. It can be used in a Java application or integrated directly into any Selenium or Java-based testing tool.

Appian Selenium API contains the methods that are at the core of both Cucumber for Appian and FitNesse for Appian. If you are familiar with either Appian’s FitNesse or Cucumber tools then you are already familiar with the methods provided by the Appian Selenium API. For example, the table below shows the corresponding FitNesse and Cucumber methods for the same underlying Appian Selenium API method.

Appian Selenium API

loginWithUsernameAndPassword(jString userName, String password)

FitNesse for Appian

| login with username | USERNAME | and password | PASSWORD |

Cucumber for Appian

Given I login with username "USERNAME" and password "PASSWORD"

Note: Java 11 required for plugin version 23.4

Key Features & Functionality

The Appian Selenium API plug-in package includes:

  • The Appian Selenium API jar
  • Javadocs
  • An example of how to use the API in a Java application
  • An example of how to use the API in a Cucumber test 

The Appian Selenium API plug-in supports both Chrome and Firefox browsers. See the Appian Playbook for more information: Automated Testing with Appian Selenium API

Note on Appian Versions:

With each Appian release, a new version of the plug-in is also released to support the latest Appian components. This plug-in is backwards compatible, ensuring that you do not need to update your test cases when upgrading to new Appian versions.

Anonymous
  • v25.2.0 Release Notes
    • IMPORTANT UPDATE: The Appian Selenium API is now available as an open-source repository! The repository can be found on Gitlab under "appian-oss/appian-selenium-api": gitlab.com/.../
    • Users of the libraries will find a few key benefits from this change:
    • Ability to contribute to the libraries
    • Immediate access to bug fixes and new functionality
    • Improved communication between other users and library maintainers by leveraging Gitlab issues.
    • Updates to the framework will be immediately available in the open source package registry. Users are encouraged to leverage this instead of the App Market as we do not plan to update the App Market listing for every patch.
  • where is the documentation for this?

  • Hi ,
    While automating the Box Layout  which has the dropdown options,I have used the below method.

    String DropdownXPath = "//div[@id='8221a514db0c88f9e45aedfc6b0f6626_value'])[1]" ;
    if (fixture.elementExistsByXPath(DropdownXPath)) {
    fixture.selectOptionByXPath("//li[contains(text(),'LH Managed Service Agreement')]","LH Managed Service Agreement");
    } else {
    fixture.populateDropdownSearchBoxWith("---Select Template---","LH Managed Service Agreement");
    }
    Can anyone suggest the correct method in populating the dropdown in box layout?

  • Hi,

    Is there any method to populate a field which is in Box layout and card layouts while automating?

    Thanks

  • There is a bug in getGridColumnRowValue(), if the grid has height: "TALL".
    With a "TALL" grid an additional row of headers with "class=FrozenHeaderGrid---frozen_header" is added to the html code. These extra headers affects TempoGridCell.getColumnNumber

  • I'm getting a 401/Unauthorized response when trying to download the plugin.  I get the same when I try to access forum.appian.com.

  • The appian-selenium-api-24.3.jar is a library, not a standalone application. It contains classes and methods used in your automation framework but doesn’t have an entry point (main method) to be run directly

  • Hi, After downloading, following the setup instructions and when I tried running example HelloAppian.java, I see the below error. Please suggest if I am I missing anything? 

    "C:\Program Files\Java\jdk-11\bin\java.exe" -Dfile.encoding=UTF-8 -jar C:\AppianSeleniumAPICombinedFiles342025\ExampleProjects\appian-selenium-api-example-java\lib\appian\appian-selenium-api-24.3.jar
    no main manifest attribute, in C:\AppianSeleniumAPICombinedFiles342025\ExampleProjects\appian-selenium-api-example-java\lib\appian\appian-selenium-api-24.3.jar

    Process finished with exit code 1"

  • Hi, will it be possible to get a copy of the JAVA source code for the Appian Selenium API? Our team is interested in how to detect the progress bar at the top of the site when loading or updating page interface.