Guide

Writing to Synced Record Types at High Throughput

joel.larin — Thu, 18 Dec 2025 16:34:29 GMT

Current Revision posted to Guide by joel.larin on 12/18/2025 4:34:29 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing extremely high throughput autoscaled processes, you may need to modify your design to workaround write throughput limitations.

Synced record types are limited to handling up to ~30,000 write requests per minute for processes writing data in small batches (1-10 rows). Trying to sync data above this level of throughput will fail and can cause record type invalidations.

This guide explains how to design a process that supports writes to data fabric when peak times require more than ~30,000 write requests per minute across all of the applications on your site. This is accomplished through an incremental sync pattern where data is synced into the record types independently from the writes to the source table in large batches enabling over 1,000,000 rows to be synced per minute.

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Typically, the API is called only 200 to 300 times per minute. However, at peak times, the API is called over 30,000 times in a single minute. At these peak times, the Write Records node fails due to data sync limitations. Upon reaching data sync write throughput limitations, write performance will degrade, leading to request timeouts. Failed requests will return either 'could not obtain a reservation within the time limit' or 'the request has timed out due to the system being busy.'

Deferred Sync Pattern

In order to allow the process model to continue to process data even in times of peak load, we need to implement an independent sync pattern where data is synced in batches rather than one row at a time.

To avoid automatically syncing data to data fabric from the process model, an independent data store or a connected system data source must be created and used in the autoscaled process model to write data. This will allow us to write data only to the source table at first, and sync it in the record type independently.

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

That’s it! This pattern of ingesting data in larger batches can support syncing over 1,000,000 rows per minute in record types across all applications on your site, with data being updated in 5 minutes or less.

Tags: records, design patterns, Architecture, data fabric

Writing to Synced Record Types at High Throughput

joel.larin — Thu, 18 Dec 2025 16:33:43 GMT

Revision 34 posted to Guide by joel.larin on 12/18/2025 4:33:43 PM

Introduction

Trying to sync data above this level of throughput will fail and can cause record type invalidations.

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Tags: records, design patterns, Architecture, data fabric

Writing to Synced Record Types at High Throughput

joel.larin — Thu, 18 Dec 2025 16:31:32 GMT

Revision 33 posted to Guide by joel.larin on 12/18/2025 4:31:32 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Trying to sync data above this level of throughput will fail and can cause record type invalidations.

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Typically, the API is called only 200 to 300 times per minute. However, at peak times, the API is called over 10,000 times in a single minute. At these peak times, the Write Records node fails due to data sync limitations. Upon reaching data sync write throughput limitations, write performance will degrade, leading to request timeouts. Failed requests will return either 'could not obtain a reservation within the time limit' or 'the request has timed out due to the system being busy.'

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

That’s it! This pattern of ingesting data in larger batches can support syncing up to 200,000 rows per minute in record types across all applications on your site, with data being updated in 5 minutes or less.

Tags: records, design patterns, Architecture, data fabric

Automated Testing With Cucumber For Appian

joel.larin — Tue, 10 Jun 2025 23:23:50 GMT

Current Revision posted to Guide by joel.larin on 6/10/2025 11:23:50 PM

Please be advised that this package has moved to a new open-source repository, as future updates on the App Market will be discontinued. We encourage all users to switch to the new repository to gain the ability to contribute, receive immediate access to bug fixes and new functionality, and improve communication with other users and maintainers via GitLab issues.

Cucumber For Appian is a client-side tool that builds on top of what FitNesse For Appian has implemented and allows users to write automated UI tests against Appian with Gherkin syntax. Cucumber For Appian will support all of the same fixture methods that FitNesse For Appian currently supports.

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.
Access to Terminal if you’re on Mac/Linux or Command Prompt if on Windows
Apache Maven tool

Installation

The zip file for the tool can be downloaded from the AppMarket.

Unzip the contents into any directory (e.g. C:/)
In a terminal window, navigate to the ‘CucumberForAppian-x’ (where x corresponds to the version number) folder extracted from the zip file (e.g. C:\CucumberForAppian-19.1-SNAPSHOT)
- We will refer to this directory as CUCUMBER_ROOT from now on

Running Cucumber Tests

Navigate to src/test/resources from CUCUMBER_ROOT
Edit either the ApplicationExample.feature or TempoNavigationExample.feature file
- “BROWSER” - Chrome or Firefox
- “APPIAN_URL” - e.g. https://site-name.appiancloud.com
- “APPIAN_VERSION” - e.g. 18.4
- “APPIAN_LOCALE” - en_US or en_GB
- “APPIAN_USERNAME” - e.g. fitnesse.user
- The comments on the top of the .feature files will also help you in setting up
- The completed feature file should look like the one shown below:

In CUCUMBER_ROOT, run ./setupCustomPropertiesForMac if using a mac or ./setupCustomPropertiesForLinux if using UNIX. If using Windows:
- Open the “custom.properties” file located in CUCUMBER_ROOT/src/main/resources/configs and modify:
  - automated.testing.home to be CUCUMBER_ROOT (e.g. C:\CucumberForAppian-19.1-SNAPSHOT)
  - download.directory to be CUCUMBER_ROOT/target (e.g. C:\CucumberForAppian-19.1-SNAPSHOT\target)
Run mvn clean test in CUCUMBER_ROOT
The output in the terminal should be similar to what’s displayed below

*NOTE* By default, only the TempoNavigationExample.feature test file will run when you execute the command above due to the “tags” argument in RunCucumberForAppianTest.java

At the top of the TempoNavigationExample.feature file, there is a tag “@Tempo” which corresponds to that in the .java file. To selectively run the tests, you can add or remove tags as you wish. You can completely remove the tags parameter if you’d like to run all of the tests together.

By default, the tool collects usage metrics for analytics purposes.

Developing Custom Cucumber tests

The Cucumber sample tests from above will be a good model to follow when developing your own tests.

To help you out, we have provided a CucumberForAppian Cheatsheet. You can find it individually in the combined files ZIP you downloaded from the App Market. When developing tests, be sure you are using methods for the environment you are testing. For example, if testing sites, use navigation methods that come from the "Sites Methods" scenario. Using methods from a different environment has the potential to break in future releases.

The CheatSheet.feature file lists out all the methods we support and how to invoke them using the @Given, @When, @Then, @But, @And.... and other Cucumber supported annotation

Features

Multiple browser support

Chrome (v64-66)
Firefox (v53-v62)

Benefits

Test your Appian application within minutes of downloading the tool
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated for upgrades to supported Appian versions
Appian design knowledge is not required to create test scripts
Common test case scenarios can be created for reusability throughout test suites
Test scripts are easily updated for new UI changes to a form or interface

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }
Bug Fixes
- Fixed clickOnRecordRelatedAction to function correctly when the Record Summary page contains more than three action items.

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
- Add support for Date Range user filters in Record Types
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other Tempo navigation methods, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
  - NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other Tempo navigation methods, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) toreference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

Cucumber for Appian is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

February 2021 - Release 21.1

Enhancements
- Supports Appian version 21.1

November 2020 - Release 20.4

Enhancements
- Support Chrome capabilities
- Update Cucumber to 6.8.2
- NEW METHOD: Support Stamp Field
- NEW METHOD: Support Tag field
- NEW METHOD: Support signature field
- NEW METHOD: Support record action field
Bug Fixes
- Fix grid row count bug when there is no paging
- Fix getGridColumnRowValue when the grid cell is a button
- Fix clear picker bug when there are multiple selections
- Fix capturing an empty rich text field

September 2020 - Release 20.3

Enhancements
- NEW METHOD: Populates the search box in a dropdown with some text
Bug fixes
- Fixed a bug for custom login submit button

August 2020 - Release 20.2.1

Bug Fixes
- Fixed a bug regarding clicking on card layouts

July 2020 - Release 20.2

Bug Fixes
- Fix bug with milestone click
- Fix toggle box visibility on related action pop up

April 2020 - Release 20.1

Enhancements
- NEW METHOD: click on bar chart *
- NEW METHOD: click on menu widget
- NEW METHOD: click on button with tooltip
- NEW METHOD: verify confirmation dialog header
- NEW METHOD: verify confirmation dialog message
- NEW METHOD: Verify a field is not blank
- NEW METHOD: click on document image link
- NEW METHOD: clear search field in record
- Include all jars in Cucumber
Bug fixes
- Remove pie chart hover for fragility and also make it the page scroll before hovering for firefox
- Clicking on standalone icons by making the xpath less specific
- Fix closing social task bug

January 2020 - Release 19.4.1

Enhancements
- NEW METHOD: star and unstar action with action name
- NEW METHOD: click on icon link with alt text
Bug fixes
- Fixed issues for dropdowns with many options

November 2019 - Release 19.4

Enhancements
- NEW METHOD: verify button with label is enabled
- NEW METHOD: verify button with label is disabled
- NEW METHOD: verify link containing text is not present
- NEW METHOD: verify a box with given label is present
- NEW METHOD: verify a box with given label is not present
- NEW METHOD: verify a section with given label is present
- NEW METHOD: verify a section with given label is not present
- NEW METHOD: verify a card with given accessibility text is present
- NEW METHOD: verify a card with given accessibility text is not present
- NEW METHOD: verify if text is not present anywhere in the user interface
Bug fixes
- Fixed populate first column in a grid when rowheader is set to 1

September 2019 - Release 19.3.1

Enhancements
- Added additional logging for site page navigation

Bug fixes
- Fixed verify text present for text with apostrophe

June 2019 - Release 19.2

Bug fixes
- Support sending news post without participants

May 2019 - Release 19.1.3

Bug fixes
- Fixed the bug that users can not click on menu tabs on Appian 19.1
- Fixed the bug on Read Only field "contains"
- Fixed the bug on sending news post on Appian 19.1

April 2019 - Release 19.1.2

Enhancements

Support Wait For Progress
Support Click on X and Y coordinates on monitor

Bug fixes

Fixed the bug that box layout toggle only acts on the first box

March 2019 - Release 19.1.1

Bug fixes

Fixed error popup caused by loading Automation Extension

February 2019 - Release 19.1

Cucumber For Appian available

Tags: testing, Architecture

Automated Testing With FitNesse for Appian

joel.larin — Tue, 10 Jun 2025 23:23:43 GMT

Current Revision posted to Guide by joel.larin on 6/10/2025 11:23:43 PM

FitNesse for Appian is a client side tool, built on top of FitNesse, that makes it easy to create automated tests on the Appian platform. This tool allows you to create test scripts in a easy to read wiki language that will be run by the system to interact with an Appian application as a human user.

FitNesse for Appian provides an Appian-specific wiki language within FitNesse that maps directly to actions that can be performed in Appian, such as:

Navigating the interface (News, Tasks, Records, Reports, Actions, Sites)
Starting actions and completing tasks
Validating content on record views or in news events
And much more... the complete list is available directly within the tool!

For more information about testing and development best practices when using FitNesse for Appian, visit the FitNesse for Appian Best Practices guide.

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.

Setup

The zip file for the tool can be downloaded from the App Market Public Listings.

Unzip the contents into your root directory or preferred location (e.g. C:\)
In a terminal window navigate to the folder extracted from the zip file (e.g. C:\fitnesse-for-appian). We will refer to this directory as TESTING_HOME throughout this documentation
1. For PC, main commands will be:
  1. dir: used to show contents of current directory (folder)
  2. cd: used to change directory (open a folder), e.g. cd Documents would open the Documents folder. cd .. would go to the parent folder of current folder.
2. For Mac/Linux,
  1. ls: used to show contents of a directory (folder)
  2. cd: used to change directory (open a folder), e.g. cd Documents would open the Documents folder. cd .. would go to the parent folder of current folder.
Open the "custom.properties" file located in TESTING_HOME/configs and change:
1. automated.testing.home to be TESTING_HOME (e.g. C:\FitNesseForAppian)
2. download.directory to be a folder of your choosing
3. chrome.driver.home to be TESTING_HOME/lib/drivers/chromedriver(.exe if using windows, -mac if using a mac, -linux if using UNIX)
4. firefox.driver.home to be TESTING_HOME/lib/drivers/geckodriver(.exe if using windows, -mac if using a mac, -linux64 if using UNIX)
Run start.bat if using windows, start-mac.sh for Mac, and start-unix.sh for UNIX to install and run FitNesse for Appian. Installation should take around 30 seconds and is complete when you see the message "Starting FitNesse on port: 8980". To stop FitNesse for Appian, invoke Ctrl+C in the terminal.

Running your first FitNesse test

Start FitNesse if it isn't already running by running start.bat/start-mac.sh/start-unix.sh depending on your system
Navigate to http://localhost:8980/FitNesseForAppian.Examples.TestExample
Follow the configuration instructions marked by "Please follow the directions below to execute the test"
Click Test at the top of the page

Developing custom tests

To try out the tool further, use the Appian application included in the combined files download (Automated Testing - 1x.x.zip) and import it into your corresponding version of Appian environment.

Navigate to the FitNesseForAppian Cheatsheet and make use of the supported methods to write your own test suite to run against the sample application! Be sure you are using methods for the environment you are testing. For example, if testing sites, use navigation methods that come from the "Sites Methods" scenario. Using methods from a different environment has the potential to break in future releases.

An example test suite run could look like this:

By default, the tool collects usage metrics for analytics purposes. Set collect.metrics=false in the "metrics.properties" file to opt-out of metrics collection.

Features

Multiple browser support

Chrome (v64-66)
Firefox (v53-62)

Benefits

Test your Appian application within minutes of downloading the tool
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated for upgrades to supported Appian versions
Test scripts are written in a wiki language that is very easy to read and synthesize
Appian design knowledge is not required to create test scripts
Common case scenarios can be created for reusability throughout test suites
Isolate test steps into scenarios to perform Spec by Example tests
Test scripts are easily updated for new UI changes to a form or interface

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }
Bug Fixes
- Fixed clickOnRecordRelatedAction to function correctly when the Record Summary page contains more than three action items.

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
- Add support for Date Range user filters in Record Types
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other navigation methods from Tempo, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
- NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other navigation methods from Tempo, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) toreference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

FitNesse for Appian is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

February 2021 - Release 21.1

Enhancements
- Supports Appian version 21.1

November 2020 - Release 20.4

Enhancements
- Support Chrome capabilities
- Update FitNesse version to 20200501
- NEW METHOD: Support Stamp Field
- NEW METHOD: Support Tag field
- NEW METHOD: Support signature field
- NEW METHOD: Support record action field
Bug Fixes
- Fix grid row count bug when there is no paging
- Fix getGridColumnRowValue when the grid cell is a button
- Fix clear picker bug when there are multiple selections
- Fix capturing an empty rich text field

September 2020 - Release 20.3

Enhancements
- NEW METHOD: Populates the search box in a dropdown with some text
Bug Fixes
- Fixed a bug for custom login submit button

August 2020 - Release 20.2.1

Bug fixes
- Fixed a bug regarding clicking on card layouts

July 2020 - Release 20.2

Bug fixes
- Fix bug with milestone click
- Fix toggle box visibility on related action pop up

Apr 2020 - Release 20.1

Enhancements
- NEW METHOD: click on bar chart
- NEW METHOD: click on menu widget
- NEW METHOD: click on button with tooltip
- NEW METHOD: verify confirmation dialog header
- NEW METHOD: verify confirmation dialog message
- NEW METHOD: Verify a field is not blank
- NEW METHOD: click on document image link
- NEW METHOD: clear search field in record
Bug fixes
- Remove pie chart hover for fragility and also make it the page scroll before hovering for firefox
- Clicking on standalone icons by making the xpath less specific
- Fixed closing social task bug

January 2020 - Release 19.4.1

Enhancements
- NEW METHOD: star and unstar action with action name
- NEW METHOD: click on icon link with alt text
Bug fixes
- Fixed issues for dropdowns with many options

November 2019 - Release 19.4

Enhancements
- NEW METHOD: verify button with label is enabled
- NEW METHOD: verify button with label is disabled
- NEW METHOD: verify link containing text is not present
- NEW METHOD: verify a box with given label is present
- NEW METHOD: verify a box with given label is not present
- NEW METHOD: verify a section with given label is present
- NEW METHOD: verify a section with given label is not present
- NEW METHOD: verify a card with given accessibility text is present
- NEW METHOD: verify a card with given accessibility text is not present
- NEW METHOD: verify if text is not present anywhere in the user interface
Bug fixes
- Fixed populate first column in a grid when rowheader is set to 1

September 2019 - Release 19.3.1

Enhancements
- Added additional logging for site page navigation

Bug fixes
- Fixed verify text present for text with apostrophe

Sep 2019 - Release 19.3

Enhancements
- Support gauge field
- Support locating field using placeholder, instructions or tooltip
- NEW METHOD: get gauge field GAUGE_FIELD or GAUGE_FIELD[INDEX] percentage
- NEW METHOD: verify gauge field GAUGE_FIELD or GAUGE_FIELD[INDEX] percentage is PERCENTAGE
- NEW METHOD: populate field with placeholder PLACEHOLDER with VALUE(S)
- NEW METHOD: populate field with instructions INSTRUCTIONS with VALUE(S)
- NEW METHOD: populate field with tooltip TOOLTIP with VALUE(S)
- NEW METHOD: get field with placeholder PLACEHOLDER value
- NEW METHOD: get field with instructions INSTRUCTIONS value
- NEW METHOD: get field with tooltip TOOLTIP value
- NEW METHOD: verify field with placeholder PLACEHOLDER contains VALUE(S)
- NEW METHOD: verify field with instructions INSTRUCTIONS contains VALUE(S)
- NEW METHOD: verify field with tooltip TOOLTIP contains VALUE(S)

June 2019 - Release 19.2

Bug fixes
- Support sending news post without participants

May 2019 - Release 19.1.3

Bug fixes
- Fixed the bug that users can not click on menu tabs on Appian 19.1
- Fixed the bug on Read Only field "contains"
- Fixed the bug on sending news post on Appian 19.1

April 2019 - Release 19.1.2

Enhancements
- Support Wait For Progress
- Support Click on X and Y coordinates on monitor
Bug fixes
- Fixed the bug that box layout toggle only acts on the first box

March 2019 - Release 19.1.1

Bug fixes
- Fixed error popup caused by loading Automation Extension

February 2019 - Release 19.1

Enhancements
- Support Masked Barcode
- Support Vertical Milestone
Bug fixes
- Fixed login with terms for 17.2

January 2019 - Release 18.4.4

Enhancements
- NEW METHOD: populate field with partially matching picker field suggestion
- NEW METHOD: login into URL with username
- NEW METHOD: login into URL with role
- NEW METHOD: wait for seconds
- NEW METHOD: wait for minutes
- NEW METHOD: wait for working

January 2019 - Release 18.4.3

Enhancements
- Add capability to run tests on remote web drivers
Bug fixes
- Fixed milestone step verification
- Fixed section containing validation message verification

December 2018 - Release 18.4.2

Enhancements
- NEW METHOD: populate grid column row with partially matching picker field suggestion
- Other minor enhancements

November 2018 - Release 18.4.1

Enhancements
- Documentation overhaul
- Improved out of the box examples
- Updated information about supported Appian versions

October 2018 - Release 18.4

Enhancements
- NEW METHOD: open settings menu
- NEW METHOD: open user profile
- NEW METHOD: use discoverability to navigate to
- NEW METHOD: close social task
- NEW METHOD: verify task feed containing text is not present
- Added usage metrics and corresponding metrics.properties file
Bug Fixes
- Fixed login with terms

August 2018 - Release 18.3.1

Enhancements
- Added new methods for hovering and clicking on profile links and circles in news posts
Bug fixes
- Fixed NoClassDefFoundError for TempoEncryptedTextField introduced in 18.3

August 2018 - Release 18.3

Enhancements
- NEW METHOD: create a news post
- NEW METHOD: send kudos
- NEW METHOD: send messages
- NEW METHOD: send tasks
- NEW METHOD: sort tasks
- NEW METHOD: star a news feed item
- NEW METHOD: filter news feed
- NEW METHOD: navigate to link in news post
- NEW METHOD: generic assertion that text is present
Bug Fixes
- Fixed bug with MilestoneField pre-18.2
- Added WebContentField to 18.1

May 2018 - Release 18.2.1

Enhancements
- Auto login to previously set URL
- Milestones in side by side layout
- Card click identified by link name index
- NEW METHOD: verify video (not) present
- NEW METHOD: verify web content (not) present
- Updated test app for 18.2
Bug fixes
- User pickers not selecting correct field value
- Card click not working in Firefox

May 2018 - Release 18.2

Enhancements
- Added support for 18.2
- NEW METHOD: click on card
- Updated select grid method to account for the row highlight selection style
- Added test app for 18.2
Bug fixes
- Fixed fragility of file upload

March 2018 - Release 18.1.4

Enhancements
- Added Support for finding grid indices
- Added the ability to delete documents downloaded by Fitnesse

February 2018 - Release 18.1.3

Bug fixes
- Updated mac and linux scripts shebang to /bin/sh

February 2018 - Release 18.1.2

Bug fixes
- Fixed Windows start script to run FitNesse successfully
- Fixed the example page and default fixture to use TempoFixture instead of SitesFixture

January 2018 - Release 18.1.1

Enhancements
- Updated 16.3 Test Zip
Bug fixes
- Fixed issue with navigating to /logout URL
- Fixed Multiselect dropdown on 16.3
- Fixed Record filter clearing on 16.3

January 2018 - Release 18.1

Enhancements
- Added support for 18.1
- Added test app for 17.3 and 18.1

January 2018 - Release 17.4.1

Enhancements
- Add ability to accept Tasks
- Add ability to populate Record Type user filter
- Add ability to download files
- Make LinkField capturable
- Added advanced functionality to adjust dates, including setting dates in the past
- If url contains "/suite", remove anything after it to prevent navigation failure.
Bug fixes
- Updated chromedriver to version 2.33
- Updated startup scripts to pass FitNesseRoot properly
- Always logout before login in case a previous test failed and didn't logout
- Made Firefox webdrivers executable
- Fix BarcodeField not working in 17.1+

November 2017 - Release 17.4

Enhancement
- Change FitNesse usernames
- Allow FitNesse tests to hit an arbitrary endpoint through an environment variable
Bug fixes
- Mac Firefox date and dateTime field tests no longer throw an null character
- Dropdown tests does not read duplicate values

October 2017 - Release 17.3.2

Enhancements
- Updated test application to run initialize on import
Bug fixes
- Checkboxes that are too short are not checked

October 2017 - Release 17.3.1

Enhancements
- Updated Test App to create users
- Documentation tweaks/ Readme tweaks
Bug fixes
- Allowed login for internationalized pages
- Fixed an issue preventing searching in record list view
- Changed the way the start-unix script was sourced

September 2017 - Release 17.3

Enhancements
- Supports Appian version 17.3
- Ability to configure custom login page
- Updated the following components to be compatible with the latest Appian Hotfix Package for 17.1 (G), and 17.2 (D):
  - Paging Grid
  - Editable Grid
- Scripts now recognize new loading bar and wait for it to be done before continuing
- Added shell scripts and drivers for F4A on Mac and Linux
Bug fixes
- Browser is maximized by default which ensures the "Sign Out" button is always visibleNote: Previously tests could hang waiting to logout if the browser window was within a specific size range where the "Sign Out" button got hidden

Tags: testing, Platform, Architecture

Automated Testing with Appian Selenium API

joel.larin — Tue, 10 Jun 2025 23:23:25 GMT

Current Revision posted to Guide by joel.larin on 6/10/2025 11:23:25 PM

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.
An IDE, such as IntelliJ IDEA or Eclipse

Setup

The Appian Selenium API plug-in is a Java library which allows you to write automated tests for your Appian UIs. It contains methods which allow you to interact with Appian components in a browser. It provides methods and fixtures to interact with Appian applications in its various environments, e.g. Tempo or Sites. When writing tests, be sure to use methods from the correct fixture for the environment under test, e.g. use SitesFixture where possible to test Sites. Methods defined in fixtures that are intended for different environments are not guaranteed to work in future versions of the plugin.

It can be used in a Java application or integrated directly into any Selenium or Java-based testing tool.

Appian Selenium API contains the underlying Selenium methods used by Cucumber for Appian and FitNesse for Appian, but offers you more flexibility by allowing you to define your own automated test cases. You can create your own Cucumber Step Definitions, your own testNG test, or the Java Framework of your choosing. You are no longer tied to Cucumber for Appian or FitNesse for Appian yet you get the same ease and simplicity of those respective frameworks.

Open this project in an IDE, such as IntelliJ IDEA or Eclipse.
Update configurations:
1. Open file configs/custom.properties
  1. Update automated.testing.home with the path to this installation. Examples:
    1. Windows: automated.testing.home=C:\\testFolder\\appian-selenium-api-example-java
    2. Mac: automated.testing.home=/Users/tester/Desktop/appian-selenium-api-example-java
  2. Update chrome.driver.home with the path to the Chrome driver that comes with this installation. Examples: * Windows: automated.testing.home=C:\\testFolder\\appian-selenium-api-example-java\\lib\\drivers\\chromedriver.exe * Mac: automated.testing.home=/Users/tester/Desktop/appian-selenium-api-example-java/lib/drivers/chromedriver-mac
2. Open file configs/users.properties, for each username used in a test add a line in the format of <username>=<password> to this file.
  1. If you prefer not to disclose your password in plain text, you can also choose to use com.appiancorp.ps.automatedtest.fixture.BaseFixture.loginIntoWithUsernameAndPassword fixture method to login by passing in the password from a system property value.
Open "src/main/java/com/appiancorp/example/HelloAppian.java":
1. Update TEST_SITE_URL to your Appian URL, such as protected static String TEST_SITE_URL = "https://example.appiancloud.com/suite";
2. Update TEST_USERNAME with a username, such as protected static String TEST_USERNAME = "tester.tester"; * Make sure this user exists in configs/users.properties
Run the main() method of this class:
1. You should see that a Chrome browser will open up, and the fixture commands in HelloAppian.java will execute accordingly.
2. Note that this test will fail since your site might not have an action "Create a Case" under menu "Actions" that opens up an interface that has a "Submit" button.

Features

Multiple browser support

Chrome
Firefox

Benefits

Define your own integration tests without being limited by a third-party testing tool
Selenium-based test scripts can be created for reusability throughout test suites
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated when upgrading between supported Appian versions
Test scripts are easily updated for new UI changes to a form or interface
Appian design knowledge is not required to create test scripts

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }
Bug Fixes
- Fixed clickOnRecordRelatedAction to function correctly when the Record Summary page contains more than three action items.

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
Bug Fixes
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the clickOnMenu method defined in TempoFixtures for site environments. clickOnMenu, and other navigation methods defined in TempoFixtures, are guaranteed to work only in Tempo environments. Use the clickOnSitePage method defined in SitesFixtures instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
  - NOTE: Updates to site navigation in the 23.2 product breaks the use of the clickOnMenu method defined in TempoFixtures for site environments. clickOnMenu, and other navigation methods defined in TempoFixtures, are guaranteed to work only in Tempo environments. Use the clickOnSitePage method defined in SitesFixtures instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) to reference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

Appian Selenium API is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

March 2021 - Release 21.1

Appian Selenium API is released and supported

Tags: testing, Architecture

Automated Testing With Cucumber For Appian

joel.larin — Tue, 10 Jun 2025 23:22:12 GMT

Revision 20 posted to Guide by joel.larin on 6/10/2025 11:22:12 PM

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.
Access to Terminal if you’re on Mac/Linux or Command Prompt if on Windows
Apache Maven tool

Installation

The zip file for the tool can be downloaded from the AppMarket.

Unzip the contents into any directory (e.g. C:/)
In a terminal window, navigate to the ‘CucumberForAppian-x’ (where x corresponds to the version number) folder extracted from the zip file (e.g. C:\CucumberForAppian-19.1-SNAPSHOT)
- We will refer to this directory as CUCUMBER_ROOT from now on

Running Cucumber Tests

Navigate to src/test/resources from CUCUMBER_ROOT
Edit either the ApplicationExample.feature or TempoNavigationExample.feature file
- “BROWSER” - Chrome or Firefox
- “APPIAN_URL” - e.g. https://site-name.appiancloud.com
- “APPIAN_VERSION” - e.g. 18.4
- “APPIAN_LOCALE” - en_US or en_GB
- “APPIAN_USERNAME” - e.g. fitnesse.user
- The comments on the top of the .feature files will also help you in setting up
- The completed feature file should look like the one shown below:

In CUCUMBER_ROOT, run ./setupCustomPropertiesForMac if using a mac or ./setupCustomPropertiesForLinux if using UNIX. If using Windows:
- Open the “custom.properties” file located in CUCUMBER_ROOT/src/main/resources/configs and modify:
  - automated.testing.home to be CUCUMBER_ROOT (e.g. C:\CucumberForAppian-19.1-SNAPSHOT)
  - download.directory to be CUCUMBER_ROOT/target (e.g. C:\CucumberForAppian-19.1-SNAPSHOT\target)
Run mvn clean test in CUCUMBER_ROOT
The output in the terminal should be similar to what’s displayed below

*NOTE* By default, only the TempoNavigationExample.feature test file will run when you execute the command above due to the “tags” argument in RunCucumberForAppianTest.java

By default, the tool collects usage metrics for analytics purposes.

Developing Custom Cucumber tests

The Cucumber sample tests from above will be a good model to follow when developing your own tests.

The CheatSheet.feature file lists out all the methods we support and how to invoke them using the @Given, @When, @Then, @But, @And.... and other Cucumber supported annotation

Features

Multiple browser support

Chrome (v64-66)
Firefox (v53-v62)

Benefits

Test your Appian application within minutes of downloading the tool
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated for upgrades to supported Appian versions
Appian design knowledge is not required to create test scripts
Common test case scenarios can be created for reusability throughout test suites
Test scripts are easily updated for new UI changes to a form or interface

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }
Bug Fixes
- Fixed clickOnRecordRelatedAction to function correctly when the Record Summary page contains more than three action items.

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
- Add support for Date Range user filters in Record Types
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other Tempo navigation methods, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
  - NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other Tempo navigation methods, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) toreference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

Cucumber for Appian is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

February 2021 - Release 21.1

Enhancements
- Supports Appian version 21.1

November 2020 - Release 20.4

Enhancements
- Support Chrome capabilities
- Update Cucumber to 6.8.2
- NEW METHOD: Support Stamp Field
- NEW METHOD: Support Tag field
- NEW METHOD: Support signature field
- NEW METHOD: Support record action field
Bug Fixes
- Fix grid row count bug when there is no paging
- Fix getGridColumnRowValue when the grid cell is a button
- Fix clear picker bug when there are multiple selections
- Fix capturing an empty rich text field

September 2020 - Release 20.3

Enhancements
- NEW METHOD: Populates the search box in a dropdown with some text
Bug fixes
- Fixed a bug for custom login submit button

August 2020 - Release 20.2.1

Bug Fixes
- Fixed a bug regarding clicking on card layouts

July 2020 - Release 20.2

Bug Fixes
- Fix bug with milestone click
- Fix toggle box visibility on related action pop up

April 2020 - Release 20.1

Enhancements
- NEW METHOD: click on bar chart *
- NEW METHOD: click on menu widget
- NEW METHOD: click on button with tooltip
- NEW METHOD: verify confirmation dialog header
- NEW METHOD: verify confirmation dialog message
- NEW METHOD: Verify a field is not blank
- NEW METHOD: click on document image link
- NEW METHOD: clear search field in record
- Include all jars in Cucumber
Bug fixes
- Remove pie chart hover for fragility and also make it the page scroll before hovering for firefox
- Clicking on standalone icons by making the xpath less specific
- Fix closing social task bug

January 2020 - Release 19.4.1

Enhancements
- NEW METHOD: star and unstar action with action name
- NEW METHOD: click on icon link with alt text
Bug fixes
- Fixed issues for dropdowns with many options

November 2019 - Release 19.4

Enhancements
- NEW METHOD: verify button with label is enabled
- NEW METHOD: verify button with label is disabled
- NEW METHOD: verify link containing text is not present
- NEW METHOD: verify a box with given label is present
- NEW METHOD: verify a box with given label is not present
- NEW METHOD: verify a section with given label is present
- NEW METHOD: verify a section with given label is not present
- NEW METHOD: verify a card with given accessibility text is present
- NEW METHOD: verify a card with given accessibility text is not present
- NEW METHOD: verify if text is not present anywhere in the user interface
Bug fixes
- Fixed populate first column in a grid when rowheader is set to 1

September 2019 - Release 19.3.1

Enhancements
- Added additional logging for site page navigation

Bug fixes
- Fixed verify text present for text with apostrophe

June 2019 - Release 19.2

Bug fixes
- Support sending news post without participants

May 2019 - Release 19.1.3

Bug fixes
- Fixed the bug that users can not click on menu tabs on Appian 19.1
- Fixed the bug on Read Only field "contains"
- Fixed the bug on sending news post on Appian 19.1

April 2019 - Release 19.1.2

Enhancements

Support Wait For Progress
Support Click on X and Y coordinates on monitor

Bug fixes

Fixed the bug that box layout toggle only acts on the first box

March 2019 - Release 19.1.1

Bug fixes

Fixed error popup caused by loading Automation Extension

February 2019 - Release 19.1

Cucumber For Appian available

Tags: testing, Architecture

Automated Testing With Cucumber For Appian

Appian Max Team — Wed, 05 Mar 2025 20:53:19 GMT

Revision 19 posted to Guide by Appian Max Team on 3/5/2025 8:53:19 PM

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.
Access to Terminal if you’re on Mac/Linux or Command Prompt if on Windows
Apache Maven tool

Installation

The zip file for the tool can be downloaded from the AppMarket.

Unzip the contents into any directory (e.g. C:/)
In a terminal window, navigate to the ‘CucumberForAppian-x’ (where x corresponds to the version number) folder extracted from the zip file (e.g. C:\CucumberForAppian-19.1-SNAPSHOT)
- We will refer to this directory as CUCUMBER_ROOT from now on

Running Cucumber Tests

Navigate to src/test/resources from CUCUMBER_ROOT
Edit either the ApplicationExample.feature or TempoNavigationExample.feature file
- “BROWSER” - Chrome or Firefox
- “APPIAN_URL” - e.g. https://site-name.appiancloud.com
- “APPIAN_VERSION” - e.g. 18.4
- “APPIAN_LOCALE” - en_US or en_GB
- “APPIAN_USERNAME” - e.g. fitnesse.user
- The comments on the top of the .feature files will also help you in setting up
- The completed feature file should look like the one shown below:

In CUCUMBER_ROOT, run ./setupCustomPropertiesForMac if using a mac or ./setupCustomPropertiesForLinux if using UNIX. If using Windows:
- Open the “custom.properties” file located in CUCUMBER_ROOT/src/main/resources/configs and modify:
  - automated.testing.home to be CUCUMBER_ROOT (e.g. C:\CucumberForAppian-19.1-SNAPSHOT)
  - download.directory to be CUCUMBER_ROOT/target (e.g. C:\CucumberForAppian-19.1-SNAPSHOT\target)
Run mvn clean test in CUCUMBER_ROOT
The output in the terminal should be similar to what’s displayed below

*NOTE* By default, only the TempoNavigationExample.feature test file will run when you execute the command above due to the “tags” argument in RunCucumberForAppianTest.java

By default, the tool collects usage metrics for analytics purposes.

Developing Custom Cucumber tests

The Cucumber sample tests from above will be a good model to follow when developing your own tests.

The CheatSheet.feature file lists out all the methods we support and how to invoke them using the @Given, @When, @Then, @But, @And.... and other Cucumber supported annotation

Features

Multiple browser support

Chrome (v64-66)
Firefox (v53-v62)

Benefits

Test your Appian application within minutes of downloading the tool
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated for upgrades to supported Appian versions
Appian design knowledge is not required to create test scripts
Common test case scenarios can be created for reusability throughout test suites
Test scripts are easily updated for new UI changes to a form or interface

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }
Bug Fixes
- Fixed clickOnRecordRelatedAction to function correctly when the Record Summary page contains more than three action items.

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
- Add support for Date Range user filters in Record Types
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other Tempo navigation methods, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
  - NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other Tempo navigation methods, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) toreference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

Cucumber for Appian is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

February 2021 - Release 21.1

Enhancements
- Supports Appian version 21.1

November 2020 - Release 20.4

Enhancements
- Support Chrome capabilities
- Update Cucumber to 6.8.2
- NEW METHOD: Support Stamp Field
- NEW METHOD: Support Tag field
- NEW METHOD: Support signature field
- NEW METHOD: Support record action field
Bug Fixes
- Fix grid row count bug when there is no paging
- Fix getGridColumnRowValue when the grid cell is a button
- Fix clear picker bug when there are multiple selections
- Fix capturing an empty rich text field

September 2020 - Release 20.3

Enhancements
- NEW METHOD: Populates the search box in a dropdown with some text
Bug fixes
- Fixed a bug for custom login submit button

August 2020 - Release 20.2.1

Bug Fixes
- Fixed a bug regarding clicking on card layouts

July 2020 - Release 20.2

Bug Fixes
- Fix bug with milestone click
- Fix toggle box visibility on related action pop up

April 2020 - Release 20.1

Enhancements
- NEW METHOD: click on bar chart *
- NEW METHOD: click on menu widget
- NEW METHOD: click on button with tooltip
- NEW METHOD: verify confirmation dialog header
- NEW METHOD: verify confirmation dialog message
- NEW METHOD: Verify a field is not blank
- NEW METHOD: click on document image link
- NEW METHOD: clear search field in record
- Include all jars in Cucumber
Bug fixes
- Remove pie chart hover for fragility and also make it the page scroll before hovering for firefox
- Clicking on standalone icons by making the xpath less specific
- Fix closing social task bug

January 2020 - Release 19.4.1

Enhancements
- NEW METHOD: star and unstar action with action name
- NEW METHOD: click on icon link with alt text
Bug fixes
- Fixed issues for dropdowns with many options

November 2019 - Release 19.4

Enhancements
- NEW METHOD: verify button with label is enabled
- NEW METHOD: verify button with label is disabled
- NEW METHOD: verify link containing text is not present
- NEW METHOD: verify a box with given label is present
- NEW METHOD: verify a box with given label is not present
- NEW METHOD: verify a section with given label is present
- NEW METHOD: verify a section with given label is not present
- NEW METHOD: verify a card with given accessibility text is present
- NEW METHOD: verify a card with given accessibility text is not present
- NEW METHOD: verify if text is not present anywhere in the user interface
Bug fixes
- Fixed populate first column in a grid when rowheader is set to 1

September 2019 - Release 19.3.1

Enhancements
- Added additional logging for site page navigation

Bug fixes
- Fixed verify text present for text with apostrophe

June 2019 - Release 19.2

Bug fixes
- Support sending news post without participants

May 2019 - Release 19.1.3

Bug fixes
- Fixed the bug that users can not click on menu tabs on Appian 19.1
- Fixed the bug on Read Only field "contains"
- Fixed the bug on sending news post on Appian 19.1

April 2019 - Release 19.1.2

Enhancements

Support Wait For Progress
Support Click on X and Y coordinates on monitor

Bug fixes

Fixed the bug that box layout toggle only acts on the first box

March 2019 - Release 19.1.1

Bug fixes

Fixed error popup caused by loading Automation Extension

February 2019 - Release 19.1

Cucumber For Appian available

Tags: testing, Architecture

Automated Testing With FitNesse for Appian

Appian Max Team — Wed, 05 Mar 2025 20:52:22 GMT

Revision 20 posted to Guide by Appian Max Team on 3/5/2025 8:52:22 PM

FitNesse for Appian provides an Appian-specific wiki language within FitNesse that maps directly to actions that can be performed in Appian, such as:

Navigating the interface (News, Tasks, Records, Reports, Actions, Sites)
Starting actions and completing tasks
Validating content on record views or in news events
And much more... the complete list is available directly within the tool!

For more information about testing and development best practices when using FitNesse for Appian, visit the FitNesse for Appian Best Practices guide.

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.

Setup

The zip file for the tool can be downloaded from the App Market Public Listings.

Unzip the contents into your root directory or preferred location (e.g. C:\)
In a terminal window navigate to the folder extracted from the zip file (e.g. C:\fitnesse-for-appian). We will refer to this directory as TESTING_HOME throughout this documentation
1. For PC, main commands will be:
  1. dir: used to show contents of current directory (folder)
  2. cd: used to change directory (open a folder), e.g. cd Documents would open the Documents folder. cd .. would go to the parent folder of current folder.
2. For Mac/Linux,
  1. ls: used to show contents of a directory (folder)
  2. cd: used to change directory (open a folder), e.g. cd Documents would open the Documents folder. cd .. would go to the parent folder of current folder.
Open the "custom.properties" file located in TESTING_HOME/configs and change:
1. automated.testing.home to be TESTING_HOME (e.g. C:\FitNesseForAppian)
2. download.directory to be a folder of your choosing
3. chrome.driver.home to be TESTING_HOME/lib/drivers/chromedriver(.exe if using windows, -mac if using a mac, -linux if using UNIX)
4. firefox.driver.home to be TESTING_HOME/lib/drivers/geckodriver(.exe if using windows, -mac if using a mac, -linux64 if using UNIX)
Run start.bat if using windows, start-mac.sh for Mac, and start-unix.sh for UNIX to install and run FitNesse for Appian. Installation should take around 30 seconds and is complete when you see the message "Starting FitNesse on port: 8980". To stop FitNesse for Appian, invoke Ctrl+C in the terminal.

Running your first FitNesse test

Start FitNesse if it isn't already running by running start.bat/start-mac.sh/start-unix.sh depending on your system
Navigate to http://localhost:8980/FitNesseForAppian.Examples.TestExample
Follow the configuration instructions marked by "Please follow the directions below to execute the test"
Click Test at the top of the page

Developing custom tests

To try out the tool further, use the Appian application included in the combined files download (Automated Testing - 1x.x.zip) and import it into your corresponding version of Appian environment.

An example test suite run could look like this:

By default, the tool collects usage metrics for analytics purposes. Set collect.metrics=false in the "metrics.properties" file to opt-out of metrics collection.

Features

Multiple browser support

Chrome (v64-66)
Firefox (v53-62)

Benefits

Test your Appian application within minutes of downloading the tool
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated for upgrades to supported Appian versions
Test scripts are written in a wiki language that is very easy to read and synthesize
Appian design knowledge is not required to create test scripts
Common case scenarios can be created for reusability throughout test suites
Isolate test steps into scenarios to perform Spec by Example tests
Test scripts are easily updated for new UI changes to a form or interface

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }
Bug Fixes
- Fixed clickOnRecordRelatedAction to function correctly when the Record Summary page contains more than three action items.

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
- Add support for Date Range user filters in Record Types
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other navigation methods from Tempo, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
- NOTE: Updates to site navigation in the 23.2 product breaks the use of the "click on menu" method in site environments. "click on menu", and other navigation methods from Tempo, are guaranteed to work only in Tempo environments. Use the "click on site page" method instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) toreference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

FitNesse for Appian is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

February 2021 - Release 21.1

Enhancements
- Supports Appian version 21.1

November 2020 - Release 20.4

Enhancements
- Support Chrome capabilities
- Update FitNesse version to 20200501
- NEW METHOD: Support Stamp Field
- NEW METHOD: Support Tag field
- NEW METHOD: Support signature field
- NEW METHOD: Support record action field
Bug Fixes
- Fix grid row count bug when there is no paging
- Fix getGridColumnRowValue when the grid cell is a button
- Fix clear picker bug when there are multiple selections
- Fix capturing an empty rich text field

September 2020 - Release 20.3

Enhancements
- NEW METHOD: Populates the search box in a dropdown with some text
Bug Fixes
- Fixed a bug for custom login submit button

August 2020 - Release 20.2.1

Bug fixes
- Fixed a bug regarding clicking on card layouts

July 2020 - Release 20.2

Bug fixes
- Fix bug with milestone click
- Fix toggle box visibility on related action pop up

Apr 2020 - Release 20.1

Enhancements
- NEW METHOD: click on bar chart
- NEW METHOD: click on menu widget
- NEW METHOD: click on button with tooltip
- NEW METHOD: verify confirmation dialog header
- NEW METHOD: verify confirmation dialog message
- NEW METHOD: Verify a field is not blank
- NEW METHOD: click on document image link
- NEW METHOD: clear search field in record
Bug fixes
- Remove pie chart hover for fragility and also make it the page scroll before hovering for firefox
- Clicking on standalone icons by making the xpath less specific
- Fixed closing social task bug

January 2020 - Release 19.4.1

Enhancements
- NEW METHOD: star and unstar action with action name
- NEW METHOD: click on icon link with alt text
Bug fixes
- Fixed issues for dropdowns with many options

November 2019 - Release 19.4

Enhancements
- NEW METHOD: verify button with label is enabled
- NEW METHOD: verify button with label is disabled
- NEW METHOD: verify link containing text is not present
- NEW METHOD: verify a box with given label is present
- NEW METHOD: verify a box with given label is not present
- NEW METHOD: verify a section with given label is present
- NEW METHOD: verify a section with given label is not present
- NEW METHOD: verify a card with given accessibility text is present
- NEW METHOD: verify a card with given accessibility text is not present
- NEW METHOD: verify if text is not present anywhere in the user interface
Bug fixes
- Fixed populate first column in a grid when rowheader is set to 1

September 2019 - Release 19.3.1

Enhancements
- Added additional logging for site page navigation

Bug fixes
- Fixed verify text present for text with apostrophe

Sep 2019 - Release 19.3

Enhancements
- Support gauge field
- Support locating field using placeholder, instructions or tooltip
- NEW METHOD: get gauge field GAUGE_FIELD or GAUGE_FIELD[INDEX] percentage
- NEW METHOD: verify gauge field GAUGE_FIELD or GAUGE_FIELD[INDEX] percentage is PERCENTAGE
- NEW METHOD: populate field with placeholder PLACEHOLDER with VALUE(S)
- NEW METHOD: populate field with instructions INSTRUCTIONS with VALUE(S)
- NEW METHOD: populate field with tooltip TOOLTIP with VALUE(S)
- NEW METHOD: get field with placeholder PLACEHOLDER value
- NEW METHOD: get field with instructions INSTRUCTIONS value
- NEW METHOD: get field with tooltip TOOLTIP value
- NEW METHOD: verify field with placeholder PLACEHOLDER contains VALUE(S)
- NEW METHOD: verify field with instructions INSTRUCTIONS contains VALUE(S)
- NEW METHOD: verify field with tooltip TOOLTIP contains VALUE(S)

June 2019 - Release 19.2

Bug fixes
- Support sending news post without participants

May 2019 - Release 19.1.3

Bug fixes
- Fixed the bug that users can not click on menu tabs on Appian 19.1
- Fixed the bug on Read Only field "contains"
- Fixed the bug on sending news post on Appian 19.1

April 2019 - Release 19.1.2

Enhancements
- Support Wait For Progress
- Support Click on X and Y coordinates on monitor
Bug fixes
- Fixed the bug that box layout toggle only acts on the first box

March 2019 - Release 19.1.1

Bug fixes
- Fixed error popup caused by loading Automation Extension

February 2019 - Release 19.1

Enhancements
- Support Masked Barcode
- Support Vertical Milestone
Bug fixes
- Fixed login with terms for 17.2

January 2019 - Release 18.4.4

Enhancements
- NEW METHOD: populate field with partially matching picker field suggestion
- NEW METHOD: login into URL with username
- NEW METHOD: login into URL with role
- NEW METHOD: wait for seconds
- NEW METHOD: wait for minutes
- NEW METHOD: wait for working

January 2019 - Release 18.4.3

Enhancements
- Add capability to run tests on remote web drivers
Bug fixes
- Fixed milestone step verification
- Fixed section containing validation message verification

December 2018 - Release 18.4.2

Enhancements
- NEW METHOD: populate grid column row with partially matching picker field suggestion
- Other minor enhancements

November 2018 - Release 18.4.1

Enhancements
- Documentation overhaul
- Improved out of the box examples
- Updated information about supported Appian versions

October 2018 - Release 18.4

Enhancements
- NEW METHOD: open settings menu
- NEW METHOD: open user profile
- NEW METHOD: use discoverability to navigate to
- NEW METHOD: close social task
- NEW METHOD: verify task feed containing text is not present
- Added usage metrics and corresponding metrics.properties file
Bug Fixes
- Fixed login with terms

August 2018 - Release 18.3.1

Enhancements
- Added new methods for hovering and clicking on profile links and circles in news posts
Bug fixes
- Fixed NoClassDefFoundError for TempoEncryptedTextField introduced in 18.3

August 2018 - Release 18.3

Enhancements
- NEW METHOD: create a news post
- NEW METHOD: send kudos
- NEW METHOD: send messages
- NEW METHOD: send tasks
- NEW METHOD: sort tasks
- NEW METHOD: star a news feed item
- NEW METHOD: filter news feed
- NEW METHOD: navigate to link in news post
- NEW METHOD: generic assertion that text is present
Bug Fixes
- Fixed bug with MilestoneField pre-18.2
- Added WebContentField to 18.1

May 2018 - Release 18.2.1

Enhancements
- Auto login to previously set URL
- Milestones in side by side layout
- Card click identified by link name index
- NEW METHOD: verify video (not) present
- NEW METHOD: verify web content (not) present
- Updated test app for 18.2
Bug fixes
- User pickers not selecting correct field value
- Card click not working in Firefox

May 2018 - Release 18.2

Enhancements
- Added support for 18.2
- NEW METHOD: click on card
- Updated select grid method to account for the row highlight selection style
- Added test app for 18.2
Bug fixes
- Fixed fragility of file upload

March 2018 - Release 18.1.4

Enhancements
- Added Support for finding grid indices
- Added the ability to delete documents downloaded by Fitnesse

February 2018 - Release 18.1.3

Bug fixes
- Updated mac and linux scripts shebang to /bin/sh

February 2018 - Release 18.1.2

Bug fixes
- Fixed Windows start script to run FitNesse successfully
- Fixed the example page and default fixture to use TempoFixture instead of SitesFixture

January 2018 - Release 18.1.1

Enhancements
- Updated 16.3 Test Zip
Bug fixes
- Fixed issue with navigating to /logout URL
- Fixed Multiselect dropdown on 16.3
- Fixed Record filter clearing on 16.3

January 2018 - Release 18.1

Enhancements
- Added support for 18.1
- Added test app for 17.3 and 18.1

January 2018 - Release 17.4.1

Enhancements
- Add ability to accept Tasks
- Add ability to populate Record Type user filter
- Add ability to download files
- Make LinkField capturable
- Added advanced functionality to adjust dates, including setting dates in the past
- If url contains "/suite", remove anything after it to prevent navigation failure.
Bug fixes
- Updated chromedriver to version 2.33
- Updated startup scripts to pass FitNesseRoot properly
- Always logout before login in case a previous test failed and didn't logout
- Made Firefox webdrivers executable
- Fix BarcodeField not working in 17.1+

November 2017 - Release 17.4

Enhancement
- Change FitNesse usernames
- Allow FitNesse tests to hit an arbitrary endpoint through an environment variable
Bug fixes
- Mac Firefox date and dateTime field tests no longer throw an null character
- Dropdown tests does not read duplicate values

October 2017 - Release 17.3.2

Enhancements
- Updated test application to run initialize on import
Bug fixes
- Checkboxes that are too short are not checked

October 2017 - Release 17.3.1

Enhancements
- Updated Test App to create users
- Documentation tweaks/ Readme tweaks
Bug fixes
- Allowed login for internationalized pages
- Fixed an issue preventing searching in record list view
- Changed the way the start-unix script was sourced

September 2017 - Release 17.3

Enhancements
- Supports Appian version 17.3
- Ability to configure custom login page
- Updated the following components to be compatible with the latest Appian Hotfix Package for 17.1 (G), and 17.2 (D):
  - Paging Grid
  - Editable Grid
- Scripts now recognize new loading bar and wait for it to be done before continuing
- Added shell scripts and drivers for F4A on Mac and Linux
Bug fixes
- Browser is maximized by default which ensures the "Sign Out" button is always visibleNote: Previously tests could hang waiting to logout if the browser window was within a specific size range where the "Sign Out" button got hidden

Tags: testing, Platform, Architecture

Automated Testing with Appian Selenium API

Appian Max Team — Wed, 05 Mar 2025 20:51:00 GMT

Revision 34 posted to Guide by Appian Max Team on 3/5/2025 8:51:00 PM

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.
An IDE, such as IntelliJ IDEA or Eclipse

Setup

It can be used in a Java application or integrated directly into any Selenium or Java-based testing tool.

Open this project in an IDE, such as IntelliJ IDEA or Eclipse.
Update configurations:
1. Open file configs/custom.properties
  1. Update automated.testing.home with the path to this installation. Examples:
    1. Windows: automated.testing.home=C:\\testFolder\\appian-selenium-api-example-java
    2. Mac: automated.testing.home=/Users/tester/Desktop/appian-selenium-api-example-java
  2. Update chrome.driver.home with the path to the Chrome driver that comes with this installation. Examples: * Windows: automated.testing.home=C:\\testFolder\\appian-selenium-api-example-java\\lib\\drivers\\chromedriver.exe * Mac: automated.testing.home=/Users/tester/Desktop/appian-selenium-api-example-java/lib/drivers/chromedriver-mac
2. Open file configs/users.properties, for each username used in a test add a line in the format of <username>=<password> to this file.
  1. If you prefer not to disclose your password in plain text, you can also choose to use com.appiancorp.ps.automatedtest.fixture.BaseFixture.loginIntoWithUsernameAndPassword fixture method to login by passing in the password from a system property value.
Open "src/main/java/com/appiancorp/example/HelloAppian.java":
1. Update TEST_SITE_URL to your Appian URL, such as protected static String TEST_SITE_URL = "https://example.appiancloud.com/suite";
2. Update TEST_USERNAME with a username, such as protected static String TEST_USERNAME = "tester.tester"; * Make sure this user exists in configs/users.properties
Run the main() method of this class:
1. You should see that a Chrome browser will open up, and the fixture commands in HelloAppian.java will execute accordingly.
2. Note that this test will fail since your site might not have an action "Create a Case" under menu "Actions" that opens up an interface that has a "Submit" button.

Features

Multiple browser support

Chrome
Firefox

Benefits

Define your own integration tests without being limited by a third-party testing tool
Selenium-based test scripts can be created for reusability throughout test suites
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated when upgrading between supported Appian versions
Test scripts are easily updated for new UI changes to a form or interface
Appian design knowledge is not required to create test scripts

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }
Bug Fixes
- Fixed clickOnRecordRelatedAction to function correctly when the Record Summary page contains more than three action items.

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
Bug Fixes
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the clickOnMenu method defined in TempoFixtures for site environments. clickOnMenu, and other navigation methods defined in TempoFixtures, are guaranteed to work only in Tempo environments. Use the clickOnSitePage method defined in SitesFixtures instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
  - NOTE: Updates to site navigation in the 23.2 product breaks the use of the clickOnMenu method defined in TempoFixtures for site environments. clickOnMenu, and other navigation methods defined in TempoFixtures, are guaranteed to work only in Tempo environments. Use the clickOnSitePage method defined in SitesFixtures instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) to reference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

Appian Selenium API is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

March 2021 - Release 21.1

Appian Selenium API is released and supported

Tags: testing, Architecture

Automated Testing with Appian Selenium API

Appian Max Team — Wed, 05 Mar 2025 20:48:14 GMT

Revision 33 posted to Guide by Appian Max Team on 3/5/2025 8:48:14 PM

Requirements

Appian 22.2 and above
Java Runtime Environment 11
Chrome or Firefox browsers
If using Chrome, we recommend using Chrome For Testing for a more consistent testing experience.
An IDE, such as IntelliJ IDEA or Eclipse

Setup

It can be used in a Java application or integrated directly into any Selenium or Java-based testing tool.

Open this project in an IDE, such as IntelliJ IDEA or Eclipse.
Update configurations:
1. Open file configs/custom.properties
  1. Update automated.testing.home with the path to this installation. Examples:
    1. Windows: automated.testing.home=C:\\testFolder\\appian-selenium-api-example-java
    2. Mac: automated.testing.home=/Users/tester/Desktop/appian-selenium-api-example-java
  2. Update chrome.driver.home with the path to the Chrome driver that comes with this installation. Examples: * Windows: automated.testing.home=C:\\testFolder\\appian-selenium-api-example-java\\lib\\drivers\\chromedriver.exe * Mac: automated.testing.home=/Users/tester/Desktop/appian-selenium-api-example-java/lib/drivers/chromedriver-mac
2. Open file configs/users.properties, for each username used in a test add a line in the format of <username>=<password> to this file.
  1. If you prefer not to disclose your password in plain text, you can also choose to use com.appiancorp.ps.automatedtest.fixture.BaseFixture.loginIntoWithUsernameAndPassword fixture method to login by passing in the password from a system property value.
Open "src/main/java/com/appiancorp/example/HelloAppian.java":
1. Update TEST_SITE_URL to your Appian URL, such as protected static String TEST_SITE_URL = "https://example.appiancloud.com/suite";
2. Update TEST_USERNAME with a username, such as protected static String TEST_USERNAME = "tester.tester"; * Make sure this user exists in configs/users.properties
Run the main() method of this class:
1. You should see that a Chrome browser will open up, and the fixture commands in HelloAppian.java will execute accordingly.
2. Note that this test will fail since your site might not have an action "Create a Case" under menu "Actions" that opens up an interface that has a "Submit" button.

Features

Multiple browser support

Chrome
Firefox

Benefits

Define your own integration tests without being limited by a third-party testing tool
Selenium-based test scripts can be created for reusability throughout test suites
Methods created specifically to operate within Appian applications and Tempo
Test scripts do not need to be updated when upgrading between supported Appian versions
Test scripts are easily updated for new UI changes to a form or interface
Appian design knowledge is not required to create test scripts

Release Notes

March 2025 - Release 25.1

Enhancements
- Added support for defining and using custom locales. Use create appian locale | PATH TO File. This method must be called after setting the version.
  - File must be JSON file with the format: { "dateFormats": [ { "label": "dateFormat", "value": <FORMAT_STRING> }, { "label": "dateDisplayFormat", "value": <FORMAT_STRING> }, { "label": "timeFormat", "value": <FORMAT_STRING> }, { "label": "timeDisplayFormat", "value": <FORMAT_STRING> }, { "label": "datetimeFormat", "value": <FORMAT_STRING> }, { "label": "datetimeDisplayFormat","value": <FORMAT_STRING> } ], "labels": [ { "label": "acceptButton", "value": "Accept" } ], "locale": <LOCALE_CODE> }

August 2024 - Release 24.3

Enhancements
- Added built-in retry to click operation in case of element not interactable exception.
- Updated the milestone locator.

June 2024 - Release 24.2

Enhancements
- Updated locator for site menu links
- Created method which supports clicking on text within an interface. This is particularly useful for nested cards such as tab layouts, but can also be used as a fallback when existing methods don't work. This method is available for all Appian versions.
- Click operation on Card layout will be performed on the left side of the element instead of the right. We're not expecting any impact on existing test cases.

March 2024 - Release 24.1

Enhancements
- Support for Appian version 24.1
- Adds support for collapsing/opening sidebars
- ClickOnCard updated to support clicking on cards with complex content. For example, the method can now click on cards that have a component nested in multiple layouts within the card

November 2023 - Release 23.4

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Support for Appian version 23.4
- Add support for the side navigation menu in sites
- Add support for downloading charts
- Add support for buttons configured with custom colors
Bug Fixes
- Honor the download directory given in custom.properties for Remote Drivers
- Update dropdowns for versions greater than 23.3 to ignore the aria-checked value
- Fixed Populate Record Type Data Range User Filter method

August 2023 - Release 23.3

NOTE: Project has been updated to require Java 11 JRE
Enhancements
- Supports Appian version 23.3
- Added functionality to interact with new site group headers
- Updated to Selenium 4.11.0
Bug Fixes
- Update checkboxes to support CARD style for 23.3 and later Appian versions

June 2023 - Release 23.2.1

NOTE: Updates to site navigation in the 23.2 product breaks the use of the clickOnMenu method defined in TempoFixtures for site environments. clickOnMenu, and other navigation methods defined in TempoFixtures, are guaranteed to work only in Tempo environments. Use the clickOnSitePage method defined in SitesFixtures instead
Bug Fixes
- Update pickers to recognize selections with links (e.g. Record Pickers)

June 2023 - Release 23.2

Enhancements
- Supports Appian version 23.2
  - NOTE: Updates to site navigation in the 23.2 product breaks the use of the clickOnMenu method defined in TempoFixtures for site environments. clickOnMenu, and other navigation methods defined in TempoFixtures, are guaranteed to work only in Tempo environments. Use the clickOnSitePage method defined in SitesFixtures instead

May 2023 - Release 23.1.2

Bug Fixes
- Fixes an issue where Dropdowns with Search were not working
- Fixes an Issue where verifyText did not work on multi-node components

February 2023 - Release 23.1

Enhancements
- Supports Appian version 23.1
- Updated locator for Dropdown class
Bug Fixes
- Update CVEs
- Update scripts (start.bat, start-mac.sh, start-unix.sh, runFitNesseTest.sh) to reference the new fitnesse-20221219-standalone.jar

August 2022 - Release 22.3

Appian Selenium API is released and supported
Removed support for 20.3

November 2021 - Release 21.4

Enhancements
- Support new card choice components
Bug Fixes
- Update CVEs

August 2021 - Release 21.3

Bug Fixes
- Fix bug for radio button card
- Fix bug for date picker

June 2021 - Release 21.2

Enhancements
- Support new SectionLayout
- Upgrade Selenium Server to 3.141.59
Bug Fixes
- Fix bug for radio button card
- Fix bug for icon link alt text

March 2021 - Release 21.1

Appian Selenium API is released and supported

Tags: testing, Architecture

Writing to Synced Record Types at High Throughput

Appian Max Team — Wed, 05 Mar 2025 20:26:34 GMT

Revision 32 posted to Guide by Appian Max Team on 3/5/2025 8:26:34 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Trying to sync data above this level of throughput will fail and can cause record type invalidations. When using the Write Record smart service, writes will be throttled when exceeding a certain limit. This means that the nodes will fail and must be manually restarted, but the synced record type will remain available. When using Write to Data Store, failed writes will cause an invalidation, bringing down the impacted record type until a manual full sync is performed.

This guide explains how to design a process that supports writes to data fabric when peak times require more than ~1,000 write requests per minute across all of the applications on your site. This is accomplished through an incremental sync pattern where data is synced into the record types independently from the writes to the source table in large batches enabling up to 200,000 rows to be synced per minute.

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Tags: records, design patterns, Architecture, data fabric

Writing to Synced Record Types at High Throughput

Appian Max Team — Wed, 05 Mar 2025 20:25:53 GMT

Revision 31 posted to Guide by Appian Max Team on 3/5/2025 8:25:53 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Tags: records, design patterns, Architecture

Writing to Synced Record Types at High Throughput

joel.larin — Wed, 29 Jan 2025 17:26:03 GMT

Revision 30 posted to Guide by joel.larin on 1/29/2025 5:26:03 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Tags: records, design patterns, Architecture

Writing to Synced Record Types at High Throughput

joel.larin — Wed, 29 Jan 2025 17:24:11 GMT

Revision 29 posted to Guide by joel.larin on 1/29/2025 5:24:11 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Tags: records, design patterns, Architecture

Writing to Synced Record Types at High Throughput

joel.larin — Wed, 29 Jan 2025 16:53:54 GMT

Revision 28 posted to Guide by joel.larin on 1/29/2025 4:53:54 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Tags: records, design patterns, Architecture

Writing to Synced Record Types at High Throughput

joel.larin — Wed, 29 Jan 2025 16:51:11 GMT

Revision 27 posted to Guide by joel.larin on 1/29/2025 4:51:11 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Writing to Synced Record Types at High Throughput

joel.larin — Wed, 29 Jan 2025 16:49:35 GMT

Revision 26 posted to Guide by joel.larin on 1/29/2025 4:49:35 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Writing to Synced Record Types at High Throughput

joel.larin — Wed, 29 Jan 2025 16:47:08 GMT

Revision 25 posted to Guide by joel.larin on 1/29/2025 4:47:08 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.

Writing to Synced Record Types at High Throughput

joel.larin — Wed, 29 Jan 2025 16:46:17 GMT

Revision 24 posted to Guide by joel.larin on 1/29/2025 4:46:17 PM

Introduction

Appian's data fabric allows you to unify, secure, and optimize data spread across the enterprise. Typically, writing and syncing data in record types is as easy as using one of Appian’s smart services like Write Records, Write to Data Store Entity, and Write to Multiple Data Store Entities. However, when designing autoscaled processes, you may want to avoid using these smart services directly. Synced record types are limited to handling ~1,000 write requests per minute for processes writing data in small batches (1-10 rows).

Example Process

Let’s say we have a process model with Autoscale enabled, which receives data over an API call, performs some transformations on the data, and then writes a single record to a synced record type.

Deferred Sync Pattern

Configure a New Data Source, Data Type, and Data Store

Create a new Data Source Connected System that connects to the same database as your existing record type.
Create a CDT from the table that already backs the synced record type.
Create a new data store with that CDT as an entity. Use the connected system data source you just created as the data source.

If your record type does not already have a modifiedOn timestamp, you will need to add that to your data structure, and ensure it is being updated every time the row is updated.

Replace the Write Records Node

In the autoscaled process model:

Update the process variable that holds the data being written to use a CDT instead of a record type (the one we just created). Update all usage of this variable.
Replace the Write Records node with a Write to Data Store Entity node, using a constant for the new data store we just created.
Click Save & Publish.

Now, your autoscaled process model will only write to the source table instead of automatically syncing data in the record type.

Sync Batches of Data Every 5 Minutes

After re-configuring the autoscaled model, create a separate process model running without autoscale enabled to incrementally sync data the record type from the source table.

To configure incremental sync:

Create a new process model without autoscale enabled.
Create process variables to track the timestamp at which data was last synced (lastSyncTime) and the list of IDs to sync (recordsToSync).
Set the default value of the lastSyncTime variable to now()-5. This will cause the first run of the process to sync anything updated after 5 minutes ago.
Configure a timer event on the start node to run the process every 5 minutes.

In a new expression rule, query the IDs of any rows modified after the lastSyncTime timestamp, using a query that looks like this:

a!queryEntity(
  entity: cons!JLT_RecordEntity,
  query: a!query(
    selection: a!querySelection(
      columns: {
        a!queryColumn(
          field: "id"
        )
      }
    ),
    logicalExpression: a!queryLogicalExpression(
      operator: "AND",
      filters: {
        a!queryFilter(
          field: "modifiedOn",
          operator: ">",
          value: ri!lastSyncTime
        )
      },
      ignoreFiltersWithEmptyValues: true
    ),
    pagingInfo: a!pagingInfo(
      startIndex: 1,
      batchSize: 50,
      sort: a!sortInfo(
        field: "modifiedOn",
        ascending: true
      )
    )
  ),
  fetchTotalCount: false
)

Add a Script Task to the process and call the expression rule created above, passing in lastSyncTime.
Add a Sync Records smart service node to sync the IDs you just queried in the record type. Since this will most likely require syncing more than 1000 rows at a time, you will need to use a loop to iterate over all rows that need to be synced.