diff --git a/src/left-nav-title.json b/src/left-nav-title.json index f78dbf4d..91fcfad8 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -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" } } \ No newline at end of file diff --git a/src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md b/src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md new file mode 100644 index 00000000..9d3999e1 --- /dev/null +++ b/src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md @@ -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) + + +--- \ No newline at end of file diff --git a/src/pages/docs/agent/trigger-tests-locally.md b/src/pages/docs/agent/trigger-tests-locally.md index c8e9225d..f494915d 100644 --- a/src/pages/docs/agent/trigger-tests-locally.md +++ b/src/pages/docs/agent/trigger-tests-locally.md @@ -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: diff --git a/src/pages/docs/agent/troubleshooting/logs.md b/src/pages/docs/agent/troubleshooting/logs.md index 581f8959..4b126c2c 100644 --- a/src/pages/docs/agent/troubleshooting/logs.md +++ b/src/pages/docs/agent/troubleshooting/logs.md @@ -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" @@ -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" @@ -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** @@ -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 support@testsigma.com 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) --- diff --git a/src/pages/docs/agent/troubleshooting/max-sessions-for-agents.md b/src/pages/docs/agent/troubleshooting/max-sessions-for-agents.md new file mode 100644 index 00000000..ce171171 --- /dev/null +++ b/src/pages/docs/agent/troubleshooting/max-sessions-for-agents.md @@ -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) + +--- \ No newline at end of file diff --git a/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md b/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md index 4398dd2e..a2cea956 100644 --- a/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md +++ b/src/pages/docs/api/examples/rerun-test-cases-in-test-run.md @@ -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: diff --git a/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md b/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md index 97ae1d13..619ea01c 100644 --- a/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md +++ b/src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md @@ -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 diff --git a/src/pages/docs/api/examples/schedule-test-plan-with-API.md b/src/pages/docs/api/examples/schedule-test-plan-with-API.md index 946b06db..02536f8d 100644 --- a/src/pages/docs/api/examples/schedule-test-plan-with-API.md +++ b/src/pages/docs/api/examples/schedule-test-plan-with-API.md @@ -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: diff --git a/src/pages/docs/api/examples/trigger-multiple-test-plans.md b/src/pages/docs/api/examples/trigger-multiple-test-plans.md index c0cb6ae3..c14e157b 100644 --- a/src/pages/docs/api/examples/trigger-multiple-test-plans.md +++ b/src/pages/docs/api/examples/trigger-multiple-test-plans.md @@ -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 diff --git a/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md b/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md index b01a0cbd..7459266b 100644 --- a/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md +++ b/src/pages/docs/api/examples/trigger-test-plan-wait-completion.md @@ -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 diff --git a/src/pages/docs/api/examples/update-test-case-results-using-API.md b/src/pages/docs/api/examples/update-test-case-results-using-API.md index 6abc7ee5..6ac95d88 100644 --- a/src/pages/docs/api/examples/update-test-case-results-using-API.md +++ b/src/pages/docs/api/examples/update-test-case-results-using-API.md @@ -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 --- diff --git a/src/pages/docs/api/examples/values-of-test-data-profile.md b/src/pages/docs/api/examples/values-of-test-data-profile.md index b2f4ca3f..bfd0345f 100644 --- a/src/pages/docs/api/examples/values-of-test-data-profile.md +++ b/src/pages/docs/api/examples/values-of-test-data-profile.md @@ -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: diff --git a/src/pages/docs/api/get-project-wide-information.md b/src/pages/docs/api/get-project-wide-information.md index f419a040..a88f2987 100644 --- a/src/pages/docs/api/get-project-wide-information.md +++ b/src/pages/docs/api/get-project-wide-information.md @@ -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 diff --git a/src/pages/docs/api/test-results-at-all-levels.md b/src/pages/docs/api/test-results-at-all-levels.md new file mode 100644 index 00000000..2deb60d4 --- /dev/null +++ b/src/pages/docs/api/test-results-at-all-levels.md @@ -0,0 +1,207 @@ +--- +title: "Fetch Test Results at all Levels Using APIs" +page_title: "Test Results at all Levels Using APIs" +metadesc: "This article discusses how to fetch test results at test plan, test machine, test suite, test case, and step levels using APIs in Testsigma Application." +noindex: false +order: 21.7 +page_id: "Test Results at all Levels Using APIs" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Fetch Test Plan Results" + url: "#fetch-test-plan-results" +- type: link + name: "Fetch Test Machine Results" + url: "#fetch-test-machine-results" +- type: link + name: "Fetch Test Suite Results" + url: "#fetch-test-suite-results" +- type: link + name: "Fetch Test Case Results" + url: "#fetch-test-case-results" +- type: link + name: "Fetch Test Step Results" + url: "#fetch-test-step-results" +--- + +--- + +You can leverage Testsigma APIs to fetch detailed test results at all levels. Whether you need results for an entire test plan, a specific test machine, a test suite, an individual test case, or even the test step level, Testsigma's APIs give you the necessary endpoints to get this data. This article discusses how to fetch these results in Testsigma. + + +--- + +## **Prerequisites** + +- You should have an API Key. See, [generate API Keys in Testsigma](https://testsigma.com/docs/configuration/api-keys/). +- You should have a [test plan run ID](https://testsigma.com/docs/api/test-plans/#obtaining-the-run-id). + +--- + +## **Fetch Test Plan Results** + +### **Index for Fetching Test Run Results:** + +> **URL:** +> +> ```https://app.testsigma.com/api/v3/test_runs/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } + + + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body (Sample)** | {
  "id": 517,
  "testPlanId": 420,
  "buildNo": "run69",
  "result": "FAILURE",
  "startTime": "2024-05-29T07:29:19Z",
  "endTime": "2024-05-29T07:33:17Z",
  "duration": 238000,
  "executor": "bharath.k@testsigma.com",
  "triggeredType": "MANUAL",
  "metrics": {
    "id": 162,
    "testPlanResultId": 517,
    "totalCount": 8,
    "failedCount": 4,
    "passedCount": 4,
    "stoppedCount": 0,
    "notExecutedCount": 0,
    "queuedCount": 0,
    "runningCount": 0,
    "consolidatedPlanTotalCount": 8,
    "consolidatedPlanFailedCount": 4,
    "consolidatedPlanPassedCount": 4,
    "consolidatedPlanStoppedCount": 0,
    "consolidatedPlanNotExecutedCount": 0,
    "consolidatedPlanQueuedCount": 0,
    "consolidatedPlanRunningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 226000,
    "consolidatedDuration": 226000
  }
} | + +In the response body above, we fetched the test plan results with ID 517. + +--- + +## **Fetch Test Machine Results** + +### **Index for Fetching Test Machine Results:** + +> **URL:** +> +> ```https://app.testsigma.com/api/v3/test_runs//test_machine_results/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_machine_results/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body (Sample)** | {
  "id": 1434,
  "testRunId": 517,
  "result": "FAILURE",
  "startTime": "2024-05-29T07:29:19Z",
  "endTime": "2024-05-29T07:31:40Z",
  "duration": 141000,
  "deviceConfiguration": {
    "title": "Windows Chrome",
    "osVersion": "11",
    "browser": "GoogleChrome",
    "browserVersion": "123.0",
    "resolution": "1920x1080",
    "platform": "Windows",
    "deviceName": null,
    "hostName": "agent.testsigma.com",
    "osType": "WINDOWS"
  },
  "metrics": {
    "id": 165,
    "testDeviceResultId": 1434,
    "testPlanResultId": 517,
    "totalCount": 4,
    "failedCount": 2,
    "passedCount": 2,
    "stoppedCount": 0,
    "notExecutedCount": 0,
    "queuedCount": 0,
    "runningCount": 0,
    "consolidatedTotalCount": 4,
    "consolidatedFailedCount": 2,
    "consolidatedPassedCount": 2,
    "consolidatedStoppedCount": 0,
    "consolidatedNotExecutedCount": 0,
    "consolidatedQueuedCount": 0,
    "consolidatedRunningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 129000,
    "consolidatedDuration": 129000
  },
  "appDetails": null
} | + +In the response body above, we fetched the test machine results with ID 1434. + +--- + +## **Fetch Test Suite Results** + +### **Index for Fetching Test Suite Results:** + +> **URL:** ```https://app.testsigma.com/api/v3/test_runs//test_suite_results/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_suite_results/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body (Sample)** | {
  "id": 1383,
  "testRunId": 517,
  "result": "FAILURE",
  "startTime": "2024-05-29T07:29:19Z",
  "endTime": "2024-05-29T07:30:33Z",
  "duration": 74000,
  "deviceConfiguration": null,
  "metrics": {
    "id": 293,
    "testDeviceResultId": 1434,
    "testPlanResultId": 517,
    "totalCount": 2,
    "failedCount": 1,
    "passedCount": 1,
    "stoppedCount": 0,
    "notExecutedCount": 0,
    "queuedCount": 0,
    "runningCount": 0,
    "consolidatedTotalCount": 2,
    "consolidatedFailedCount": 1,
    "consolidatedPassedCount": 1,
    "consolidatedStoppedCount": 0,
    "consolidatedNotExecutedCount": 0,
    "consolidatedQueuedCount": 0,
    "consolidatedRunningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 62000,
    "consolidatedDuration": 62000
  },
  "appDetails": null
} | + +In the response body above, we fetched the test suite results with ID 1383. + +--- + +## **Fetch Test Case Results** + +### **Index for Fetching Test Case Results:** + +> **URL:** +> +> ```https://app.testsigma.com/api/v3/test_runs//test_case_results/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } + + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_case_results/``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body (Sample)** | {
  "id": 3857,
  "testCaseId": 609,
  "startTime": "2024-05-29T07:29:31Z",
  "endTime": "2024-05-29T07:29:55Z",
  "duration": 23038,
  "result": "FAILURE",
  "isDisabled": false,
  "isDataDriven": false,
  "metrics": {
    "id": 1089,
    "testCaseResultId": 3857,
    "testSuiteResultId": 1383,
    "testDeviceResultId": 1434,
    "testPlanResultId": 517,
    "totalCount": 6,
    "failedCount": 1,
    "passedCount": 3,
    "stoppedCount": 0,
    "notExecutedCount": 2,
    "queuedCount": 0,
    "skippedCount": 0,
    "runningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 23038,
    "consolidatedDuration": 23038
  },
  "appDetails": null
} | + +In the response body above, we fetched the test case results with ID 3857. + +--- + +## **Fetch Test Step Results** + +| **Request Type** | **GET** | +|----------|----------| +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_case_results//step_results``` | +| **Authorization** | Bearer Token | +| **Response Body Type** | JSON | +| **Response Body (Sample)** | {
  "content": [
  { "id": "3c51e933-7e15-41a0-893b-38e38b8258a2",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2847,
    "type": "NLP\_TEXT",
    "action": "Navigate to https://simply-travel.testsigma.com/",
    "message": "Successfully opened given URL.",
    "errorCode": null,
    "errorType": null,
    "result": "SUCCESS",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:32Z",
    "endTime": "2024-05-29T07:29:33Z",
    "duration": 1133,
    "visualEnabled": false },
  { "id": "c3a8fbeb-b508-41d2-83f7-6a0ca152e234",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2848,
    "type": "NLP\_TEXT",
    "action": "Click on Login or Sign Up Button",
    "message": "Successfully performed click action.",
    "errorCode": null,
    "errorType": null,
    "result": "SUCCESS",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:37Z",
    "endTime": "2024-05-29T07:29:39Z",
    "duration": 2040,
    "visualEnabled": false },
  { "id": "36bbdc50-ca05-4289-8342-c9e20d0491a4",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2849,
    "type": "NLP\_TEXT",
    "action": "Click on Login Button",
    "message": "Successfully performed click action.",
    "errorCode": null,
    "errorType": null,
    "result": "SUCCESS",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:42Z",
    "endTime": "2024-05-29T07:29:44Z",
    "duration": 1539,
    "visualEnabled": false },
  { "id": "abefa297-cb14-48f4-b9e8-60db12854c03",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2850,
    "type": "NLP\_TEXT",
    "action": "Select the radio button Mobile Number Radio Button",
    "message": "Unable to perform click/check action on element, Element is not displayed.",
    "errorCode": 1000001,
    "errorType": "ASSERT\_ERROR",
    "result": "FAILURE",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:47Z",
    "endTime": "2024-05-29T07:29:51Z",
    "duration": 3803,
    "visualEnabled": false },
  { "id": "49b04ef4-40fa-476f-b2a7-17d7a6e68230",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2851,
    "type": "NLP\_TEXT",
    "action": "Enter 9876543212 in the Mobile Number Radio Button field",
    "message": "Major Test step failed.",
    "errorCode": null,
    "errorType": null,
    "result": "NOT\_EXECUTED",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:54Z",
    "endTime": "2024-05-29T07:29:54Z",
    "duration": 1,
    "visualEnabled": false },
  { "id": "0a2c386f-5639-4276-b69e-f8715cd7a85c",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2852,
    "type": "NLP\_TEXT",
    "action": "Click on Continue Button",
    "message": "Major Test step failed.",
    "errorCode": null,
    "errorType": null,
    "result": "NOT\_EXECUTED",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:54Z",
    "endTime": null,
    "duration": 0,
    "visualEnabled": false }
  ],
  "totalElements": null,
  "totalPages": 1,
  "pageable": null,
  "last": false,
  "numberOfElements": 6,
  "first": true,
  "sort": null,
  "number": 0,
  "size": 100,
  "empty": false
} | + +In the response body above, we fetched the test step results of a test case with result ID 3857. + + +--- \ No newline at end of file diff --git a/src/pages/docs/api/upload-and-update-test-data-profile.md b/src/pages/docs/api/upload-and-update-test-data-profile.md index 88f6b2e5..9a16f0fb 100644 --- a/src/pages/docs/api/upload-and-update-test-data-profile.md +++ b/src/pages/docs/api/upload-and-update-test-data-profile.md @@ -1,5 +1,5 @@ --- -title: "Upload and update test data profile" +title: "Upload & Update Test Data Profile" page_title: "Upload/update test data profile via API in Testsigma" metadesc: "This article discusses in detail on REST API endpoints used for uploading the Apps and Attachments for test data profile in Testsigma Application." noindex: false diff --git a/src/pages/docs/best-practices/best-practices.md b/src/pages/docs/best-practices/best-practices.md index 83c89bca..9195bb44 100644 --- a/src/pages/docs/best-practices/best-practices.md +++ b/src/pages/docs/best-practices/best-practices.md @@ -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: @@ -70,7 +70,7 @@ Testsigma Automation Standards emphasise the reusability of automated test cases 1. You define the expected outcomes of automated test cases and specify the validations to be performed at specific points in time as verifications to understand the concept of assertions. 2. Navigate to **Help** > **Actions List** on the Test Case details page to find **NLPs** with assertions in Testsigma. ![Action Lists](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/action_list.png) 3. A failed verification in a test case marks the overall test case as failed by default. If validation fails, the remaining test steps will be skipped, and the test case execution will be aborted. -4. To implement soft assertions for scenarios that require execution of remaining steps after a test step failure, follow the steps below and for more information, refer to [Test Step Settings](https://testsigma.com/docs/test-cases/create-test-steps/actions-and-options-recorder/step-settings/): +4. To implement soft assertions for scenarios that require execution of remaining steps after a test step failure, follow the steps below and for more information, refer to [test step settings](https://testsigma.com/docs/test-cases/create-test-steps/actions-and-options-recorder/step-settings/): - Hover over the test step, click **Option**, and choose **Step Settings** from the dropdown. - Uncheck **Stop Test Case execution on Test Step failure** and click **Update**. - You can configure specific steps to continue executing even if verification fails. @@ -82,14 +82,14 @@ Testsigma Automation Standards emphasise the reusability of automated test cases 1. Filter, segment, and organise test cases for easy identification to streamline test management processes and quickly locate specific tests. 2. **Label or map relevant requirements** to test cases to facilitate filtering and improve accessibility. Users can filter and save test cases in separate views based on labelled or mapped requirements. 3. During test case creation or editing, you can add labels. The label field is available by default in the test case. ![Requirements and Labels](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/req_labels.png) -4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information, refer to [Save Test Case Filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter). +4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information, refer to [save test case filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter). --- ## **Customisation and Extensibility** 1. You can use **add-ons to extend Testsigma's repository** of actions and create custom NLPs for specific actions that are not available in the built-in Actions List. -2. Share your add-ons or leverage existing ones with the test automation community through the Add-ons Community Marketplace. You can use add-ons to provide additional functionality and expand the capabilities of Testsigma. For more information, refer to [Create an Add-on](https://testsigma.com/docs/addons/create/). +2. Share your add-ons or leverage existing ones with the test automation community through the Add-ons Community Marketplace. You can use add-ons to provide additional functionality and expand the capabilities of Testsigma. For more information, refer to [create an add-on](https://testsigma.com/docs/addons/create/). [[info | Example:]] | You create an add-on for verifying text from two DOM elements. @@ -98,7 +98,7 @@ Testsigma Automation Standards emphasise the reusability of automated test cases ## **Reusability and Modularity** -1. To avoid duplication and simplify test maintenance, use **Step Groups** as common reusable functions across test cases. Step Groups promote modular test design and easy maintenance by separating reusable components from the test flow. Any changes made to a Step Group will be reflected in all test cases that invoke it. For more information, refer to [Step Groups](https://testsigma.com/docs/test-cases/step-types/step-group/). +1. To avoid duplication and simplify test maintenance, use **Step Groups** as common reusable functions across test cases. Step Groups promote modular test design and easy maintenance by separating reusable components from the test flow. Any changes made to a Step Group will be reflected in all test cases that invoke it. For more information, refer to [step sroups](https://testsigma.com/docs/test-cases/step-types/step-group/). [[info | Example:]] | Create a Step Group to reuse login functionality in multiple test cases. @@ -109,13 +109,13 @@ Testsigma Automation Standards emphasise the reusability of automated test cases ## **Element Management** -1. Create elements with proper naming conventions to enable reuse in multiple test cases. For more information, refer to [Create an Element](https://testsigma.com/docs/elements/web-apps/create-manually/). +1. Create elements with proper naming conventions to enable reuse in multiple test cases. For more information, refer to [create an element](https://testsigma.com/docs/elements/web-apps/create-manually/). [[info | Example:]] | Use descriptive names such as "UsernameInput" or "LoginButton" to make them easy to identify. -2. You should map appropriate context details when you create elements inside **iFrames** or **Shadow DOM** contexts. Mapping context details will ensure you correctly identify and interact with elements within specific contexts. For more information refer to Shadow DOM Element. For more information, refer to [Create a Shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom). -3. You can easily access elements by saving filters and creating views based on screen names. They can check for the presence of elements in Testsigma's repository before recreating them. Element management is facilitated by adding filters. For more information, refer to [Save Element Filters](https://testsigma.com/docs/elements/overview/#save-element-filter). +2. You should map appropriate context details when you create elements inside **iFrames** or **Shadow DOM** contexts. Mapping context details will ensure you correctly identify and interact with elements within specific contexts. For more information refer to Shadow DOM Element. For more information, refer to [create a shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom). +3. You can easily access elements by saving filters and creating views based on screen names. They can check for the presence of elements in Testsigma's repository before recreating them. Element management is facilitated by adding filters. For more information, refer to [save element filters](https://testsigma.com/docs/elements/overview/#save-element-filter). [[info | Example:]] | Create a view that displays elements related to the ''Login'' screen for quick reference. @@ -126,15 +126,15 @@ Testsigma Automation Standards emphasise the reusability of automated test cases |Scope|Description|Usage| |---|---|---| -|**Environment**|
  • The value stays constant during the test execution. The environment variable's values cannot be overwritten.
  • Any test case in any test suite can be accessed.
  • To create an Environment, navigate to **Test Data** > **Environments** > **Create**. For more information, refer to [Environments](https://testsigma.com/docs/test-data/create-environment-data/)
    • |
  • Define base URLs or configuration settings specific to the environment.
  • Create test steps using the data type * url.
  • Example: //button[text()=’*\|url\|’]
    • | -|**Runtime**|The values are the same throughout a sequential test run; other tests can update them. For more information, refer to [Runtime Variable](https://testsigma.com/docs/test-data/types/runtime/).|
  • During test execution, store session-specific data or dynamic values.
  • Create test steps using the data type $ divText.
  • Example: //button[text()=’$\|divText\|’]
    • | -|**Test Data Profile**|
  • You can link specific test cases. You can update the values in test data profiles from other test cases.
  • To create a Test Data Profile, navigate to **Test Data** > **Test Data Profile** > **Create**. For more information, refer to [Test Data Profile](https://testsigma.com/docs/test-data/create-data-profiles/)
    • |
  • Use data-driven testing and maintain test data sets.
  • Create test steps using the data type **@ username**.
  • Example: //button[text()=’@\|username\|’]
    • | +|**Environment**|
  • The value stays constant during the test execution. The environment variable's values cannot be overwritten.
  • Any test case in any test suite can be accessed.
  • To create an Environment, navigate to **Test Data** > **Environments** > **Create**. For more information, refer to [environments](https://testsigma.com/docs/test-data/create-environment-data/)
    • |
  • Define base URLs or configuration settings specific to the environment.
  • Create test steps using the data type * url.
  • Example: //button[text()=’*\|url\|’]
    • | +|**Runtime**|The values are the same throughout a sequential test run; other tests can update them. For more information, refer to [runtime variable](https://testsigma.com/docs/test-data/types/runtime/).|
  • During test execution, store session-specific data or dynamic values.
  • Create test steps using the data type $ divText.
  • Example: //button[text()=’$\|divText\|’]
    • | +|**Test Data Profile**|
  • You can link specific test cases. You can update the values in test data profiles from other test cases.
  • To create a Test Data Profile, navigate to **Test Data** > **Test Data Profile** > **Create**. For more information, refer to [test data profile](https://testsigma.com/docs/test-data/create-data-profiles/)
    • |
  • Use data-driven testing and maintain test data sets.
  • Create test steps using the data type **@ username**.
  • Example: //button[text()=’@\|username\|’]
    • | --- ## **Data-Driven Testing** -1. Enable the data-driven toggle in test cases and use Test Data Profiles to perform the same action with different test data sets for data-driven testing. For more information, refer to [Data-Driven Testing](https://testsigma.com/tutorials/test-cases/data-driven-testing/). +1. Enable the data-driven toggle in test cases and use Test Data Profiles to perform the same action with different test data sets for data-driven testing. For more information, refer to [data driven testing](https://testsigma.com/tutorials/test-cases/data-driven-testing/). 2. Test Data Profiles use key-value pair format to store project configuration data, database connection details, and project settings for easy access and reuse of test data. [[info | Example:]] @@ -164,13 +164,13 @@ Testsigma Automation Standards emphasise the reusability of automated test cases ## **Configuration for Test Execution** -1. Upload attachments for test steps in **Test Data** > **Uploads** and follow the maximum file size limit of **1024 MB**. The system always considers the latest version of the uploaded file. For more information, refer to [Uploads](https://testsigma.com/docs/uploads/upload-files/). -2. Configure **Desired Capabilities** for cross-browser testing with specific browser configurations. You can configure Desired Capabilities for ad-hoc runs and test plans. For more information, refer to [Desired Capabilities](https://testsigma.com/docs/desired-capabilities/overview/). +1. Upload attachments for test steps in **Test Data** > **Uploads** and follow the maximum file size limit of **1024 MB**. The system always considers the latest version of the uploaded file. For more information, refer to [uploads](https://testsigma.com/docs/uploads/upload-files/). +2. Configure **Desired Capabilities** for cross-browser testing with specific browser configurations. You can configure Desired Capabilities for ad-hoc runs and test plans. For more information, refer to [desired capabilities](https://testsigma.com/docs/desired-capabilities/overview/). [[info | Example:]] | Specify the desired capabilities of the targeted testing, such as browser version or device type. -3. Ensure you put test cases in the Ready state before adding them to a Test Suite. Organise relevant tests into test suites for better organisation and execution. For more information, refer to [Test Suites](https://testsigma.com/docs/test-management/test-suites/overview/). +3. Ensure you put test cases in the Ready state before adding them to a Test Suite. Organise relevant tests into test suites for better organisation and execution. For more information, refer to [test suites](https://testsigma.com/docs/test-management/test-suites/overview/). [[info | Example:]] | Create a "Login Suite" and add all relevant login-related test cases for efficient execution. @@ -179,13 +179,13 @@ Testsigma Automation Standards emphasise the reusability of automated test cases ## **Execution and Test Plan Run** -1. Run test case and test plan in **Headless** mode to reduce execution time and eliminate element loading time. For more information, refer to [Headless Browser Testing](https://testsigma.com/docs/test-management/test-plans/headless-testing/). +1. Run test case and test plan in **Headless** mode to reduce execution time and eliminate element loading time. For more information, refer to [headless browser testing](https://testsigma.com/docs/test-management/test-plans/headless-testing/). [[info | Example:]] | To achieve faster test execution, execute the test plan without a visible browser. -2. Use the **Partial Run** option in the Test Plan to exclude consistently failing test suites from runs; you can exclude or disable tests for execution from the Test Machines & Suites Selection in the Test Plan. For more information, refer to [Partial Run](https://testsigma.com/docs/runs/test-plan-executions/#partial-test-runs). -3. Use the **Schedule** feature to run the test plan automatically without manual intervention. For more information, refer to [Schedule a Test Plan](https://testsigma.com/docs/test-management/test-plans/schedule-plans/). +2. Use the **Partial Run** option in the Test Plan to exclude consistently failing test suites from runs; you can exclude or disable tests for execution from the Test Machines & Suites Selection in the Test Plan. For more information, refer to [partial run](https://testsigma.com/docs/runs/test-plan-executions/#partial-test-runs). +3. Use the **Schedule** feature to run the test plan automatically without manual intervention. For more information, refer to [schedule a test plan](https://testsigma.com/docs/test-management/test-plans/schedule-plans/). [[info | Example:]] | Schedule unattended testing during non-business hours by executing the test plan. @@ -194,7 +194,7 @@ Testsigma Automation Standards emphasise the reusability of automated test cases ## **Testsigma Recorder Extension** -1. Use the Testsigma Recorder Extension to record user interactions on web applications. Customise and modify the recorded test steps to align with the desired test case behaviour. For more information, refer to [Recording Test Steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/). +1. Use the Testsigma Recorder Extension to record user interactions on web applications. Customise and modify the recorded test steps to align with the desired test case behaviour. For more information, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/#creating-test-steps-using-test-recorder). 2. Use the **Automatic Element Identification** feature of the recorder extension to easily capture elements and apply validations and verifications during recording to ensure that test steps include necessary assertions. --- diff --git a/src/pages/docs/elements/web-apps/shadow-dom.md b/src/pages/docs/elements/web-apps/shadow-dom.md index 749d159e..6a36889e 100644 --- a/src/pages/docs/elements/web-apps/shadow-dom.md +++ b/src/pages/docs/elements/web-apps/shadow-dom.md @@ -33,7 +33,7 @@ To perform reliable tests, you need to find these elements. This guide will expl ## **Prerequisites** -You must understand specific concepts such as creating [Projects](https://testsigma.com/docs/projects/overview/), [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), [Elements](https://testsigma.com/docs/elements/overview/), and [Recording Test Steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/). +You must understand specific concepts such as creating [projects](https://testsigma.com/docs/projects/overview/), [test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), [elements](https://testsigma.com/docs/elements/overview/), and [recording test steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/#creating-test-steps-using-test-recorder). --- @@ -63,8 +63,8 @@ Follow the below steps to identify if a webpage uses Shadow DOM: This section will demonstrate how to capture and store shadow DOM elements using Testsigma. For this demonstration, we'll use the shopping website [shop.polymer-project](https://shop.polymer-project.org/). -1. Navigate to **Create Tests** > **Elements** in the left side navbar. Click on **Create Element** at the top right corner of the **Elements List** page to capture the Element on the webpage. ![Create Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/elementstab_shadowdom.png) -2. Click **Create Element** to open an overlay screen on the right side of the page. Click **Record Element** within this overlay to easily capture the Element. Open the webpage in a new tab and click on the **Element** you want to capture. Then, click **Capture** to record the Element in the Record Element pop-up menu. ![Record Shadowdom Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/record_element_shadowdom.gif) +1. Navigate to **Create Tests** > **Elements** in the left side navbar. Click on **Create Element** at the top right corner of the **Elements List** page to capture the Element on the webpage. ![create elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/elementstab_shadowdom.png) +2. Click **Create Element** to open an overlay screen on the right side of the page. Click **Record Element** within this overlay to easily capture the Element. Open the webpage in a new tab and click on the **Element** you want to capture. Then, click **Capture** to record the Element in the Record Element pop-up menu. ![record shadowdom element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/record_element_shadowdom.gif) 3. Alternatively, manually fill in the **Name** and **Screen Name**, **Element Type**, **Element Value**, and **Host Values** fields to capture the Element. 4. Fill in the fields with the element **Name** and **Screen Name**. Then, choose **CSS Selector** as the **Element Type** from the dropdown menu since only CSS selectors can access elements within shadow DOM. 5. To obtain the CSS Selector, **right-click** on the webpage and choose **Inspect** to open **Chrome Developer Tools**. Then, you must locate the Element you need using the **Select Element in the page to inspect it** icon. diff --git a/src/pages/docs/open-source-docs/docker.md b/src/pages/docs/open-source-docs/docker.md index 18dbd3da..b56362a8 100644 --- a/src/pages/docs/open-source-docs/docker.md +++ b/src/pages/docs/open-source-docs/docker.md @@ -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: diff --git a/src/pages/docs/open-source-docs/introduction-community.md b/src/pages/docs/open-source-docs/introduction-community.md index 2e73a592..ddd43f53 100644 --- a/src/pages/docs/open-source-docs/introduction-community.md +++ b/src/pages/docs/open-source-docs/introduction-community.md @@ -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: diff --git a/src/pages/docs/open-source-docs/reset-password.md b/src/pages/docs/open-source-docs/reset-password.md index 26978862..aaa7e465 100644 --- a/src/pages/docs/open-source-docs/reset-password.md +++ b/src/pages/docs/open-source-docs/reset-password.md @@ -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" diff --git a/src/pages/docs/open-source-docs/testsigma-community-cloud.md b/src/pages/docs/open-source-docs/testsigma-community-cloud.md index a9c532ea..fee7e911 100644 --- a/src/pages/docs/open-source-docs/testsigma-community-cloud.md +++ b/src/pages/docs/open-source-docs/testsigma-community-cloud.md @@ -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: diff --git a/src/pages/docs/salesforce-testing/connected-app.md b/src/pages/docs/salesforce-testing/connected-app.md index 8750b947..743db1df 100644 --- a/src/pages/docs/salesforce-testing/connected-app.md +++ b/src/pages/docs/salesforce-testing/connected-app.md @@ -51,13 +51,19 @@ Creating a connected app is important to link external applications and the Sale | - Other input fields are optional. 5. In the **API** section, select the **Enable OAuth Settings** checkbox to set **Callback URL** and **Selected OAuth Scopes**. The **Selected OAuth Scopes** are mandatory in the **Connected App** to connect & download the metadata. + + - Use this Callback URL: https://salesforce-callback.testsigma.com/authorize + + ![API Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sfcaapiinfo.png) 6. Click on **Save**. ![Save](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sfcasave.png) [[info | **NOTE**:]] -| A connected app is limited to only a few approvals. The system can revoke the oldest approval when the limit exceeds automatically. As a best practice, you can create a different connected app for each new application connection/connection. +| - A connected app is limited to only a few approvals. The system can revoke the oldest approval when the limit exceeds automatically. As a best practice, you can create a different connected app for each new application connection/connection. +| - Some Salesforce editions do not have API access. Generally, these editions are not used in development or production environments, and it is not possible to create connections within them.

    +| For more information on these editions, refer to [Salesforce editions with API access](https://help.salesforce.com/s/articleView?id=000385436&type=1). --- diff --git a/src/pages/docs/salesforce-testing/introduction.md b/src/pages/docs/salesforce-testing/introduction.md index d40b494d..599d52d3 100644 --- a/src/pages/docs/salesforce-testing/introduction.md +++ b/src/pages/docs/salesforce-testing/introduction.md @@ -49,6 +49,6 @@ Salesforce is a cloud-based Customer Relationship Management (CRM) platform that ## **Getting Help** -- Reach out to Testsigma support at **support@testsigma.com**. +- For inquiries or help, reach out to Testsigma support at **support@testsigma.com**. --- \ No newline at end of file diff --git a/src/pages/docs/salesforce-testing/metadata-connections.md b/src/pages/docs/salesforce-testing/metadata-connections.md index d8690f88..a9f62cce 100644 --- a/src/pages/docs/salesforce-testing/metadata-connections.md +++ b/src/pages/docs/salesforce-testing/metadata-connections.md @@ -57,6 +57,7 @@ In Testsigma, you can create a Salesforce application and establish a Metadata c - Choose the **Authentication type** from the dropdown. In this example, we are choosing **OAuth 2.0**. ![Authentication](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sfmdatype.png) +
    ℹ️Authentication Types: @@ -64,9 +65,13 @@ In Testsigma, you can create a Salesforce application and establish a Metadata c There are two ways to Authenticate:
    • User name & Password: For User name & Password, enter Username, Password, Security token, Consumer key, and Consumer secret.
      • -
    • OAuth For OAuth, enter Username, Consumer key, Consumer secret and Callback URL.
      • +
    • OAuth: For OAuth, enter Username, Consumer key, and Consumer secret. +
    • Callback URL: https://salesforce-callback.testsigma.com/authorize
      • +
    + -
    + + - Click on **Authorise & Connect**. ![Authorise](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sfmdaaaut.png) @@ -80,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) --- diff --git a/src/pages/docs/test-cases/create-steps-restapi/store-variables.md b/src/pages/docs/test-cases/create-steps-restapi/store-variables.md index ca661fce..4cf3b560 100644 --- a/src/pages/docs/test-cases/create-steps-restapi/store-variables.md +++ b/src/pages/docs/test-cases/create-steps-restapi/store-variables.md @@ -1,7 +1,7 @@ --- title: "Store Variables" page_title: "Store Variables" -metadesc: "tored variables are variables that are used to store data from a response body or response headers | Learn about Store Variables in Testsigma" +metadesc: "Stored variables are variables that are used to store data from a response body or response headers | Learn more about Store Variables in Testsigma" noindex: false order: 4.98 page_id: "Store Variables" @@ -13,6 +13,9 @@ contextual_links: - type: link name: "Store variable from Response Body" url: "#store-variable-from-response-body" +- type: link + name: "Store variable from Response Body (HTML)" + url: "#store-variable-from-response-body-html" - type: link name: "Store Variable in Headers tab" url: "#store-variable-in-headers-tab" @@ -24,24 +27,36 @@ Stored variables in RESTful API testing are variables that are used to store dat --- -## **Store variable from Response Body** +## **Store Variable from Response Body** 1. **Send** an API request, and at the bottom of the screen, the **response body** will appear for the request you sent. 2. Click **Outline**, then select **Store Variable** to upload it directly into **Stored Variables** tab. -![store response body in tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/storevariable_restapioutline.gif) + ![store response body in tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/storevariable_restapioutline.gif) [[info | NOTE:]] | - Navigate to **Stored Variables** > **Response Body** tab, and click **Store Variable** to add the field manually. -## **Store Variable in Headers tab** +--- + +## **Store Variable from Response Body (HTML)** + +1. Send an **API Request**. The **Response Body** for your request will appear at the bottom of the screen. + +2. Hover over the HTML lines in the **Response Body** and select the attribute to store variables. This action automatically stores the attribute and displays info under the **Stored Variables** tab. + + ![Store Variables](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/StoreVariables.gif) + +--- + +## **Store Variable in Headers Tab** 1. Click **Store Variable** in the **Headers tab**. Enter the **variable name** and enter the **header name**. Click **Create** to store variable. 2. At the bottom of the page, click the **Headers** tab, mouse over to the response header, and click **store variable**; it will update in the stored variables headers tab. -![Store header in Tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/storevariable_header_restapi.gif) + ![Store header in Tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/storevariable_header_restapi.gif) --- diff --git a/src/pages/docs/test-cases/create-steps-restapi/verifications-request.md b/src/pages/docs/test-cases/create-steps-restapi/verifications-request.md index 1260a119..f2d0b6ba 100644 --- a/src/pages/docs/test-cases/create-steps-restapi/verifications-request.md +++ b/src/pages/docs/test-cases/create-steps-restapi/verifications-request.md @@ -1,7 +1,7 @@ --- title: "Verifications" page_title: "Verifications Request" -metadesc: "Check whether the Rest API is functioning correctly by adding verification and assertions. Learn about Verifications Request in Testsigma" +metadesc: "Check whether the Rest API is functioning correctly by adding verification and assertions. Learn more about Verifications Request in Testsigma" noindex: false order: 4.97 page_id: "Verifications Request" @@ -29,6 +29,7 @@ contextual_links: In Testsigma, you can check whether the Rest API is functioning correctly by adding verification and assertions. This involves testing the API endpoints, the data returned, and the response codes. Verification also includes validating the API against the requirements and ensuring that the API is secure. For verification, you need to add an API request and click **Create** to check the response. At the bottom of the screen, you can see the response and add verification. There are some steps to adding verification. --- + ## **Verification Types** These types of verification are available for JSON and XML: @@ -58,17 +59,27 @@ You can verify the response body in three ways. 2. Click **Outline**, then select **Add verification** to upload it directly into **Verification** tab. -![Add Verification in Verification Tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/responsebody_verification_restapi.gif) + ![Add Verification in Verification Tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/responsebody_verification_restapi.gif) [[info | NOTE:]] | - Navigate to **Verification** > **Response Body** tab, and click **Add Verification** to add the field manually. | - Validate values of a key received in a response body. + +### **Add Verification in Response Body (HTML)** + +1. Send an **API Request**. The **Response Body** for your request will appear at the bottom of the screen. + +2. Hover over the HTML lines in the **Response Body** and select the attribute to add for verification. This action automatically adds the attribute and its value to the **Verifications** tab. + + ![Verificatications](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/VerificationHTML.gif) + + ### **Copy Response from Response body** Click **copy response**. It will copy to the **clipboard**, paste the **JSON** or **XPATH** path field, and select the **verification type** from the drop-down list. Enter an **expected value** by using plain text or **test data types**. Click **Create** to add verification. -![Copy Response in Verification](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/copyresponse_verification_restapi.gif) + ![Copy Response in Verification](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/copyresponse_verification_restapi.gif) ### **Verify Response body** @@ -89,12 +100,12 @@ The following are two ways to verify the response body. Headers Verification in RESTful API Testing is the process of verifying that the response headers returned by the API are as expected. This includes verifying the status code, content type, and other headers that are returned. It is important to ensure that the headers are correct, as they can affect how the API is used and how the response is interpreted. -### **Add Verification in Headers tab** +### **Add Verification in Headers Tab** Click **Add Verification** in the **Headers** tab. Enter the **JSON path**, enter the **expected value** in the field, and you can enter **test data types** in the Value field. Choose the **verification type** by opening the drop-down list. Click **Create** to add verification. ![Add verification in Headers](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/headersadd_headers_restapi.png) -### **Mousehover to Response field** +### **Mousehover to Response Field** At the bottom of the page, click the **Headers** tab, mouse over to the variable, and click **Add Verification**; it will update in the Verification **headers** tab. ![Mousehover and Click Add Verification](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/headersadd_tabheaders_restapi.png) @@ -105,12 +116,12 @@ At the bottom of the page, click the **Headers** tab, mouse over to the variable Status verification in RESTful API testing is the process of verifying that the response from the API is in the expected format and contains the expected data. This is done by comparing the response from the API to the expected response. -### **Add Verification in Status tab** +### **Add Verification in Status Tab** Click **Add Verification** in the **Status tab**. Select the **key name** by opening the drop-down list, enter the **expected value** in the field, and you can enter **test data types** in the Value field. Select the **verification type** by opening the drop-down list. ![Add Verification in Status Tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/status_addverfication_restapi.png) -### **Mousehover to Response field** +### **Mousehover to Response Field** At the bottom of the page, click the **Status tab**, mouse over to the variable, and click **Add Verification**; it will update in the Verification Status tab. diff --git a/src/pages/docs/test-cases/create-steps.md b/src/pages/docs/test-cases/create-steps.md deleted file mode 100644 index cf3a55e3..00000000 --- a/src/pages/docs/test-cases/create-steps.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: "Create Test Steps in Testsigma" -metadesc: "This article discusses creating test steps manually using simple English (NLPs) as well as with a recorder for web, mobile web, Android, & iOS app in Testsigma" -noindex: false -order: 4.30 -page_id: "Create Test Steps in Testsigma" -warning: false -contextual_links: -- type: section - name: "Contents" -- type: link - name: "Prerequisites" - url: "#prerequisites" -- type: link - name: "Creating Test Steps Manually" - url: "#creating-test-steps-manually" -- type: link - name: "Creating Test Steps Using Test Recorder" - url: "#creating-test-steps-using-test-recorder" ---- - ---- - -In Testsigma terminology, each automated action executed by the test script is a test step. For example, in a login form, **Enter <username> in the <username> field** is a test step. This article discusses creating test steps for web, mobile web, Android, and iOS applications using Testsigma recorder & simple English (NLPs). - ---- - -## **Prerequisites** - -- You should have Testsigma recorder installed. - -- You should know about [test step types](https://testsigma.com/docs/test-cases/step-types/overview/). - -- Web/Android/iOS application you want to test. - - ---- - -## **Creating Test Steps Manually** - -### **Web & Mobile Web** - -1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. - -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmctcs.png) - -2. Enter **Name** and click on **Add new step**. - -![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmanstep.png) - -3. Use NLPs to create test steps as per the test case scenario. For example, if you’re creating test steps for the login page, your test steps will be: - - 1. Navigate to https://simply-travel.testsigma.com/ - 2. Click on **Login/Sign Up** - 3. Click on **Login** - 4. Enter <**email**> in the <**email address**> field - 5. Click on **Continue** - 6. Enter <**password**> in the <**password**> field - 7. Click on **Submit** - -Here's a screenshot of reproduced test steps in Testsigma application. -![Test Steps in Testsigma App](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmsavedsteps.png) - - -### **iOS Apps** - -1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. - -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmiostcs.png) - -2. Enter **Name** and click on **Add new step**. - -![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmiosts.png) - -3. Use NLPs to create test steps as per the test case scenario. - -### **Android Apps** - -1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. - -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandtcs.png) - -2. Enter **Name** and click on **Add new step**. - -![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandnewstep.png) - -3. Use NLPs to create test steps as per the test case scenario. - -[[info | **NOTE**:]] -| - By default the first step for Android and iOS applications is **Launch App**. -| - You can also add steps above and below a test step by clicking on **Step Above** & **Step Below**. -| ![Add Step Above or Below](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmasaab.png) - -
    - -Here's a sample GIF demonstrating creating test steps manually for a Web Application. - -![Creating Test Steps Manually](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/CreateTestStepsManually.gif) - - ---- - -## **Creating Test Steps Using Test Recorder** - -### **Web & Mobile Web** - -1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Case**. - -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warnavctstcswa.png) - - -2. Create a test step using the URL that you want to automate and click on **Create Step**. - -![Create Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warcs.png) - - -3. Click on **Record**. - -![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warrecord.png) - - -4. A new window will open the given URL and you can record the test steps. - -![New Window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warnwindow.png) - - -[[info | **NOTE**:]] -| Please wait a few seconds until the web page is fully loaded so the extension can collect information from the page in the background. - -5. Once the first web page is fully loaded, start interacting and performing actions on the page. - - -6. The actions will be recorded and added to the test case in the background. - - -7. Once the required actions are complete, click on **Done** to switch back to the test case details page. -![Done](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warcodone.png) - -8. You can see the steps recorded in the test case details page. -![Test Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warrcst.png) - - -### **Android & iOS Apps** - -1. Navigate to **Create Tests > Test Cases**, click on **Create Test Case**. -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosoctc.png) - -2. On **Test Case Details** page, click on **Record**. -![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosoreco.png) - -3. On **Record test steps** overlay, select **Test Lab**, **Test Machine** and **App Source** you want to test. -![Record Steps Overlay](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosotltmas.png) - -4. Click on **Record**. -![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosorctso.png) - -5. Perform the actions on the application and once the required actions are complete, stop the recording to switch back to the test case details page. - -6. The test case details page will display the steps performed on the application. - -
    - -Here's a sample GIF demonstrating creating test steps using the recorder for a Web Application. - -![Record Test Steps for WebApps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/RecordStepswappsWF.gif) - ---- \ No newline at end of file diff --git a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md index 3f38a91a..4465edf5 100644 --- a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md +++ b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md @@ -1,5 +1,5 @@ --- -title: "Test Step Settings" +title: "Test Step Settings for Test Cases" page_title: "Test Step Settings | Testsigma Documentation" metadesc: "Configure wait times, retries, visuals, and other settings for efficient test automation in Testsigma using Test Step Settings and customise test execution." noindex: false @@ -22,7 +22,7 @@ contextual_links: --- -In Testsigma, you can control how each test step behaves in your test cases by using test step settings. These settings allow you to decide how your test cases run and show results. You can also use them to set step conditions and attempt them again if required. +Controlling the behavior of each test step can be important to enhance your test coverage. Test Step Settings in Testsigma helps you decide how test cases run and show their results. With these settings, you can define step conditions, determine actions to take when test steps fail, set no of retries if necessary, and more. This enhanced control over the test step also improves the reliability of test results. --- @@ -39,21 +39,25 @@ In Testsigma, you can control how each test step behaves in your test cases by u ## **Use Test Step Settings** -To use **test step settings**, click either the **Settings** icon or the **ellipsis** icon on a particular test step. Then, choose **Step Settings** from the list that appears to open the **Test Step Settings** panel on the test case page. +To access **Test Step Settings**, click **kebab menu** on any test step, and choose **Step Settings** from the list. Below is a summary of the available settings: | **Settings** | **Description** | |:------------------|:-------------| -|**Max wait time**|Set the Maximum Wait Time limit for completing the test step. It will fail if the test step takes longer than the specified time (up to a maximum of 120 seconds).| -|**No. of Retries on Step Failure**|Select the **Number of Retries on Step Failure** from the dropdown menu (up to 10 times) to decide how many times you want to attempt to execute the test step again if it fails.| +|**Max. wait time (<120 secs)**|Set the maximum wait time limit for completing the test step. It will fail if the test step takes longer than the specified time (up to a maximum of 120 seconds).| +|**Retries on step failure (<=10)**|Give the number of retries on step failure to decide how many times you want to attempt to execute the test step if it fails.| +|**Screenshot capture**|Specify one of the following options for screenshot capture at the step level:
    • Always: Captures a screenshot irrespective of the step result.
    • Only on step failure: Captures a screenshot only if the step fails.
    • No screenshot required: Does not capture a screenshot.
    • **Use step level settings**: This option leaves the settings the same    as saved at the test step level. (Only available during execution)
    | |**Pre-Requisite**|Select a prerequisite step from the list of available steps in the same test case. This step must be successfully done before the current step runs.| |**Stop Test Case execution on Test Step**|It allows you to terminate test execution if the test fails at any step. By default, this option is checked, and test case execution will stop if the test step fails.| |**Ignore this step result in Test Case Result**|It allows you to exclude the outcome of a particular step from the overall test result.| |**Disable Step**|It allows you to capture and compare the visual appearance of an application's user interface between different builds or versions.| |**Enable Visual Testing for the Step**|You can disable the test step by choosing this option, and the test step will not run. By default, this option is unchecked.| +|**Highlight element in screenshot**|Choose this option to highlight elements on the product screen for each step. Contact Testsigma support to enable this feature.

    Navigation: **Settings > Preferences > Highlight element in screenshot**
    | -Here is a quick GIF demonstrating the above workflow: ![Test Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststep_setting.gif) +Here’s a quick GIF demonstrating how to access & update the test step settings. + +![Test Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/teststepsettingsnew.gif) --- diff --git a/src/pages/docs/test-cases/create-test-steps/overview.md b/src/pages/docs/test-cases/create-test-steps/overview.md index 85e8083f..e0e7471e 100644 --- a/src/pages/docs/test-cases/create-test-steps/overview.md +++ b/src/pages/docs/test-cases/create-test-steps/overview.md @@ -42,11 +42,11 @@ In Testsigma terminology, each automated action executed by the test script is a 1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmctcs.png) + ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmctcs.png) 2. Enter **Name** and click on **Add new step**. -![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmanstep.png) + ![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmanstep.png) 3. Use NLPs to create test steps as per the test case scenario. For example, if you’re creating test steps for the login page, your test steps will be: @@ -59,18 +59,18 @@ In Testsigma terminology, each automated action executed by the test script is a 7. Click on **Submit** Here's a screenshot of reproduced test steps in Testsigma application. -![Test Steps in Testsigma App](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmsavedsteps.png) + ![Test Steps in Testsigma App](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmsavedsteps.png) ### **iOS Apps** 1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmiostcs.png) + ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmiostcs.png) 2. Enter **Name** and click on **Add new step**. -![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmiosts.png) + ![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmiosts.png) 3. Use NLPs to create test steps as per the test case scenario. @@ -78,18 +78,18 @@ Here's a screenshot of reproduced test steps in Testsigma application. 1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandtcs.png) + ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandtcs.png) 2. Enter **Name** and click on **Add new step**. -![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandnewstep.png) + ![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandnewstep.png) 3. Use NLPs to create test steps as per the test case scenario. [[info | **NOTE**:]] | - By default the first step for Android and iOS applications is **Launch App**. | - You can also add steps above and below a test step by clicking on **Step Above** & **Step Below**. -| ![Add Step Above or Below](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmasaab.png) +| ![Add Step Above or Below](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmasaab.png)
    @@ -106,22 +106,22 @@ Here's a sample GIF demonstrating creating test steps manually for a Web Applica 1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Case**. -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warnavctstcswa.png) + ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warnavctstcswa.png) 2. Create a test step using the URL that you want to automate and click on **Create Step**. -![Create Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warcs.png) + ![Create Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warcs.png) 3. Click on **Record**. -![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warrecord.png) + ![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warrecord.png) 4. A new window will open the given URL and you can record the test steps. -![New Window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warnwindow.png) + ![New Window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warnwindow.png) [[info | **NOTE**:]] @@ -134,25 +134,31 @@ Here's a sample GIF demonstrating creating test steps manually for a Web Applica 7. Once the required actions are complete, click on **Done** to switch back to the test case details page. -![Done](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warcodone.png) + + ![Done](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warcodone.png) 8. You can see the steps recorded in the test case details page. -![Test Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warrcst.png) + + ![Test Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warrcst.png) ### **Android & iOS Apps** 1. Navigate to **Create Tests > Test Cases**, click on **Create Test Case**. -![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosoctc.png) + + ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosoctc.png) 2. On **Test Case Details** page, click on **Record**. -![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosoreco.png) + + ![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosoreco.png) 3. On **Record test steps** overlay, select **Test Lab**, **Test Machine** and **App Source** you want to test. -![Record Steps Overlay](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosotltmas.png) + + ![Record Steps Overlay](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosotltmas.png) 4. Click on **Record**. -![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosorctso.png) + + ![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosorctso.png) 5. Perform the actions on the application and once the required actions are complete, stop the recording to switch back to the test case details page. @@ -162,6 +168,6 @@ Here's a sample GIF demonstrating creating test steps manually for a Web Applica Here's a sample GIF demonstrating creating test steps using the recorder for a Web Application. -![Record Test Steps for WebApps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/RecordStepswappsWF.gif) + ![Record Test Steps for WebApps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/RecordStepswappsWF.gif) --- \ No newline at end of file diff --git a/src/pages/docs/test-cases/manage/add-edit-delete.md b/src/pages/docs/test-cases/manage/add-edit-delete.md index 91709a0d..68f87d31 100644 --- a/src/pages/docs/test-cases/manage/add-edit-delete.md +++ b/src/pages/docs/test-cases/manage/add-edit-delete.md @@ -1,6 +1,6 @@ --- -title: "Test Cases" -pagetitle: "Manage Test Cases | Testsigma Documentaion" +title: "Manage Test Cases" +pagetitle: "Manage Test Cases" metadesc: "Effortlessly manage your test cases in Testsigma by seamlessly creating, editing, deleting, and recovering them. Streamline your test case management process, adapt to changing project needs, and ensure comprehensive test coverage." noindex: false order: 4.10 @@ -38,7 +38,7 @@ Testsigma provides a comprehensive and user-friendly solution for efficiently cr ## **Prerequisites** -Ensure you create a [project](https://testsigma.com/docs/projects/overview/) before creating or editing test cases in Testsigma. +- Ensure you create a [project](https://testsigma.com/docs/projects/overview/) before creating test cases in Testsigma. --- diff --git a/src/pages/docs/test-cases/step-types/if-condition.md b/src/pages/docs/test-cases/step-types/if-condition.md index d83b6388..70b2189d 100644 --- a/src/pages/docs/test-cases/step-types/if-condition.md +++ b/src/pages/docs/test-cases/step-types/if-condition.md @@ -98,7 +98,7 @@ We can also add the **If Condition** while creating test steps using Testsigma 5. Record the steps and click on **Done**. ![Done](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/DoneFL.png) -*For more information on creating steps using recorder, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/).* +*For more information on creating steps using recorder, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/#creating-test-steps-using-test-recorder).* Here’s a quick GIF demonstrating how to add If conditions for web apps using recorder. ![Conditional IF for Web & Mobile Web](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ConditionalIFweb.gif) diff --git a/src/pages/docs/test-step-recorder/install-chrome-extension.md b/src/pages/docs/test-step-recorder/install-chrome-extension.md index b29bf09e..1f1414e7 100644 --- a/src/pages/docs/test-step-recorder/install-chrome-extension.md +++ b/src/pages/docs/test-step-recorder/install-chrome-extension.md @@ -28,19 +28,19 @@ With Testsigma's Chrome extension, users can quickly record test steps by captur 1. Go to Testsigma Recorder 2. Click on **Add to Chrome**. -![Add to Chrome](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsceatc.png) + ![Add to Chrome](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsceatc.png) 3. On the permission prompt, click on **Add extension**. -![Add Extension](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsceatchrome.png) + ![Add Extension](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsceatchrome.png) 4. On successful installation, the following message will appear: -![Message](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tscesa.png) + ![Message](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tscesa.png) Here’s a GIF demonstrating how to add Testsigma's Chrome extension. ![Chrome Extension](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/EnableChromeExt.gif) -*For more information on creating test steps using recorder, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/).* +*For more information on creating test steps using recorder, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/#creating-test-steps-using-test-recorder).* --- @@ -56,16 +56,16 @@ You can record steps in incognito mode by enabling the "Allow in Incognito" opti **1. Open the Testsigma Extension:** Right-click the Testsigma Extension icon in the browser toolbar. -![Testsigma Icon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imtch.png) + ![Testsigma Icon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imtch.png) **2. Access Extension Settings:** From the extension menu, select **Manage extension**. -![Manage Extension](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/immexten.png) + ![Manage Extension](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/immexten.png) **3. Enable Allow in Incognito:** Toggle on **Allow in Incognito** option. -![Enable Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imaiim.png) + ![Enable Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imaiim.png) Here’s a GIF demonstrating how to enable the **Allow in Incognito** option and record steps in Incognito. diff --git a/src/pages/docs/test-step-recorder/settings-include-exclude-attributes.md b/src/pages/docs/test-step-recorder/settings-include-exclude-attributes.md index ad8f3404..84ba4dcd 100644 --- a/src/pages/docs/test-step-recorder/settings-include-exclude-attributes.md +++ b/src/pages/docs/test-step-recorder/settings-include-exclude-attributes.md @@ -9,8 +9,8 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Pre-requisites" - url: "#pre-requisites" + name: "Prerequisites" + url: "#prerequisites" - type: link name: "Steps to follow" url: "#steps-to-follow" @@ -23,27 +23,33 @@ Sometimes, while capturing elements from your website, you would want to exclude   --- -##**Pre-requisites:** + +## **Prerequisites** + You should already have and know: + 1. [installed Testsigma test recorder for google chrome](https://testsigma.com/docs/test-step-recorder/install-chrome-extension/). -2. [how to create a test case via the Testsigma test recorder](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/). +2. [how to create a test case via the Testsigma test recorder](https://testsigma.com/docs/test-cases/create-test-steps/overview/#creating-test-steps-using-test-recorder).   --- -##**Steps to follow:** + +## **Steps to follow:** + 1. Start recording a test case via the Testsigma test step recorder. 2. On the Testsigma test step recorder, hover over the settings button on the top right, also highlighted in the screenshot below: -![settings button highlighted for excluding attributes and classes in Testsigma recorder](https://docs.testsigma.com/images/settings-include-exclude-attributes/settings-button-highlighted-exclude-attributes-classes-testsigma-recorder.png) + ![settings button highlighted for excluding attributes and classes in Testsigma recorder](https://docs.testsigma.com/images/settings-include-exclude-attributes/settings-button-highlighted-exclude-attributes-classes-testsigma-recorder.png) 3. On hover, menu options would appear (as also shown in the screenshot below) - click on the option ‘Excluded Attributes’. -![excluded attributes menu in Testsigma recorder](https://docs.testsigma.com/images/settings-include-exclude-attributes/excluded-attributes-menu-testsigma-recorder.png) + ![excluded attributes menu in Testsigma recorder](https://docs.testsigma.com/images/settings-include-exclude-attributes/excluded-attributes-menu-testsigma-recorder.png) 4. On the excluded attributes and classes UI that appears, you can add the attributes and classes that you want to be excluded while test step recording: -![excluded attributes UI in testsigma recorder UI](https://docs.testsigma.com/images/settings-include-exclude-attributes/excluded-attributes-ui-testsigma-recorder-ui.png) + ![excluded attributes UI in testsigma recorder UI](https://docs.testsigma.com/images/settings-include-exclude-attributes/excluded-attributes-ui-testsigma-recorder-ui.png) +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/error-handling.md b/src/pages/docs/windows-automation/error-handling.md new file mode 100644 index 00000000..1280da48 --- /dev/null +++ b/src/pages/docs/windows-automation/error-handling.md @@ -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) + +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/import-tsrx-files.md b/src/pages/docs/windows-automation/import-tsrx-files.md new file mode 100644 index 00000000..cadfa982 --- /dev/null +++ b/src/pages/docs/windows-automation/import-tsrx-files.md @@ -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) + +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/introduction.md b/src/pages/docs/windows-automation/introduction.md new file mode 100644 index 00000000..b1a4df2a --- /dev/null +++ b/src/pages/docs/windows-automation/introduction.md @@ -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 **support@testsigma.com**. + +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/object-learning.md b/src/pages/docs/windows-automation/object-learning.md new file mode 100644 index 00000000..c1402fd1 --- /dev/null +++ b/src/pages/docs/windows-automation/object-learning.md @@ -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! + +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/project-and-application.md b/src/pages/docs/windows-automation/project-and-application.md new file mode 100644 index 00000000..45c6e098 --- /dev/null +++ b/src/pages/docs/windows-automation/project-and-application.md @@ -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) + +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/test-cases.md b/src/pages/docs/windows-automation/test-cases.md new file mode 100644 index 00000000..e85801f8 --- /dev/null +++ b/src/pages/docs/windows-automation/test-cases.md @@ -0,0 +1,59 @@ +--- +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 +page_id: "Test Cases for Windows Automation" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Create & Execute Test Cases for Windows" + url: "#create--execute-test-cases-for-windows" +--- + +--- + +Build tests for a Windows application on any machine! 🚀 + +Windows Automation usually requires a Windows environment to create and execute test cases. Testsigma takes a step forward and allows you to test cases for Windows applications on any operating system using UFT Objects and smart NLPs. + +In case you have missed it, refer to [learning objects 🔍](https://testsigma.com/docs/windows-automation/object-learning/) that help you build test cases. + +--- + +## **Prerequisites** + +- A Windows Application + +- TSRx File Imported into Elements + +- Testsigma Agent Setup + +--- + +## **Create & Execute Test Cases for Windows** + +1. From the left navigation bar, go to **Create Tests > Test Cases** and click on **Create Test Case**. + +2. From the **Test Case Details** page, you can create the test steps using inbuilt **Actions/NLPs** and **Elements**. + +3. Once the test steps are created, click on **Run** to execute the **Test Case**. This will open an **Ad-Hoc Run** overlay. + +4. On **Ad-Hoc Run** overlay, select the Local **Test Machine** in which you want to run the test case, add **Additional settings**, and click **Run Now**. + +[[info | **NOTE**:]] +| Only local executions through Testsigma Agents are possible for Windows based app test executions. + +5. The test case execution will start on the selected machine. + +Here's a quick GIF demonstrating how to create & execute Test Cases for Windows application. + +![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/TestCasesWinAdv.gif) + +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/tsr-tsrx-files.md b/src/pages/docs/windows-automation/tsr-tsrx-files.md new file mode 100644 index 00000000..b7c22931 --- /dev/null +++ b/src/pages/docs/windows-automation/tsr-tsrx-files.md @@ -0,0 +1,47 @@ +--- +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 +page_id: "Converting TSR Files to TSRx" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Steps to Convert TSR Files to TSRx" + url: "#steps-to-convert-tsr-files-to-tsrx" +--- + +--- + +As discussed earlier, Testsigma only allows TSRx file for import! + +Once you have a TSR file captured from UFT One, you must convert it to TSRx file using the **OR2AppModelConverter.exe** utility. This article quickly discusses converting TSR files to TSRx files. + +ℹ️ For more information, 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). + +--- + +## **Steps to Convert TSR Files to TSRx** + +1. Go to the folder containing the **TSR** files. + +2. Launch the **Command Prompt** from the same folder. + +3. Enter the full path to the **OR2AppModelConverter.exe** utility in the **Command Prompt** window. + +4. Input the **TSR** file name you wish to convert to **TSRx** format. Confirm the file name, append 'x', and press **Enter**. + +5. This will process the conversion, and the file will be saved within the same folder in **TSRx**. + + +📌 *For more information on converting TSR to TSRx, see [UFT Help Centre](https://admhelp.microfocus.com/uftdev/en/2021-24.2/HelpCenter/Content/HowTo/UFT_AM_Converter.htm).* + + +Here's a quick GIF demonstrating how to convert a TSR files to TSRx. + +![TSR to TSRx](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/TSR-TSRXWorkflow.gif) + +--- \ No newline at end of file