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, updated SF & CX docs #429

Merged
merged 13 commits into from
Jun 7, 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
6 changes: 5 additions & 1 deletion src/left-nav-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -673,5 +673,9 @@
},
"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)" },
"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" }
}
67 changes: 67 additions & 0 deletions src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Delete Agents: Soft & Permanent"
metadesc: "This article discusses how to soft/permanently delete Testsigma agents & push them to obsolete state & restore these agents when needed | Learn how to soft/permanently delete agents"
noindex: false
order: 11.81
page_id: "Agent Soft Delete"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Soft Delete an Agent"
url: "#steps-to-soft-delete-an-agent"
- type: link
name: "Steps to Delete Agents Permanently"
url: "#steps-to-delete-agents-permanently"
---

---

Managing a long list of Agents can make selecting the right Agent while executing tests difficult. In this scenario, Testsigma lets you push Agents to an obsolete state to hide them from the Agents list page. You can restore/delete these Agents permanently when needed. This article discusses how to soft/permanently delete Agents in Testsigma.


---

## **Prerequisites**

- You should have [registered agents](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/#register-the-testsigma-agent) on Testsigma.

---

## **Steps to Soft Delete an Agent**

1. From the dashboard, go to **Agents**.

2. Hover over the agent you want to soft delete (push to an obsolete state).

3. In the warning dialog, click **Obsolete Agent**.

4. The agent will move to the obsolete state.

[[info | **NOTE**:]]
| - You can restore an obsolete agent by navigating to **Agents > Obsolete Agent** and clicking Restore.
| - An agent in the obsolete state will not allow the user to execute tests.


Here’s a quick GIF demonstrating how to soft delete and restore the obsoleted agent.

![Soft Delete Agents](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/SoftDeleteAgent.gif)

---

## **Steps to Delete Agents Permanently**

1. Navigate from the dashboard to **Agents > Obsolete Agent**.

2. Click on the kebab menu and select **Delete Permanently**. This will open a warning dialog.

3. In the warning dialog, confirm deletion by clicking **Delete Permanently**.

![Delete Permanently](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/DeleteAgentsPermanently.gif)


---
2 changes: 1 addition & 1 deletion src/pages/docs/agent/trigger-tests-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Triggering Tests on Local Devices"
metadesc: "Execute the tests on local agents from another device using the same Testsigma account | Learn how to trigger tests on local devices from different machines"
noindex: false
order: 11.81
order: 11.82
page_id: "Trigger Tests Locally"
warning: false
contextual_links:
Expand Down
40 changes: 35 additions & 5 deletions src/pages/docs/agent/troubleshooting/logs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Fetching Agent logs"
metadesc: "How to obtain the logs files from the Testsigma Agent to troubleshoot the errors. These files help you resolve Execution issues quickly in Testsigma App."
title: "Agent Logs"
metadesc: "How to fetach the logs files from the Testsigma Agent to troubleshoot the errors. These files help you resolve execution issues quickly in Testsigma App."
noindex: false
order: 11.92
page_id: "Fetching Agent logs"
Expand All @@ -9,6 +9,9 @@ warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Send the Logs Automatically"
url: "#send-the-logs-automatically"
- type: link
name: "Send the Logs manually"
url: "#send-the-logs-manually"
Expand All @@ -17,15 +20,32 @@ contextual_links:

---

To execute Testsigma tests on your local machines, a small utility program named Testsigma Agent needs to be on each local machine. In this article, we will discuss how to get the log files for the Testsigma Agent. Providing these files to the Testsigma Support Team will help us resolve Execution issues quickly.
To execute Testsigma tests on your local machines, a small utility program named Testsigma agent needs to be on each local machine. In this article, we will discuss how to send the log files of the Testsigma agent. Providing these files to the Testsigma Support Team will help us resolve execution issues quickly.


---

## **Send the Logs Automatically**

1. From the dashboard, go to **Agents**.

2. Hover over the agent of which you want to send logs, and click **Report Agent**.

3. In the warning dialog, provide a description of the problem you're facing with the agent and click **Report**.

4. The logs will be reported to Testsigma support automatically.


Here’s a quick GIF demonstrating how to send the logs automatically.

![Send Logs Automatically](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/agentlogsauto.gif)


---

## **Send the Logs manually**

You can find the Testsigma Agent logs folder for your machine as mentioned below:
You can find the Testsigma agent logs folder for your machine as mentioned below:

**Location of Testsigma Agent Configuration/Logs**

Expand All @@ -42,7 +62,17 @@ The Testsigma Configuration/Log files are located at the following locations dep

There would be a logs folder in the above directory. Inside the **logs** directory, you can find a number of files such as agent.log, Testengine.log e.t.c.

Please zip the **Agent** folder mentioned above and attach them in a mail to [email protected] describing the issue.
1. Please zip the **Agent** folder mentioned above.

2. Once you have the agent logs ZIP file, hover the agent of which you want to send logs and click **Report Agent**.

3. Click **Upload manually**. This will open a warning dialog.

4. In the warning dialog, provide a description of the problem you're facing with the agent, attach agent logs ZIP file click **Report**.

Here’s a quick GIF demonstrating how to send the logs manually.

![Agent Logs Manually](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/agentlogsmanual.gif)

---

Expand Down
47 changes: 47 additions & 0 deletions src/pages/docs/agent/troubleshooting/max-sessions-for-agents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "Specify Max Sessions for Agents"
metadesc: "Specify the maximum number of sessions for the local machine while setting up the local agent. This helps limit parallel executions & avoids slowing down of machine"
noindex: false
order: 11.94
page_id: ""
search_keyword: "Specify Max Sessions"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Add Max Sessions for Agents"
url: "#steps-to-add-max-sessions-for-agents"
---

---

When adding the Testsigma agent, you can specify the maximum number of sessions for the local machine. This helps limit parallel executions and avoids slowing down the machine. This article discusses how to specify the number of sessions for the local machine.

---

## **Prerequisites**

- You should know how to [register agents](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/#register-the-testsigma-agent) on Testsigma.

- Contact Testsigma support to enable this feature.

---

## **Steps to Add Max Sessions for Agents**

1. Set up the agent and click on **Register**. This action will open the **Add New Agent** dialog.

2. On the **Add New Agent** dialog, you'll find the **Max sessions for this machine** field. Enter the number of maximum sessions for the registering machine in the provided text box.

[[info | **NOTE**:]]
| The specified number should not exceed available parallels for the account.

Here's a quick GIF demonstrating how to add maximum sessions for the machine.

![Agent Parallels](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/AgentParallels.gif)

---
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Rerun Test Cases from Run Results using API"
page_title: "Rerun Test Cases from Run Results using APII"
metadesc: "Learn in detail how to rerun failed test cases, all test cases, or custom test cases from a particular test run result in Testsigma using REST API."
noindex: false
order: 21.67
order: 21.87
page_id: "Rerun Test Cases from a Test Run"
warning: false
contextual_links:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Run the same Test Plan multiple times in Parallel"
title: "Run the Same Test Plan Multiple Times in Parallel"
metadesc: "This document discusses how one test plan can be run multiple times, in parallel, using the REST API calls | Run same test plan multiple times"
noindex: false
order: 21.63
order: 21.83
page_id: "Run the same Test Plan multiple times in Parallel"
search_keyword: ""
warning: false
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/api/examples/schedule-test-plan-with-API.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Schedule, Update and Delete a test plan using API"
title: "Schedule, Update & Delete a Test Plan Using API"
page_title: "Schedule a test plan using API"
metadesc: "With Testsigma, you can create, update, and delete a schedule for test plan using API. Learn how to schedule, update and delete a test plan using REST API"
noindex: false
order: 21.64
order: 21.84
page_id: "Schedule, Update and Delete a test plan using API"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/examples/trigger-multiple-test-plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Trigger Multiple Test Plans Consecutively"
metadesc: "How to trigger multiple Test Plans remotely using REST API. With this you can run a Mobile Test Plan after executing a Web Test Plan"
noindex: false
order: 21.61
order: 21.81
page_id: "Trigger Multiple Test Plans Consecutively"
search_keyword: ""
warning: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Trigger Test Plan remotely and wait until Completion"
title: "Trigger Test Plans Remotely & Wait Until Completion"
metadesc: "This article discusses in detail on how to trigger a Test Plan remotely using REST API and wait until the Test Run completion before publishing the test results"
noindex: false
order: 21.62
order: 21.82
page_id: "Trigger Test Plan remotely and wait until Completion"
search_keyword: ""
warning: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Update Test Case results using API"
title: "Update Test Case Results Using API"
page_title: "Update Test Case results using API"
metadesc: "This article discusses in detail on how to update Test Case results as Passed, Failed, and Not Executed using API using REST API in Testsigma."
noindex: false
order: 21.65
order: 21.85
page_id: "Update Test Case results using API"
warning: false
---
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/examples/values-of-test-data-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Create and update values of Test Data Profile using REST API"
page_title: "Update Test Case results using API"
metadesc: "Learn how to create, update, and delete values of Test Data Profile using REST API in Testsigma | Detailed steps to create, update, and delete values of Test Data Profile"
noindex: false
order: 21.66
order: 21.86
page_id: "Create, update, and delete values of Test Data Profile using API"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/get-project-wide-information.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Project wide information"
title: "Get Project Wide Information"
page_title: "Get information for your Testsigma Project"
metadesc: "Learn how to get detailed information for your Testsigma Project - users, suites, tags, requirement, and testcase priority using APIs"
noindex: false
Expand Down
Loading
Loading