# Desktop Test

The **Desktop Testing** module in TestWheel enables users to automate and execute **desktop application testing** through seamless integration with the **TestWheel Agent** and **WinAppDriver UI Recorder**. The module supports capturing desktop UI elements, configuring automation templates, executing desktop test cases, and generating detailed execution reports from a centralized interface.

## **Prerequisites**

Before initiating **Desktop Testing**, users must install **JDK 22** and configure the necessary environment variables, including **`JAVA_HOME`** and **`PATH`**. Users are also required to download the **WinAppDriver UI Recorder** from the provided source, extract the ZIP package, and launch the **`WinAppDriverUiRecorder.exe`** application. Additionally, **Developer Mode** must be enabled on the machine prior to agent installation and element recording activities.

## **WinAppDriver UI Recorder**

The **WinAppDriver UI Recorder** is used to capture desktop application element properties such as **XPath** and Element ID. After launching the recorder, users can start recording and select the required UI elements within the desktop application. The captured locator information can subsequently be utilized while preparing the desktop automation template.

<figure><img src="/files/AS2oVifvFWlirkec6ePh" alt=""><figcaption></figcaption></figure>

## **Desktop Test**

The **Desktop Test** module can be accessed directly from the **TestWheel** Dashboard through the **Desktop Test** option available in the left-hand navigation panel. This interface provides access to template downloads, agent installation packages, desktop application management, and execution functionalities.

<figure><img src="/files/y8TVmHUrmZUV2pPdoPwa" alt=""><figcaption></figcaption></figure>

## Template Download and Configuration

The **First Download Icon** allows users to download the predefined desktop testing template required for desktop automation execution. This **template** is used to configure test steps, locator information, execution actions, input data, and validation messages required for the automation workflow. The template includes fields such as Step\_Name, Locator\_Type, Locator\_Value, Action, Input\_Data, Description, Success\_Message, and Failure\_Message. Users must populate the template with the appropriate execution details for each test step before uploading it into TestWheel for desktop test execution.

## Agent Installation

To establish **desktop** automation connectivity, users must download the **TestWheel Agent** by clicking the **second Download icon** available in the **Desktop Test module**. After initiating the download, a **secure passkey** is automatically sent to the user’s registered **email address** for authentication purposes. Once the agent installation begins, users must enter the received **passkey** to proceed further. After successful verification, users are redirected to the **Developer Mode** configuration screen, where Developer Mode must be enabled to **complete the installation** and **agent connection process successfully**.

<figure><img src="/files/fZesb7wK05jXJi18LJGj" alt=""><figcaption></figcaption></figure>

## Tray Icon Functionalities

The **Agent tray icon** provides operational controls such as **Pause Agent, Stop Agent, View Logs**, and **Exit**. These options allow users to temporarily pause execution, terminate running processes, review execution logs, or completely close and restart the agent when required.

<figure><img src="/files/wfVktVAXOLVwXT2l1BCT" alt=""><figcaption></figcaption></figure>

## Desktop Application Creation

Users can create a **new desktop testing** application by selecting the **Add New Application** option. The Create Application screen allows users to **configure** the application details and **upload the corresponding desktop automation template** before registering the application successfully within TestWheel.

<figure><img src="/files/Woy6LYAYie6Gr8fpMFPF" alt=""><figcaption></figcaption></figure>

## Test Execution

After the **desktop automation template** has been uploaded successfully, users can initiate execution by clicking the **Run icon** associated with the **desktop application**. TestWheel then triggers the configured desktop automation workflow through the connected agent.Upon completion of test execution, users can download detailed execution reports from the **Test Results** section.

<figure><img src="/files/x1ood2BkLdnoRNPP4azU" alt=""><figcaption></figcaption></figure>

## **Edit Desktop Application**

**Existing desktop application** configurations can be **modified** using the **Edit option** available within the application management interface. Users can update application details, replace automation templates, and save the revised configuration without recreating the application.

<figure><img src="/files/5JfEX4mZO41du5xKY1jH" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.testwheel.com/desktop-test.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.