Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new docs for Windows Automation #426

Merged
merged 2 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/left-nav-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -674,5 +674,8 @@
"error-handling": {
"/docs/salesforce-testing/error-handling/": "Error Handling On Metadata Refresh"
},
"test-results-at-all-levels": { "/docs/api/test-results-at-all-levels/": "Fetch Test Results (All Levels)" }
"test-results-at-all-levels": { "/docs/api/test-results-at-all-levels/": "Fetch Test Results (All Levels)" },
"project-and-application": {"/docs/windows-automation/project-and-application/": "Windows (Adv) Project & Application"},
"object-learning": {"/docs/windows-automation/object-learning": "Object Learning (Using UFT One)"},
"import-tsrx-files": { "/docs/windows-automation/import-tsrx-files/": "Importing/Updating TSRx Files" }
}
2 changes: 1 addition & 1 deletion src/pages/docs/best-practices/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Testsigma Automation Standards and Best Practices"
page_title: "Enhance Efficiency with Automated Testing Best Practices"
metadesc: "Explore best practices for enhancing efficiency and reliability in automated testing through modular design, dynamic waits, and data-driven testing."
noindex: false
order: 29.1
order: 30.1
page_id: "Best Practices to follow Testsigma Automation Standards"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/open-source-docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Testsigma Docker Setup"
page_title: "Testsigma Community Edition Docker Setup"
metadesc: "Learn how to set up Testsigma Server and MySQL as docker containers using Docker Compose | Easiest way to set up Testsigma on your local machines"
noindex: false
order: 28.3
order: 29.3
page_id: "Testsigma Docker Setup"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/open-source-docs/introduction-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Intro: Testsigma Community Edition"
metadesc: "Testsigma Community Edition is an open-source automation platform | This article discusses installing Testsigma on your workstation & start test automation"
noindex: false
order: 28.1
order: 29.1
page_id: "Introduction to Testsigma Community Edition"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/open-source-docs/reset-password.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Reset Password"
page_title: "How to reset password in Testsigma Community Edition"
order: 28.4
order: 29.4
page_id: "Reset password"
metadesc: "Learn steps in detail on how to reset username and password in Testsigma Community Edition. Follow these steps to reset username and password."
search_keyword: "Reset password"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Testsigma Community Cloud"
metadesc: "Integrate self-hosted open-source platform with Testsigma Community Cloud. This will provide free access to test labs, addons, visual testing, our discord, etc."
noindex: false
order: 28.2
order: 29.2
page_id: "Testsigma Community Cloud"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/salesforce-testing/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ Salesforce is a cloud-based Customer Relationship Management (CRM) platform that

## **Getting Help**

- Reach out to Testsigma support at **[email protected]**.
- For inquiries or help, reach out to Testsigma support at **[email protected]**.

---
2 changes: 1 addition & 1 deletion src/pages/docs/salesforce-testing/metadata-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ There are two ways to Authenticate:
- Wait until the sync is complete. This will take some time.
![Wait](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sfmdsipg.png)

4. Once Metadata sync is successful, you can create test cases by clicking **Create Test Case**.
1. Once Metadata sync is successful, you can create test cases by clicking **Create Test Case**.
![Create Tests](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sfmdctc.png)

---
Expand Down
82 changes: 82 additions & 0 deletions src/pages/docs/windows-automation/error-handling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: "Error Handling Post TSRx File Update"
page_title: "Error Handling Post TSRx File Update"
metadesc: "On updating TSRx file, Testsigma identifies potential errors in test cases, step groups and elements linked to updates in the application structure"
noindex: false
order: 28.7
page_id: "Error Handling Post TSRx File Update"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Check Errors on Elements List"
url: "#steps-to-check-errors-on-elements-list"
- type: link
name: "Steps to Check Errors on Test Case List"
url: "#steps-to-check-errors-on-test-case-list"
- type: link
name: "Steps to Resolve Errors in Test Case"
url: "#steps-to-resolve-errors-in-test-case"
---

---

Testsigma quickly informs you of errors 🚫 after updating the TSRx file!

When you update the elements by uploading an updated TSRx file, you might encounter errors in elements, test cases, and step groups. These errors indicate changes in the app structure.

✅ This feature helps you update your test cases, ensuring smooth test executions without discrepancies.

---

## **Prerequisites**

- An Updated TSRx File to Import

---

## **Steps to Check Errors on Elements List**

1. From the left-nav bar, go to **Create Tests > Elements**.

2. You can find the impacted test cases highlighted on the **Test Cases** page with a **Warning**.

3. Click on **View All** to filter only the impacted test cases.

---

## **Steps to Check Errors on Test Case List**

1. From the left-nav bar, go to **Create Tests > Test Cases**.

2. You can find the impacted test cases highlighted with a red underline on the **Elements**.

3. Click on **View All** to filter only the impacted test cases.

---

## **Steps to Resolve Errors in Test Case**

1. Select the impacted test case to view the errors.

2. Hover over to the highlighted step to check the error.

3. Hover over the element and click on the **View/Edit element**.

4. This will open the **Element details** overlay where you can find the details of impacted elements.

5. To resolve the error, replace them with new elements or disable/remove the test step as needed.

[[info | **NOTE**:]]
| - This feature is also available at the **Step Group** level.
| - The **Elements** page will also display errors on impacted elements.

Here's a quick GIF demonstrating how to check & resolve errors post TSRx file update.

![Error Handling](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WA_ErrorHandling.gif)

---
54 changes: 54 additions & 0 deletions src/pages/docs/windows-automation/import-tsrx-files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: "Importing/Updating TSRx Files into Testsigma"
page_title: "Import TSRx Files"
metadesc: "For Windows Advanced automation, you need to have objects captured in TSRx format. This article discusses how to import TSRx files into Testsigma application"
noindex: false
order: 28.5
page_id: "Import TSRx Files"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Import TSRx File"
url: "#steps-to-import-tsrx-file"
---

---

**TSRx/Developer Application Model** files can be easily managed 🔧 in Testsigma!

Once the TSRx file is ready, you can import it with just a few clicks and start building tests for Windows applications. These files are easy to manage and can be reused. This article discusses how to import TSRx files into the Testsigma application.

---

## **Prerequisites**

- A Windows Project in Testsigma

- TSRx File to Import

---

## **Steps to Import TSRx File**

1. From the left navigation bar, go to **Create Tests > Elements**.

2. Click **Import elements** in the top right corner.

3. In the **Import elements** dialog, click **Browse file**, select the **TSRx** file from your local system, and click **Import**.

4. You can see the imported elements under **Create Tests > Elements**.

[[info | **NOTE**:]]
| - You can replace the updated elements by clicking on **Update Elements** and following the same steps as above.
| - After updating the elements, changes in the app structure might affect some of them, which will be highlighted with a red underline. For information on handling these errors, refer to [error handling post TSRx update](https://testsigma.com//docs/windows-automation/error-handling/).

Here's a quick GIF demonstrating how to import elements for Windows application.

![Import Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/importtsrxelements.gif)

---
59 changes: 59 additions & 0 deletions src/pages/docs/windows-automation/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Intro: Windows Desktop Automation"
page_title: "Introduction: Windows Desktop Automation"
metadesc: "Testsigma simplifies Windows Automation with special NLPs & object based authoring | This article discusses how to create & execute tests for Windows Automation"
noindex: false
order: 28.1
page_id: "Testsigma for Windows Automation"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Getting Started"
url: "#getting-started"
- type: link
name: "Getting Help"
url: "#getting-help"
---

---

Welcome! This section of the documentation contains topics about how to get started with **Windows Automation** using Testsigma.

Testing Windows Desktop applications involves testing software on a local computer or laptop. Testing these applications can be difficult because of complex environments, different hardware configurations, and user preferences. That's where Testsigma comes in and provides a comprehensive testing approach that cover all aspects of the application.

Testsigma simplifies Windows Desktop testing by using the UFT tool for element creation, special NLPs for test creation, and executing tests in Testsigma local agent.

You can also quickly jump to one of the following topics to learn about Windows Automation in Testsigma.

---

## **Prerequisites**

- A Licensed Version of UFT One
- [Testsigma Agent](https://testsigma.com/docs/agent/overview/)
- A Windows Based Desktop Application

---

## **Getting Started**
- Creating a Windows Project
- Agent Installation Requirements
- Element Learning through UFT
- Importing/Updating TSRx File into Testsigma
- Building Test Cases for Windows Based Applications
- Test Case Execution for the Windows Based Applications
- List of Technologies Supported in Testsigma
- Oracle

---

## **Getting Help**

- For inquiries or help, reach out to Testsigma support at **[email protected]**.

---
24 changes: 24 additions & 0 deletions src/pages/docs/windows-automation/object-learning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Object Learning (Using UFT One)"
page_title: "Object Learning (Using UFT One)"
metadesc: "To automate windows advanced applications, you need to have objects captured & converted them to application models. This article discusses how to learn objects using UFT One"
noindex: false
order: 28.3
page_id: "Testsigma for Windows Automation"
warning: false
---

---

Testsigma leverages developer application model files (TSRx) for the applications you intend to test.


You can create an object repository (TSR) file for any Window based application using UFT One and learn the objects within the application. Once you have captured all the objects required for creating tests, convert these object repositories files (TSR) into TSRx file and import the newly created TSRx file into the Testsigma application.


ℹ️ For more information on how to capture Window based objects, refer to [object model](https://admhelp.microfocus.com/uft/en/23.4-24.2/UFT_Help/Content/User_Guide/z_Ch_TestObjModel.htm) and [object spy](https://admhelp.microfocus.com/uft/en/23.4-24.2/UFT_Help/Content/User_Guide/Spy.htm).


You can also quickly jump [here](https://testsigma.com/docs/windows-automation/tsr-tsrx-files/) to learn how to convert TSR to TSRx!

---
64 changes: 64 additions & 0 deletions src/pages/docs/windows-automation/project-and-application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: "Creating a Windows Project & Application"
page_title: "Create a Windows Project & App"
metadesc: "Testsigma supports various apps, including Web, Mobile Web, Android, iOS, Salesforce, Windows, & APIs | This article discusses how to create a Windows Advanced app"
noindex: false
order: 28.2
page_id: "Testsigma for Windows Automation"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Create a Windows (Advanced) Project and Application"
url: "#steps-to-create-a-windows-advanced-project-and-application"
---

---

Creating a **Windows (Advanced)** application in Testsigma is simple!

Go to one of your existing projects and create a new Windows (Advanced) application, or create a new project and add a Windows (Advanced) application to it. Testsigma supports various applications, including Web, Mobile Web, Android, iOS, Salesforce, Windows (Lite), and APIs.

This article discusses creating a project and adding a Windows (Advanced) application to the project in Testsigma.

ℹ️ For more information, refer to [projects](https://testsigma.com/docs/projects/overview/) and [applications](https://testsigma.com/docs/projects/applications/).

---

## **Prerequisites**

- A Windows Machine with Testsigma Agent

- A Licensed Version of UFT One

---

## **Steps to Create a Windows (Advanced) Project and Application**

1. Navigate to **Project** on the left-nav bar, and click on **New Project**.

2. On the **New project** page,

- Enter **Project name** and choose **Windows (Advanced)** from the **Application type** dropdown.

- Enter **Application name**, **Version** and click on **Create**.

[[info | **NOTE**:]]
| **Windows (Advanced)** allows you to create scriptless test cases to automate Window based applications. It uses Unified Functional Testing (UFT) tool to learn elements.

3. You’ll be redirected to the **Agents** page of the project.

[[info | **NOTE**:]]
| - You can also add a **Windows (Advanced)** application to an existing project by navigating to **Project > Project Settings > Applications > New Application**.
| - Ensure the Allow Multiple Applications option is enabled before proceeding with creating a new application.


Here’s a quick GIF demonstrating how to create Windows applications in Testsigma.

![Workflow of Project Creation](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/createwindowsapp.gif)

---
Loading
Loading