diff --git a/src/left-nav-title.json b/src/left-nav-title.json index cd67a829..091a0adb 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -689,5 +689,6 @@ "genai-capabilities": {"/docs/genai-capabilities/": "GenAI Capabilities" }, "generate-tdp": {"/docs/genai-capabilities/generate-tdp/": "Generate TDP Using Copilot"}, "smtp-configuration": {"/docs/configuration/smtp-configuration/": "SMTP Configuration"}, - "generate-wda-file": {"/docs/configuration/generate-wda-file/": "Create WDA File" } + "generate-wda-file": {"/docs/configuration/generate-wda-file/": "Create WDA File" }, + "environments": {"/docs/api/environments/": "Manage Environments"} } \ No newline at end of file diff --git a/src/pages/docs/api/environments.md b/src/pages/docs/api/environments.md index 022c6e2f..709cd263 100644 --- a/src/pages/docs/api/environments.md +++ b/src/pages/docs/api/environments.md @@ -1,26 +1,23 @@ --- -title: "Update Environment parameters using REST API" -page_title: "Update Environment parameters using REST API in Testsigma" -metadesc: "How to use the REST API Endpoints available in Testsigma for reading and updating Environment data | Environments API lets you read & update the URL of the AUT dynamically" +title: "Manage Environments Using REST APIs" +page_title: "Manage Environment Parameters Using REST API in Testsigma" +metadesc: "Learn how to use the REST API Endpoints available in Testsigma for reading and updating Environments | Manage Environments Using REST APIs" noindex: false order: 21.2 -page_id: "Update Environment parameters using REST API" +page_id: "Manage Environment Parameters Using REST APIs" warning: false contextual_links: - type: section name: "Contents" - type: link - name: "Get An Environment" + name: "Get an Environment" url: "#get-an-environment" - type: link - name: "Get All Environments" - url: "#get-all-environments" + name: "Update an Environment" + url: "#update-an-environment" - type: link - name: "Update Environment" - url: "#update-environment" -- type: link - name: "Create Environment" - url: "#create-environment" + name: "Create an Environment" + url: "#create-an-environment" --- --- @@ -28,79 +25,97 @@ contextual_links: For some CI/CD pipelines, the URL of the Application Under Test (AUT) changes with every deployment. Manually updating it within the Testsigma App for every build can get tedious at scale. Environments API lets you read and update the URL of the Application under Test (AUT) dynamically after every build in your CI Pipeline. [[info | NOTE:]] -| You need to authenticate these requests with your Testsigma API Key. See [How to generate API Keys.](https://testsigma.com/docs/configuration/api-keys/) +| To authenticate these requests, you must use your Testsigma API Key. See *[How to generate API Keys.](https://testsigma.com/docs/configuration/api-keys/)* --- -## **Get An Environment** -Request Method: **GET** -Endpoint: [https://app.testsigma.com/api/v1/environments/](https://app.testsigma.com/api/v1/environments) +## **Get an Environment** + +This endpoint retrieves details for a specific Environment. + +| **Request Type** | **GET** | +|---|---| +| **Endpoint** | `https://app.testsigma.com/api/v1/environments/` | +|**Response Body (Sample)**|
{
"id": 10,
"name": "Test environment1",
"description": "Test Environment",
"createdById": 2,
"updatedById": 2,
"createdDate": 1732176819137,
"updatedDate": 1732176819137,
"createdAtEpoch": 1732176819137,
"updatedAtEpoch": 1732176819137,
"variables": [
{
"id": 8,
"key": "Url",
"value": "https://google.com",
"isEncrypted": false,
"projectId": 9,
"isDefault": null,
"createdDate": 1732176819179,
"updatedDate": 1732176819179,
"createdAtEpoch": 1732176819179,
"updatedAtEpoch": 1732176819179
}
]
}
| - can be found from the Environment details page URL +The **** can be found in the URL of the Environment details page. Refer to the screenshot below: +![Env ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Env_ID.png) +[[info | **NOTE**:]] +| To retrieve all environments, use this endpoint with the same method.
+|
+| - `https://app.testsigma.com/api/v1/environments` --- -## **Get All Environments** -Request Method: **GET** -Endpoint: https://app.testsigma.com/api/v1/environments +## **Update an Environment** +| **Request Type** | PUT | +|-----------------------|-----| +| **Endpoint** | `https://app.testsigma.com/api/v1/environments/`| +| **Authorization** | Bearer **** | +| **Request Body Type** | JSON | +| **Request Body** |
{
"name": "Test environment1",
"description": "Test Environment",
"createdById": 1,
"updatedById": 3,
"createdDate": 1731915641765,
"updatedDate": 1731915964126,
"createdAtEpoch": 1731915641765,
"updatedAtEpoch": 1731915964126,
"id": 10,
"projectId": 9,
"variables": [
{
"id": "8",
"key": "Url",
"value": "https://youtube.com",
"isEncrypted": false,
"projectId": 9,
"isDefault": null,
"createdDate": 1731915669291,
"updatedDate": 1731915669291,
"createdAtEpoch": 1731915669291,
"updatedAtEpoch": 1731915669291
}
]
}
| ---- -## **Update Environment** -|**Request Type**| PUT | -|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -|**Endpoint**| [https://app.testsigma.com/api/v1/environments/](https://app.testsigma.com/api/v1/environments)
can be found from the Environment details page URL | -|**Authorization**| Bearer
is the same as the Testsigma API Key mentioned above. | -|**Request Body Type**| JSON | -|**Request Body**| {
 "id": 53,
 "name": "newEnvironment",
 "description": null,
 "createdById": 9,
 "updatedById": 9,
 "parameters": {
  "url": "https://travel.testsigma.com/"
 },
 "passwords": []
}| +### **Request Fields:** + +- **name:** This is the environment name. -### **Request/Response fields** +- **description:** This is a description of the environment. -- **id**: The unique identifier for the environment. In this case, it's **53**. +- **createdById:** This identifies the user who created the environment. -- **Name**: The name of the environment. In this case, it's **newEnvironment**. +- **updatedById:** This identifies the user updating the environment. -- **Description**: The description of the environment. In this case, it's **null**. +- **createdDate:** This is the date and time the environment was created. -- **createdById**: The ID of the user who created the environment. In this case, it's **9**. +- **updatedDate:** This is the date and time the environment was last updated. -- **updatedById**: The ID of the user who last updated the environment. In this case, it's also **9**. +- **createdAtEpoch:** This shows the epoch timestamp when the environment was created. -- **Parameters**: An object containing the parameters for the environment. In this case, there is only one parameter with the key **url** and value https://travel.testsigma.com/. +- **updatedAtEpoch:** This shows the epoch timestamp when the environment was last updated. -- **Passwords**: Passwords is a String array containing the names of parameters that need to be encrypted. In this case, it's an empty array. +- **projectId:** Id of the associated project. [[info | NOTE:]] -| Only include the contents that need to be updated and remove the others from the Request Body +| The **Request Body** should include only the fields that are being updated or created. --- -##**Create Environment** -|**Request Type**| POST | -|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -|**Endpoint**| https://app.testsigma.com/api/v1/environments | -|**Authorization**| Bearer
is the same as the Testsigma API Key mentioned above. | -|**Request Body Type**| JSON | -|**Request Body**| {
  "parameters": {
  "url": "https://travel.testsigma.com/"
 },
 "passwords": [],
 "projectId": 191,
 "name": "newEnvironment",
 "description": null,
 "parametersJson": "{\n \\"url\\": \\"https://travel.testsigma.com/\"\n}"
} | +## **Create an Environment** + +| **Request Type** | **POST** | +|----------------------|-----------------| +| **Endpoint** | `https://app.testsigma.com/api/v1/environments` | +| **Authorization** | Bearer **** | +| **Request Body Type** | **JSON** | +| **Request Body** |

{
"name": "Test environment1",
"description": "Test Environment",
"createdById": 1,
"updatedById": 3,
"createdDate": 1731915641765,
"updatedDate": 1731915964126,
"createdAtEpoch": 1731915641765,
"updatedAtEpoch": 1731915964126,
"projectId": 9,
"variables": [
{
"key": "Url",
"value": "https://youtube.com",
"isEncrypted": false,
"projectId": 9,
"isDefault": null,
"createdDate": 1731915669291,
"updatedDate": 1731915669291,
"createdAtEpoch": 1731915669291,
"updatedAtEpoch": 1731915669291
}
]
}
 |
+
+
+
+### **Request Fields:**
+
+- **name:** This is the environment name.
+
+- **description:** This is a description of the environment.
 
+- **createdById:** This identifies the user who created the environment.
 
-### **Request/Response fields**
+- **updatedById:** This identifies the user updating the environment.
 
-- **Parameters**: An object containing the parameters for the environment. In this case, there is only one parameter with the key **url** and value https://travel.testsigma.com/.
+- **createdDate:** This is the date and time the environment was created.
 
-- **Passwords**: Passwords is a String array containing the names of parameters that need to be encrypted. In this case, it's an empty array.
+- **updatedDate:** This is the date and time the environment was last updated.
 
-- **ProjectId**: The ID of the project that the environment belongs to. In this case, it's **191**.
+- **createdAtEpoch:** This shows the epoch timestamp when the environment was created.
 
-- **Name**: The name of the environment. In this case, it's **newEnvironment**.
+- **updatedAtEpoch:** This shows the epoch timestamp when the environment was last updated.
 
-- **Description**: The description of the environment. In this case, it's **null**.
+- **projectId:** Id of the associated project.
 
-- **ParametersJson**: A JSON string representation of the parameters object. It's the same as the **parameters** object.
 
 ---
 
diff --git a/src/pages/docs/genai-capabilities/generate-tests-from-requirements.md b/src/pages/docs/genai-capabilities/generate-tests-from-requirements.md
index 71ec2b46..cceb09b8 100644
--- a/src/pages/docs/genai-capabilities/generate-tests-from-requirements.md
+++ b/src/pages/docs/genai-capabilities/generate-tests-from-requirements.md
@@ -31,7 +31,7 @@ With Testsigma, you can create test cases directly from Jira stories and epics b
 
 ## **Steps to Generate Test Cases from Requirements**
 
-1. From the left-side navbar, go to **Create Tests > Test Cases**.
+1. From the left navigation bar, go to **Create Tests > Test Cases**.
 
 2. Click **Copilot**, and then select **Generate from Requirements** from the dropdown menu. 
 
diff --git a/src/pages/docs/genai-capabilities/generate-tests-from-swagger.md b/src/pages/docs/genai-capabilities/generate-tests-from-swagger.md
new file mode 100644
index 00000000..8c1db317
--- /dev/null
+++ b/src/pages/docs/genai-capabilities/generate-tests-from-swagger.md
@@ -0,0 +1,53 @@
+---
+title: "Generate API Test Cases (Swagger)"
+page_title: "Generate API Test Cases Using Swagger Schema"
+metadesc: "In Testsigma, you can create test cases from swagger schema files | Learn how to create API test cases from Swagger using GenAI capabilities"
+noindex: false
+order: 31.5
+page_id: "Generate Tests from Swagger Schema"
+warning: false
+contextual_links:
+- type: section
+  name: "Contents"
+- type: link
+  name: "Prerequisites"
+  url: "#prerequisites"
+- type: link
+  name: "Steps to Generate Test Cases from Swagger"
+  url: "#steps-to-generate-test-cases-from-swagger"
+---
+
+---
+
+With Testsigma, you can now generate API test cases effortlessly by importing Swagger JSON schema files. Simply organize tags for endpoints in the Swagger JSON file, upload the file, and click once to create multiple test cases. This article discusses generating API test cases from Swagger schema files using Testsigma's GenAI capabilities.
+
+---
+
+> ## **Prerequisites**
+> 
+> Before you begin, enable AI Features from **Settings > Preferences > Generative AI features**, and have a **Swagger JSON file** with tags arranged for endpoints.
+
+---
+
+## **Steps to Generate Test Cases from Swagger**
+
+1. From the left navigation bar, go to **Create Tests > Test Cases**.
+
+2. Click **Copilot**, and then select **Generate from Swagger Schema** from the dropdown menu.
+
+3. On the **Swagger Schema based API Test Case Generation** dialog, click **Select file to import**. 
+
+4. Choose the file and click **Open**.
+
+   [[info | **NOTE**:]]
+   | Testsigma Copilot uses tags in the Swagger Schema file to arrange endpoints into test cases. Ensure each endpoint is associated with one or more tags before importing the file.
+
+5. In the **Available Test Cases** section, select the test cases you want to generate and click **Generate**.
+
+6. Wait for Testsigma to generate the test cases along with the test steps.
+
+7. From the left panel, select all the test cases you want to include, review the API test steps, validate them, and click **Save Test Cases**.
+
+4. You’ll be redirected to the **Test Cases** page, where the generated test cases appear under the **AI Generated Feature & Scenario**.
+
+---
\ No newline at end of file
diff --git a/src/pages/docs/genai-capabilities/generate-tests-from-user-actions.md b/src/pages/docs/genai-capabilities/generate-tests-from-user-actions.md
index 32d6eeb1..f65686ca 100644
--- a/src/pages/docs/genai-capabilities/generate-tests-from-user-actions.md
+++ b/src/pages/docs/genai-capabilities/generate-tests-from-user-actions.md
@@ -33,7 +33,7 @@ This article discusses generating end to end automated test cases based on user
 
 ## **Steps to Test Scenarios from User Actions**
 
-1. From the left-side navbar, go to **Create Tests > Test Cases**. 
+1. From the left navigation bar, go to **Create Tests > Test Cases**. 
 
 2. Click **Copilot** and choose **Test Scenarios from User Actions** from the dropdown menu. This will open the **Generate End-to-End Test Cases** dialog box.
 
diff --git a/src/pages/docs/salesforce-testing/special-nlps.md b/src/pages/docs/salesforce-testing/special-nlps.md
index a4c50c58..641486e3 100644
--- a/src/pages/docs/salesforce-testing/special-nlps.md
+++ b/src/pages/docs/salesforce-testing/special-nlps.md
@@ -69,6 +69,9 @@ contextual_links:
 - type: link
   name: "NLP 17:"
   url: "#nlp-17"
+- type: link
+  name: "NLP 18:"
+  url: "#nlp-18"
 ---
 
 ---
@@ -108,6 +111,7 @@ With Testsigma's special NLPs, you can scale and enhance Salesforce Testing. The
 | [Select option test data from element picklist](https://testsigma.com/docs/salesforce-testing/special-nlps/#nlp-16) | This NLP selects the specified option from the picklist element using test data. This NLP can also be recorded. 

**User Inputs in NLP:**
1. Test Data
2. Element | | [Clear and enter test data in the element field](https://testsigma.com/docs/salesforce-testing/special-nlps/#nlp-10) | This NLP will clear any existing data in the element field and then enter the test data into that field.

**User Inputs in NLP:**
1. Test Data
2. Element | | [Delete record in Salesforce Object where record id is test data using Salesforce Connection connection](https://testsigma.com/docs/salesforce-testing/special-nlps/#nlp-3) | This NLP deletes a record using RECORD\_ID for a specific Salesforce object using the delete record API.

**User Inputs in NLP:**
1. RECORD_ID
2. User Connection
3. Salesforce Object | +|[Get record details from Salesforce Object Form for RECORD\_ID test data using Salesforce Connection connection](https://testsigma.com/docs/salesforce-testing/special-nlps/#nlp-18)| This NLP will fetch record details of the Salesforce Object Form with the selected object fields. It also allows you to store Variables and add Verifications directly from the Response Body.

**User Inputs in NLP:**
1. Salesforce Object Form
2. RECORD_ID
3. Salesforce Connection | --- @@ -337,4 +341,33 @@ See the GIF below demonstrating how to use this NLP. ![Element Picklist](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/SalesforceUpdateNLP.gif) + +--- + +## **NLP 18:** + +“Get record details from **Salesforce Object Form** for **RECORD\_ID** test data using **Salesforce Connection** connection” + + +### **Using the NLP in a Test Case** + + +1. Click on **Salesforce Object Form**, choose **Record** from the dropdown menu, and click **Select Fields**. + +2. On the **Manage Fields for Account** overlay, select the fields for which you want to retrieve info and click **Save**. + + [[info | **NOTE**:]] + | If no fields are selected, the response body will include all available fields. + +3. Go to the **Request Info** tab, enter the **Record ID** and select the available **Salesforce Connection**. You can parameterize the **Record ID** by entering a slash (**/**). Add mock values by clicking **Add Request Values** if the field is parameterized. + +4. Click **Send Request**. + +5. From the **Response Body**, you can store **Variables** and add **Verifications** directly as needed. + + +See the GIF below demonstrating how to use this NLP. + +![Get Record Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/SF_Read_API.gif) + --- \ No newline at end of file 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 8b32a68d..2b47c08f 100644 --- a/src/pages/docs/test-cases/create-test-steps/overview.md +++ b/src/pages/docs/test-cases/create-test-steps/overview.md @@ -27,7 +27,7 @@ In Testsigma terminology, each automated action executed by the test script is a > ## **Prerequisites** > -> Before you begin, ensure you're familiar with concepts of [Test Step Types](https://testsigma.com/docs/test-cases/step-types/overview/), have installed the [Test Recorder](https://testsigma.com/docs/test-step-recorder/install-chrome-extension/), and have a Web/Android/iOS app to test. +> Before you begin, ensure you're familiar with concepts of [Features and Scenarios](https://testsigma.com/docs/test-cases/manage/features-and-scenarios/), [Test Step Types](https://testsigma.com/docs/test-cases/step-types/overview/), have installed the [Test Recorder](https://testsigma.com/docs/test-step-recorder/install-chrome-extension/), and have a Web/Android/iOS app to test. --- @@ -36,147 +36,143 @@ In Testsigma terminology, each automated action executed by the test script is a ### **Web & Mobile Web** -1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. +1. From the left navigation bar, go to **Create Tests** > **Test Cases**. + ![Left Navigation Bar](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Left_NavBar_TestCases.png) - ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmctcs.png) +2. In the **Test Case Explorer** section, expand the required feature and click the **+** icon next to the target scenario. This will open a dialog box. + ![Feature Test Case Explorer](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Feature_Test_case_explorer.png) -2. Enter **Name** and click on **Add new step**. +3. On the dialog box, validate the target feature and scenario, enter the name, and click **Create**. + ![Test Case Name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Case_Name.png) - ![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmanstep.png) + Alternatively, click the **+** icon next to the search bar and select **New Test Case** from the drop-down menu. Follow the same steps as above. + ![Search bar test case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Search_bar_test_case.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** +[[info | **NOTE**:]] +| +| - You can edit the target feature and scenario by clicking on the **Edit** icon. This will open the **Select Location** dialog. +| ![Scenario Change Edit Icon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Scenario_Change_Edit_Icon.png) +| - In the **Select Location** dialog, select the target feature and scenario and click **Confirm**. +| ![Select Scenario Location ](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Select_Scenario_Location.png) +| - This feature functions consistently across all applications. + +4. 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 or 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 the test steps that were reproduced in the Testsigma application: + ![Login New Credentials 1](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Login_New_Credentials_1.png) + +### **Android and iOS** -1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Cases**. +1. From the left navigation bar, go to **Create Tests** > **Test Case**. + ![Android Create Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Android_Create_Test_Case.png) - ![Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandtcs.png) +2. In the **Test Case Explorer** section, expand the required feature and click the **+** icon next to the target scenario. This will open a dialog box. + ![Android New Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Android_New_Test_Case.png) -2. Enter **Name** and click on **Add new step**. +3. On the dialog box, validate the target feature and scenario, enter the name, and click **Create**. + ![Test Case Name New](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Case_Name_New.png) - ![New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ctsmandnewstep.png) + Alternatively, click the **+** icon next to the search bar and select **New Test Case** from the drop-down menu. Follow the same steps as above. + ![Search Bar Test Case Selection](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Search_Bar_Test_Case_Selection.png) -3. Use NLPs to create test steps as per the test case scenario. +4. 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**. +| +| - 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) +| ![Create New Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_New_Steps.png) --- ## **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) +### **Web and Mobile Web** +1. From the left navigation bar, go to **Create Tests** > **Test Cases**. + ![Record Create Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Record_Create_Test_Case.png) -3. Click on **Record**. +2. In the **Test Case Explorer** section, expand the required feature and click the **+** icon next to the target scenario. This will open a dialog box. + ![Plus Icon Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Plus_Icon_Test_Case.png) + - ![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warrecord.png) +3. On the dialog box, validate the target feature and scenario, enter the name, and click **Create**. + ![Record Test Case Name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Record_Test_Case_Name.png) + Alternatively, click the **+** icon next to the search bar and select **New Test Case** from the drop-down menu. Follow the same steps as above. + ![Record Search Bar Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Record_Search_Bar_Test_Case.png) -4. A new window will open the given URL and you can record the test steps. +4. Create a test step using the URL that you want to automate and click **Create Step**. + ![Create Steps Button](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_Steps_Button.png) - ![New Window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/warnwindow.png) +5. Click **Record**. + ![Record Button](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Record_Button.png) +6. A new window will open the given URL. + ![New Window URL](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/New_Window_URL.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. +| +| - Please wait 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. +7. Once the first web page is fully loaded, start interacting and performing actions on the page. +8. The actions will be recorded and added to the test case in the background. -6. The actions will be recorded and added to the test case in the background. +9. Once the required actions are complete, click on **Stop** to switch back to the test case details page. + ![Record Stop Buton](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Record_Stop_Button.png) +10. You can see the steps recorded in the test case details page. + ![Recorded Steps 1](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Recorded_Steps_1.png) -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) +### **Android and iOS** -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) +1. From the left navigation bar, go to **Create Tests** > **Test Cases**. + ![Create Test Case iOS](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_Test_Case_iOS.png) +2. In the **Test Case Explorer** section, expand the required feature and click the **+** icon next to the target scenario. This will open a dialog box. + ![New Test Case iOS](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/New_Test_Case_iOS.png) -### **Android & iOS Apps** +3. On the dialog box, validate the target feature and scenario, enter the name, and click **Create**. + ![Test Case Name iOS](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Test_Case_Name_iOS.png) -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) + Alternatively, click the **+** icon next to the search bar and select **New Test Case** from the drop-down menu. Follow the same steps as above. + ![Search Bar Test Case iOS](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Search_Bar_Test_Case_iOS.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) +4. Click **Create Step** and click **Record**. + ![Start Test Case Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Start_Test_Case_Steps.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) +5. In the **Record test steps** overlay, select the required options in the **Test Lab** and **Test Machine** sections. + ![Record Settings 1](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Record_Settings_1.png) -4. Click on **Record**. - - ![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/iosorctso.png) +6. Click **Upload** and upload the required file. + ![Upload iOS](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Upload_iOS.png) + +7. Click **Record**. + ![Record Button iOS](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Record_Button_iOS.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. +8. 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. +9. The test case details page will display the steps performed on the application. -
-
-

- - ⚡ New: You can now directly interact with mobile elements, and the recorder will automatically capture the action and convert it into the corresponding NLPs. -

-
[[info | **NOTE**:]] -| If direct recording doesn't work, revert to the old method and use the **TAP** button to record the element. +| +| - If direct recording doesn't work, revert to the old method and use the **TAP** button to record the element. -
-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/manage/custom-fields.md b/src/pages/docs/test-cases/manage/custom-fields.md new file mode 100644 index 00000000..301db92c --- /dev/null +++ b/src/pages/docs/test-cases/manage/custom-fields.md @@ -0,0 +1,101 @@ +--- +title: "Custom Fields for Test Cases" +pagetitle: "Custom Fields for Test Cases" +metadesc: "Create custom fields to enter specific details, add them to your test cases, and filter test cases as per the available custom fields." +noindex: false +order: 4.19 +page_id: "Custom Fields" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Create a Custom Field" + url: "#create-a-custom-field" +- type: link + name: "Add the Custom Field to a Test Case" + url: "#add-the-custom-field-to-a-test-case" +- type: link + name: "Filter Test Cases Using Custom Fields" + url: "#filter-test-cases-using-custom-fields" +--- + +--- + + +Testsigma allows you to add customized information to your test cases by creating custom fields. You can also use these custom fields to filter and find specific test cases as needed. This article discusses creating a custom field, adding it to a test case, and filtering test cases using custom fields. + +--- + +> ## **Prerequisites** +> +> - Before you begin, you must be familiar with the concepts of [Test Case Advanced Options](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#test-case----advanced-options). + +--- + +## **Create a Custom Field** +1. From the left navigation bar, go to **Settings**. + ![Create custom fields 1](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_custom_fields_1.png) + +2. In the **Admin Settings** section, click on **Custom Fields**. + ![Create custom fields 2](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_custom_fields_2.png) + +3. Click **Add new field**. + ![Create custom fields 3](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_custom_fields_3.png) + +4. In the **Add new field** in the **Test Case** overlay, + * Enter the name in the **Field Name** field. + ![Create custom fields 4](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_custom_fields_4.png) + + * Enter the description in the **Description** field. + ![Create custom fields 5](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_custom_fields_5.png) + + * Choose the **Field Type** from the dropdown menu. + ![Create custom fields 6](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_custom_fields_6.png) + +5. Click **Add**. + ![Create custom fields 7](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Create_custom_fields_7.png) + + Here's a sample GIF demonstrating creating a custom field + ![Custom field new](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Custom_Field_new.gif) + +--- + +## **Add the Custom Field to a Test Case** +1. From the left navigation bar, go to **Create Tests** > **Test Cases**. + ![Add custom field to test case new](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_the_custom_field_to_a_Test_case_new.png) + +2. Select the **Test Case** for which you want to add the Custom Field. + ![Add custom field to test case 2](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_custom_field_to_test_case_2.png) + +3. From the utility panel, click on **Manage Test Case** and scroll down to view the **Custom Fields** section. + ![Add custom field to test case 3](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_custom_field_to_test_case_3.png) + +4. Enter the required details. + ![Add custom field to test case 4](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_custom_field_to_test_case_4.png) + +5. Click **Close**. + ![Add custom field to test case 5](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_custom_field_to_test_case_5.png) + + Here's a sample GIF demonstrating adding the custom field to a test case + ![Add the custom field to a test case 1](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_the_custom_field_to_a_test_case_1.gif) + +--- + +## **Filter Test Cases Using Custom Fields** +1. From the left navigation bar, go to **Create Tests** > **Test Cases**. + ![Add custom field to test case new](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_the_custom_field_to_a_Test_case_new.png) + +2. In the **Test Case Explorer** section, click on **List View**. + ![Filter custom fields 2](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Filter_custom_fields_2.png) + +3. In the **Test Cases** screen, click on **Show Filters**. + ![Filter custom fields 3](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Filter_custom_fields_3.png) + +4. Expand **Add Filter** and select the available custom field. + ![Filter custom fields 4](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Filter_custom_fields_4.png) + +---