Installing and Configuring Desktop Designer
- Installing and Configuring Desktop Designer
- Roku Environment Setup
- Windows AIQ Driver Setup
- Configure Open Broadcaster Software for AIQ Test Evidence
- Set Up Roku Remote Control for AIQ Testing
- Set Up Deep Link Tester for AIQ Mobile Testing
- Arrange Applications for Reliable AIQ Desktop Testing
- Troubleshoot Possible AIQ Performance Issues
Installing and Configuring Desktop Designer
This is the installation and configuration process to setup Desktop Designer in order to test Windows applications.
System Requirements
Hardware
- Intel iCore 5 or above
- Memory 16 GB
- 1 TB Hardrive (SSD prefered)
Amazon EC2
- For Windows Server t3.xlarge
OS and Software
- Windows 10 / Windows Server 2016
- Windows Professional only. Window Home not supported.
- Windows 11 PRO is not certified at this time.
- Windows Server 2022 Datacenter not certified at this time.
- Windows Application Driver (WinAppDriver) (Version 1.2.1 or greater)
Download Link - Developer Mode must be set to On.
- Windows SDK (Optional)
Download Link - Install Chocolatey. Chocolatey is software management automation for Windows that wraps installers, executables, zips, and scripts into compiled packages.
Installation Process
- Enable Developer Mode.
- Press WinKey+ I
- In Privacy and Security, Select For Developers
- Enable Developer Mode.
- Download Windows Application Driver. Follow the installation process.
Download Link - Open a Command Console in Administrator mode and navigate to the path where the Windows Application Driver was installed.
cd C://Program Files/Windows Application Driver/
An Enviroment Variable can be set using the cmd prompt:setx APPIUM_WAD_PATH "C:/Program Files x86/Windows Application Driver" - Download Video Recording Tool for Windows (
AppvanceAgent.exe) and copy to the path "C:/Program Files x86/Windows Application Driver Tool:
The Windows Appvance Agent can be downloaded from the Desktop Designer Installation Downloads page. Access to this page is restricted and must be requested. - Install Chocolatey. This is needed to install the ffmpeg plugin.
Download Link - Install Chocolatey.
Full instructions can be found here: Installing Chocolatey.- Run PowerShell as Administrator with the following command:
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
- Restart PowerShell and run it as Administrator again.
- Run this command:
choco install ffmpeg - Navigate to
C:/Program Files x86/Windows Application Driverin PowerShell and run the following command:AppvanceAgent.exe --port 4726 --executable WinAppDriver.exe --base_path /wd/hub --win_app_driver_port 4725
The first port is for video recording and the second is for WinAppDriver.
Port 4726 would be the value videoPort in the config file. Port 4725 would be the port you use in the serverURL. The videoPort field is mandatory.
See the Configuration File Example below. - To access WinAppDriver Remotely there are two options:
Use a bridge like NGrok:- Start ngrok with: ngrok http http://localhost:4725
- Copy the forwarding URL and use it in your script capabilities.
Open up Windows Firewall with Advanced Security.- Select Inbound Rules -> New Rule...
- Rule Type -> Port.
- Select TCP.
- Choose a specific local port (472x)
- Action -> Allow the connection
- Profile -> Select all
- Name -> optional, choose a name for the rule.
netsh advfirewall firewall add rule name="WinAppDriver remote" dir=in action=allow protocol=TCP localport=4723 - Run
ipconfig.exeto determine your machine's local IP address.
Setting * as the IP address command line option will cause it to bind to all bound IP addresses on the machine. - Run
AppvanceAgent.exe --port 4725 --executable WinAppDriver.exe --base_path /wd/hub --win_app_driver_port 4729as an administrator with command line arguments as seen above specifying the local IP and port.
Configuration File Example
[ { "app": "", "appActivity": "TEST", "appPackage": "Root", "bundleId": "", "validDomains": "", "service": "On-Premises", "configName": "Root_DesktopApp", "deviceMode": "Desktop", "proxyURL": "", "videoPort": "4726", "serverURL": "http://192.168.3.14:4725/wd/hub", "source": "package", "platformName": "Windows", "capabilities": { "deviceName": "WindowsPC", "platformVersion": "", "automationName": "Windows", "app": "", "noReset": "true" } }]
Appium Capabilities
Appium is an open source automation tool for running scripts and testing native applications, mobile-web applications and hybrid applications on Android or iOS using a webdriver.
Appium has the ability to automate Windows PC Desktop apps. This driver relies on a project from Microsoft called WinAppDriver, which is an Appium-compatible WebDriver server for Windows Desktop apps (and more in the future). WinAppDriver is often abbreviated "WAD". WAD is bundled with Appium and does not need to be installed separately.
https://appium.readthedocs.io/en/latest/en/drivers/windows/
Define the Application Under Test
The application under test can be defined with the following:
appCapabilities.SetCapability("app", "C:\Windows\System32\notepad.exe");
or
appCapabilities.SetCapability("app", "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App");
Both the path to the application and the application ID are valid. The application ID can be found running in PowerShell with admin permissions : Get-StartApps
Platform and Device
The Platform and device are required:
appCapabilities.SetCapability("platformName", "platformName");
appCapabilities.SetCapability("deviceName", "WindowsPC");
Those capabilities are used to start the driver:
driver = new WindowsDriver(new URL("http://127.0.0.1:4723"), appCapabilities);
Enabling GUI even when RDP is Disconected
GUI can be still running if an automated RDP’s disconnection file is created using a batch file.
On the remote computer, do the following:
- Create a batch file :
for /f "skip=1 tokens=3" %%s in ('query user %USERNAME%') do (%windir%\System32\tscon.exe %%s /dest:console) - In the File properties, click Advanced and select Run as administrator.
Connectivity Details
If the Windows machine or Virtual Desktop Infrastructure (VDI) is in the same network than the machine running AIQ, then the local internal address can be use for connecting to the WinAppDriver.
Otherwise the machine hosting Windows must have assigned a Public IP and ports for RDP 3389 and 4725, 4726, 4727 forwarding the machine where the driver is running.
Last updated: October 12, 2026
If you have any feedback on this topic, please contact us at documentation@appvance.ai
Roku Environment Setup
This section will detail the required setup to allow recording and running Desktop Designer scripts for a Roku device on a local environment.
This documentation does not include the steps related to the Roku device setup itself. It is assumed that the Roku device is already setup and working as expected.
See the Roku website for information on Roku setup.
System Requirements
OS and Hardware
- Two machines running Windows 10 or newer. Windows 10 / Windows Server 2016 are supported.
- Windows Professional only. Window Home not supported.
- Windows 11 PRO is not certified at this time.
- Windows Server 2022 Datacenter not certified at this time.
- Intel iCore 5 or above
- Memory 16 GB
- 1 TB Hardrive (SSD prefered)
- One Roku device
- One HDMI Video Capture device
Amazon EC2
- For Windows Server t3.xlarge
Architecture
The way the Roku environment works is by using two different PCs / laptops connected to the same network.
- One of them (PC-A) is going to run AIQ and is going to be used for script recording/playback.
- The second one (PC-B) has a HDMI video capture device connected (with the Roku device connected to it). PC-B also runs the WindowsAppvanceServer along with the other required software applications used to display and control the Roku system.
Prerequisite Setup
Make sure both computers are connected to the same network before completing the setup.
PC-A (AIQ)
Properly setup AIQ on this machine. Refer to the AIQ Documentation for setup information for AIQ.
PC-B (Roku Device)
Make sure the Roku device is plugged to the HDMI capture device, and is plugged to the computer.
Required Software Installations
The following installations are required. Please see the individual websites for the installer downloads and installation instructions. AIQ specific configuration information for these components is provided later in this document.
Windows Appvance Driver
Windows Appvance Driver (WAD) works as a substitute for Windows App Driver in order to avoid well know issues reported in the WinAppDriver.
Installation Instructions and Download Link: Windows Appvance Driver Setup
Open Broadcaster Software
OBS (Open Broadcaster Software) is free and open source software for video recording and live streaming.
Download Link: https://obsproject.com/.
Roku Remote Tool
The Roku Remote Tool provides developers a quick and intuitive way to create reusable scripts for ad-hoc testing of their channel.
Download Link: https://devtools.web.roku.com/RokuRemote/.
Roku Deep Linking Tester
The Roku Deep Linking Tester provides a UI for configuring, saving, import/exporting, and executing deep linking test cases.
Download Link: https://devtools.web.roku.com/DeepLinkingTester/.
Last updated: October 12, 2026
If you have any feedback on this topic, please contact us at documentation@appvance.ai
Windows AIQ Driver Setup
Windows AIQ Driver Setup
Use this page when preparing a Windows machine to run AIQ browser, desktop, or device-related automation that depends on local drivers. Match driver versions to the target browser, operating system, and AIQ environment.
Preparation
- Install drivers with an account that has the required Windows permissions.
- Confirm the driver version matches the browser or application version used by the test.
- Store drivers in a controlled path and document that path in the environment configuration.
- Allow the driver through endpoint protection only when approved by IT or the customer security policy.
- Restart related services or the machine when the driver installation requires it.
Validation workflow
- Run a basic AIQ smoke test that starts the target browser or desktop application.
- Confirm the driver process starts and stops cleanly.
- Review output logs for path, permission, or version mismatch errors.
- Record the driver version and installation path for future upgrades.
Last updated: October 8, 2026
Configure Open Broadcaster Software for AIQ Test Evidence
Configure Open Broadcaster Software for AIQ Test Evidence
Open Broadcaster Software (OBS) can be used to capture video evidence while AIQ tests run. Use it when a team needs visual proof of application behavior, playback issues, or environment-specific failures.
Setup guidance
- Install a supported OBS version on the machine where the browser, desktop app, or device stream is visible.
- Create a dedicated scene for AIQ evidence capture and include only the required window, display, or device feed.
- Set the output path to a location with enough disk space for the planned run duration.
- Use a recording format that can be recovered if the session stops unexpectedly.
- Mask or avoid capturing credentials, customer data, and unrelated desktop content.
Validation workflow
- Start a short recording before the AIQ run.
- Run a small scenario and confirm the video shows the relevant application state.
- Check audio, resolution, timestamps, and file size.
- Attach or reference the recording with the related execution evidence.
Last updated: October 8, 2026
Set Up Roku Remote Control for AIQ Testing
Set Up Roku Remote Control for AIQ Testing
Use this guidance when AIQ tests need to control or validate a Roku-based application flow. Keep device setup consistent so remote-control actions are repeatable across test runs.
Setup checklist
- Confirm the Roku device and test controller are on the required network and can reach each other.
- Verify the app build, channel, or sideloaded package before running the scenario.
- Use a dedicated test account and reset application state when needed.
- Document the remote-control commands used by the scenario and the expected screen after each action.
- Capture device logs or screenshots when troubleshooting navigation failures.
Validation workflow
- Pair or configure the remote-control method for the target device.
- Run a short navigation smoke test.
- Confirm that AIQ can detect the expected screen or application response.
- Record any network, pairing, or device-state requirements in the test notes.
Last updated: October 8, 2026
Set Up Deep Link Tester for AIQ Mobile Testing
Set Up Deep Link Tester for AIQ Mobile Testing
Use a deep link tester when an AIQ mobile test needs to launch an app into a specific route, screen, or state. Deep links should be validated before they are added to repeatable mobile scenarios.
Prerequisites
- Confirm the app build installed on the device or emulator supports the target scheme, universal link, or app link.
- Document the exact deep link format, required parameters, and expected landing screen.
- Use test accounts and non-production data when validating app navigation.
- Reset the application state between runs when the deep link depends on login, cache, or stored preferences.
Validation workflow
- Open the deep link manually on the target device and confirm the expected screen appears.
- Add the deep link launch step to the AIQ mobile flow.
- Run the test once with logging enabled and capture evidence.
- Add assertions for the landing screen so failures are detected immediately.
Last updated: October 8, 2026
Arrange Applications for Reliable AIQ Desktop Testing
Arrange Applications for Reliable AIQ Desktop Testing
Arrange desktop applications consistently before an AIQ desktop test runs. Predictable window placement helps reduce failures caused by hidden controls, overlapping windows, or unexpected screen resolution changes.
Recommended setup
- Use a dedicated test machine or session for desktop automation.
- Set the display resolution and scaling before recording or running tests.
- Open only the applications required by the scenario.
- Place the application under test in a known position and avoid overlapping windows.
- Disable pop-ups, notifications, and screen savers that can cover the application.
Validation workflow
- Start from a clean desktop session.
- Open the required application and arrange it as expected.
- Run a short smoke test that validates the first interaction and a key screen state.
- Capture a screenshot if the arrangement is part of the support procedure.
Last updated: October 8, 2026
Troubleshoot Possible AIQ Performance Issues
Troubleshoot Possible AIQ Performance Issues
Use this article when AIQ feels slow, executions queue unexpectedly, reports load slowly, or test nodes are not keeping up with scheduled demand. Start with environment evidence before changing configuration.
Common areas to review
- Host resources: CPU, memory, disk I/O, and available storage on controller, database, and test-node hosts.
- Database health: Result-table growth, slow queries, retention settings, and backup activity.
- Test-node capacity: Number of concurrent executions, browser/device availability, and node connectivity.
- Scenario design: Excessive waits, unnecessary screenshots, large payloads, and missing cleanup steps.
- Network path: Latency or firewall issues between AIQ services, test nodes, databases, and target applications.
Recommended workflow
- Capture the exact symptom, affected time range, and AIQ components involved.
- Review logs and resource metrics before restarting services.
- Run a small known-good scenario to separate platform issues from scenario-specific issues.
- Apply one change at a time and record the result.
Last updated: October 8, 2026