Installing and Configuring Desktop Designer

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

Amazon EC2

OS and Software

Installation Process

  1. Enable Developer Mode.
    1. Press WinKey+ I
    2. In Privacy and Security, Select For Developers
    3. Enable Developer Mode.
      8RqvCyxyMLkDaLjv-55ef889fe8f8.png
  2. Download Windows Application Driver. Follow the installation process.
    Download Link
  3. 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/
    ZHXM5Lh6X00JbkSy-8061fa5afaf2.png
    An Enviroment Variable can be set using the cmd prompt: setx APPIUM_WAD_PATH "C:/Program Files x86/Windows Application Driver"

    c9Hu6bgtN5NzzR8X-7652ea809a6f.png
  4. Download Video Recording Tool for Windows (AppvanceAgent.exe) and copy to the path "C:/Program Files x86/Windows Application Driver Tool:
    wDTIXmqfPiayQhCq-413aa61775f4.png
    The Windows Appvance Agent can be downloaded from the Desktop Designer Installation Downloads page. Access to this page is restricted and must be requested.
  5. Install Chocolatey. This is needed to install the ffmpeg plugin.
    Download Link
  6. Install Chocolatey.
    Full instructions can be found here: Installing Chocolatey.
    1. Run PowerShell as Administrator with the following command:
    2. 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'))
  7. Restart PowerShell and run it as Administrator again.
  8. Run this command: choco install ffmpeg
  9. Navigate to C:/Program Files x86/Windows Application Driver in 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.
  10. 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 a port on the test machine.
    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.
    You can also run the following command when run in an admin command prompt: netsh advfirewall firewall add rule name="WinAppDriver remote" dir=in action=allow protocol=TCP localport=4723
  11. Run ipconfig.exe to 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.
  12. Run AppvanceAgent.exe --port 4725 --executable WinAppDriver.exe --base_path /wd/hub --win_app_driver_port 4729 as 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

64bRJXzekIJXSRnV-a230cbdf15d8.png

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:

  1. Create a batch file :
    for /f "skip=1 tokens=3" %%s in ('query user %USERNAME%') do (
      %windir%\System32\tscon.exe %%s /dest:console
    )
  2. 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

Amazon EC2

Architecture

The way the Roku environment works is by using two different PCs / laptops connected to the same network.

BV7HuF8ng22Yj7YB-d018ab5517a5.png

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

Validation workflow

  1. Run a basic AIQ smoke test that starts the target browser or desktop application.
  2. Confirm the driver process starts and stops cleanly.
  3. Review output logs for path, permission, or version mismatch errors.
  4. 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

Validation workflow

  1. Start a short recording before the AIQ run.
  2. Run a small scenario and confirm the video shows the relevant application state.
  3. Check audio, resolution, timestamps, and file size.
  4. 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

Validation workflow

  1. Pair or configure the remote-control method for the target device.
  2. Run a short navigation smoke test.
  3. Confirm that AIQ can detect the expected screen or application response.
  4. 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

Prerequisites

Validation workflow

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.

Validation workflow

  1. Start from a clean desktop session.
  2. Open the required application and arrange it as expected.
  3. Run a short smoke test that validates the first interaction and a key screen state.
  4. 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

  1. Capture the exact symptom, affected time range, and AIQ components involved.
  2. Review logs and resource metrics before restarting services.
  3. Run a small known-good scenario to separate platform issues from scenario-specific issues.
  4. Apply one change at a time and record the result.

Last updated: October 8, 2026