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 Windows Lite docs & updated Onprem Archi doc #481

Merged
merged 4 commits into from
Aug 9, 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
7 changes: 6 additions & 1 deletion src/left-nav-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -688,5 +688,10 @@
"setup": {"/docs/on-premise-setup/installation-process/setup/": "Installation Steps" },
"post-installation-checklist": {"/docs/on-premise-setup/post-installation/post-installation-checklist/": "Post-Installation Checklist" },
"troubleshooting": {"/docs/on-premise-setup/post-installation/troubleshooting/": "Troubleshooting" },
"faqs": {"/docs/on-premise-setup/post-installation/faqs/": "FAQs" }
"faqs": {"/docs/on-premise-setup/post-installation/faqs/": "FAQs" },
"windows-lite-automation": {"/docs/windows-lite-automation/": "Windows Automation (Lite)"},
"windows-automation": {"/docs/windows-automation/": "Windows Automation (Advanced)"},
"projects-and-applications": {"/docs/windows-lite-automation/projects-and-applications/": "Windows (Lite) Project & Application"},
"element-learning": {"/docs/windows-lite-automation/element-learning/": "Element Learning with Test Recorder"},
"test-cases": {"/docs/windows-lite-automation/test-cases/": "Test Cases for Windows (Lite)" }
}
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: 30.1
order: 31.1
page_id: "Best Practices to follow Testsigma Automation Standards"
warning: false
contextual_links:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,13 @@ contextual_links:
name: "Important Components"
url: "#important-components"
- type: link
name: "Interactions"
url: "#interactions"
- type: link
name: "Testsigma Central Server Architecture"
url: "#testsigma-central-server-architecture"
name: "Ports Used in Different Containers"
url: "#ports-used-in-different-containers"
---

---

The Testsigma On-Premise System Architecture provides a secure environment for creating and executing automated tests within your organization's local infrastructure. This article discusses Testsigma's On-Premise System Architecture.

This architecture includes three main components:
1. Client Systems
2. Central Server
3. Database

Here’s a high level illustration of Testsigma’s On-prem Architecture:

![Architecture](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsarchitecture.png)
The Testsigma On-Premise System Architecture provides a secure environment for creating and executing automated tests within your organization's local infrastructure. This article discusses physical layout deployment diagram of Testsigma's on-premise setup.

---

Expand All @@ -55,8 +43,6 @@ The physical layout deployment diagram above illustrates how tests are created a

- Each container has specific ports for organized and efficient communication within the system.

For more information, see the [Testsigma Central Server Architecture](https://testsigma.com/docs/on-premise-setup/pre-installation/testsigma-on-prem-architecture/#testsigma-central-server-architecture) section of this document.


---

Expand Down Expand Up @@ -85,32 +71,7 @@ For more information, see the [Testsigma Central Server Architecture](https://te

---

## **Interactions**

Here's the detailed explanation of communication between components:

![Detailed Communication](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/DetailedArchitecture.png)

### **1. Client Access**
- Clients access the Testsigma application using web browsers and interact with the application's features and functionalities.
- Communication between the Client and the Central Server happens via HTTPS protocol.

### **2. Agent Communication**
- The Agent on client machines executes tests on browsers and mobile devices by communicating with the Central Server using HTTPS.
- The Agent also handles the test execution process and returns the results to the Central Server.

### **3. Central Server to Database**
- The Central Server communicates with the Database using TCP on port 3307 to store and retrieve necessary data.

---

## **Testsigma Central Server Architecture**

The Testsigma Central Server Architecture is designed within a Docker environment, providing containerization benefits such as isolation, scalability, and easy deployment. The architecture consists of servers responsible for specific tasks and a MySQL database to manage data storage.

![Central Server Architecture](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/CentralServerAchitecture.png)

### **Components**
## **Ports Used in Different Containers**

**1. Load Balancer**
- **Role:** Acts as the entry point to the system, distributing incoming traffic among multiple servers to prevent any single server from becoming a bottleneck.
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: 29.3
order: 30.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: 29.1
order: 30.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: 29.4
order: 30.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: 29.2
order: 30.2
page_id: "Testsigma Community Cloud"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/windows-automation/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
order: 29.7
page_id: "Error Handling Post TSRx File Update"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/windows-automation/import-tsrx-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
order: 29.5
page_id: "Import TSRx Files"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/windows-automation/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
order: 29.1
page_id: "Testsigma for Windows Automation"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/windows-automation/object-learning.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
order: 29.3
page_id: "Testsigma for Windows Automation"
warning: false
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
order: 29.2
page_id: "Testsigma for Windows Automation"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/windows-automation/test-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Test Cases for Windows Automation"
page_title: "Test Cases for Windows Automation"
metadesc: "With Testsigma, you can create & execute tests for Windows Applications from the cloud using Testsigma Agent | Learn how to build tests for Windows Automation"
noindex: false
order: 28.6
order: 29.6
page_id: "Test Cases for Windows Automation"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/windows-automation/tsr-tsrx-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Converting TSR Files to TSRx"
page_title: "Converting TSR Files to TSRx"
metadesc: "To automate windows advanced applications, you need to have objects captured in TSRx format. This article discusses how to convert TSR files to TSRx using ORAppModelConverter"
noindex: false
order: 28.4
order: 29.4
page_id: "Converting TSR Files to TSRx"
warning: false
contextual_links:
Expand Down
64 changes: 64 additions & 0 deletions src/pages/docs/windows-lite-automation/element-learning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: "Element Learning (Using Test Recorder)"
page_title: "Object Learning (Using Test Recorder)"
metadesc: "To automate windows applications, you need to have elements captured from Test Recorder. This article discusses how to learn elements using Test Recorder in Testsigma"
noindex: false
order: 28.3
page_id: "Windows (Lite) Automation Element Learning"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Learn Windows (Lite) Elements Using Test Recorder"
url: "#steps-to-learn-windows-lite-elements-using-test-recorder"
---


---

For applications built on UWP, WinForms, WPF, and Classic Windows, you can provide the app path and selectively capture elements using Test Recorder. This article discusses learning and capturing elements for Windows (Lite) applications in Testsigma.


---

> ## **Prerequisites**
> - You should know how to create a [project](https://testsigma.com/docs/projects/overview/) and [application](https://testsigma.com/docs/projects/applications/) in Testsigma.
> - You should have the Testsigma’s [Test Recorder](https://chromewebstore.google.com/detail/testsigma-recorder/epmomlhdjfgdobefcpocockpjihaabdp?hl=en-GB&utm_source=ext_sidebar) installed.
> - You should have the [Testsigma Agent](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/) setup.
> - Any Windows app to capture elements.

---

## **Steps to Learn Windows (Lite) Elements Using Test Recorder**

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

![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_Element.png)

2. On **Record Elements** overlay, select **Local Test Machine**, provide **App path** and click **Record**.

![Record Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_ElementRecord.png)

3. Wait for the app to load fully.

4. Once the app is loaded, click on the element you want to capture.

![Click Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_WaitforApptoLoad.png)

5. On the **Create Element** section, validate the **Name**, **Screen Name**, **Element Type**, and the **Value**.

![Validate](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_ValidateElement.png)

6. Click **Create**.

![Create Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_CreateElement.png)

7. Stop the recorder to close the session.

![Stop Recorder](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_Stop_Recorder.png)

---
60 changes: 60 additions & 0 deletions src/pages/docs/windows-lite-automation/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "Intro: Windows Automation (Lite)"
page_title: "Introduction: Windows (Lite) Automation"
metadesc: "Testsigma simplifies Windows Automation with NLPs for the apps built on UWP, WPF, WinForms & Win32 | 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 contains topics on how to get started with Windows Automation (Lite) using Testsigma.

You can seamlessly test Windows applications built on Universal Windows Platform (UWP), Windows Forms (WinForms), Windows Presentation Foundation (WPF), and Classic Windows (Win32) in Testsigma. Simply upload the application path, record the elements using the Test Recorder, and execute tests locally using the Testsigma Agent. It's that simple!

For legacy applications, see [Windows Advanced](https://testsigma.com/docs/windows-automation/introduction/).

Jump to one of the following topics to learn about Windows Automation (Lite) in Testsigma.

---

> ## **Prerequisites**
>
> - [Testsigma Agent Setup](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/)
> - An Application Built on UWP/WinForms/WPF/Classic Windows
> - Testsigma’s [Test Recorder](https://chromewebstore.google.com/detail/testsigma-recorder/epmomlhdjfgdobefcpocockpjihaabdp?hl=en-GB&utm_source=ext_sidebar) installed
> - Enable **Developer Mode** on Windows Machine


---

## **Getting Started**

- Creating a Windows (Lite) Project

- Element Learning through Test Recorder

- Building & Executing Test Cases for Windows (Lite) Applications

---

## **Getting Help**

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

---
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
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 Lite, Windows Advanced, & APIs | This article discusses how to create a Windows Lite app"
noindex: false
order: 28.2
page_id: "Windows Automation Project & Application"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Steps to Create a Windows (Lite) Project and Application"
url: "#steps-to-create-a-windows-lite-project-and-application"
---

---

Creating a Windows (Lite) application in Testsigma is simple!

Go to one of your existing projects and create a new Windows (Lite) application, or create a new project and add a Windows (Lite) application to it. This article discusses creating a project and adding a Windows (Lite) application to the project in Testsigma.

For more information, see [projects](https://testsigma.com/docs/projects/overview/) and [applications](https://testsigma.com/docs/projects/applications/).

---

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

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

![Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_Project.png)

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

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

![Project Name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_ProjectName.png)

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

![Create Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WL_VersionCreate.png)

[[info | **NOTE**:]]
| - You can also add a **Windows (Lite)** 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.

---
Loading
Loading