diff --git a/src/left-nav-title.json b/src/left-nav-title.json index 895b33ea..60559200 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -206,7 +206,7 @@ "/docs/test-data/create-data-profiles/": "Create Test Data [Parameter]" }, "import-data-profiles": { - "/docs/test-data/import-data-profiles/": "Import Test Data [Parameter]" + "/docs/test-data/import-data-profiles/": "Import TDP" }, "create-environment-data": { "/docs/test-data/create-environment-data/": "Create Test Data [Environment]" @@ -215,7 +215,7 @@ "/docs/test-data/data-generators/overview/": "Test Data Generators" }, "elements": { - "/docs/elements/": "Elements(Objects)", + "/docs/elements/": "Elements (Objects)", "/docs/api/elements/": "Elements" }, "record-multiple-elements": { @@ -583,5 +583,14 @@ }, "multiple-webviews":{ "/docs/test-cases/create-test-steps/actions-and-options-recorder/multiple-webviews/": "Tests for Multiple WebViews" + }, + "faqs":{ + "/docs/getting-started/faqs/": "FAQs" + }, + "manage-execution-stops":{ + "/docs/collaboration/manage-execution-stops/": "Execution Controls" + }, + "add-values-to-test-data-profile":{ + "/docs/test-data/add-values-to-test-data-profile/": "Updating Value in TDP" } } \ No newline at end of file diff --git a/src/pages/docs/collaboration/assign-projects.md b/src/pages/docs/collaboration/assign-projects.md index eb7e1705..f8da1fdf 100644 --- a/src/pages/docs/collaboration/assign-projects.md +++ b/src/pages/docs/collaboration/assign-projects.md @@ -1,152 +1,90 @@ --- -title: " Assign Projects to Users" -metadesc: "How to assign projects to a user in Testsigma." +title: "Assign Projects to Users" +metadesc: "In Testsigma, users can be assigned to multiple projects when required | This article discusses how to add users to multiple projects" noindex: false -order: 3.2 +order: 3.1 page_id: "Assign Projects to Users" warning: false contextual_links: - type: section name: "Contents" - type: link - name: "Pre-requisites" - url: "#pre-requisites" + name: "Prerequisites" + url: "#prerequisites" - type: link - name: "Assign from Project Members page" - url: "#assign-from-project-members-page" + name: "Assigning New Users to a Project" + url: "#assigning-new-users-to-a-project" - type: link - name: "Assign Users to multiple projects from global settings" - url: "#assign-users-to-multiple-projects-from-global-settings" -- type: link - name: "Pre-requisites" - url: "#pre-requisites-1" -- type: link - name: "Steps to follow to assign project(s) to a new user" - url: "#steps-to-follow-to-assign-projects-to-a-new-user" -- type: link - name: "Steps to follow to assign project(s) to an existing user" - url: "#steps-to-follow-to-assign-projects-to-an-existing-user" -- type: link - name: "Edit the Projects assigned to a user" - url: "#edit-the-projects-assigned-to-a-user" + name: "Assigning Existing Users to a Project" + url: "#assigning-existing-users-to-a-project" --- ---- -In Testsigma, multiple projects can be created and users can be assigned to those projects when required. -To create a new user and then assign them to one or multiple projects, refer to [Inviting team members](https://testsigma.com/docs/collaboration/invite-team-members/). +--- -  +In Testsigma, you can create multiple projects and assign users to those projects when required. This article discusses adding users/members to multiple projects in Testsigma. --- -##**Pre-requisites** -1. You should already have created a project and you should be a member of it. - -2. To add a user to a project, you should have the role of either test manager or admin for that project. To learn about roles, refer to [user roles](https://testsigma.com/docs/collaboration/users-roles/). - -3. The user you want to add should have been added to Testsigma and should not be added to the project. To learn how to invite team members to Testsigma, refer to [adding team members](https://testsigma.com/docs/collaboration/invite-team-members/). -  +## **Prerequisites** ---- -##**Assign from Project Members page** -1. Go to Select Project > Project Settings > Project Members - -2. Select the Project that you want a new user to be assigned to. - -3. Go to project settings. - -4. Under project settings, go to ‘Project Members’ - -5. Click on the button “+Assign” as also shown in the screenshot below: -![project members in Testsigma](https://docs.testsigma.com/images/assign-projects/project-members-testsigma.png) +- You should know how to create a [project](https://testsigma.com/docs/projects/overview/). + -6. You will see the ‘Add Existing Member to Project’ form as below: +- To add a user to a project, you should have the role of either test manager or admin for that project. *For more information, see [user roles](https://testsigma.com/docs/collaboration/users-roles/).* -![add existing member to project in Testsigma](https://docs.testsigma.com/images/assign-projects/add-existing-member-to-project-testsigma.png) -Here, select the user that you want to add to the project and select the role that you want to assign to them and click on ‘Assign’. +- You should know how to invite team members to Testsigma, see [adding team members](https://testsigma.com/docs/collaboration/invite-team-members/). -Now, the selected user will be assigned to your project with the selected role. -[[info | Note:]] -|If you want to create new users to assign projects, refer to [user roles](https://testsigma.com/docs/collaboration/users-roles/). +--- +## **Assigning New Users to a Project** -  ---- -##**Assign Users to multiple projects from global settings** -In this section we will cover how to assign a user to multiple projects. +1. Navigate to **Setings > Users**. +![Users](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpnavusers.png) -  +2. Click on **Add new user**. This will open a promot. +![New User](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpcoaurs.png) ---- -##**Pre-requisites:** -1. To be able to assign different projects to a user, you should either have the role of an administrator or Test Manager. - -2. You should be added to the projects that you want to assign a user to. - -3. The user you want to add should have been added to Testsigma and should not be added to the project. To know more about how to invite team members to Testsigma, read [here](https://testsigma.com/docs/collaboration/invite-team-members/). -  +3. On **Add new user** prompt, enter **Email**, check **projects** you want to assign and **roles** corresponding to projects. +![Add new users](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpsprjcts.png) -### Navigation: -Settings > Users -  +4. Click on **Send Invite**. +![Invite](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpsendinvite.png) ---- -##**Steps to follow to assign project(s) to a new user:** -1. Go to ‘Settings > Users’, you should see a page like this: - -![Users page in Testsigma](https://docs.testsigma.com/images/assign-projects/users-page-testsigma.png) -2. Add a new user, click on the ‘+New User’ button on the top right. - -3. A form should appear like the one shown below: +5. The user will get an email with the link to join the required project(s). -![create new user form in Testsigma](https://docs.testsigma.com/images/assign-projects/create-new-user-form-testsigma.png) -From here, you can fill up the required fields, select if you want to make the user a ‘Super Administrator. And then, select the projects to be assigned and the corresponding access role. +Alternatively, you can also add users from **Project Settings**. For more information, refer to [user roles](https://testsigma.com/docs/collaboration/users-roles/). -4. Once all the required fields are filled, click on the ‘Invite’ button - -5. The user will be sent an email with the link to join the required project(s). - -  --- -##**Steps to follow to assign project(s) to an existing user:** -1. Go to ‘Settings > Users’, you should see a page like this: -![Users page in Testsigma](https://docs.testsigma.com/images/assign-projects/users-page-testsigma.png) -2. Click on the user that you want to assign to a project. You can also search for the user from the search field on the top. - -3. On the User details page, click on the ‘edit’ button on the top right corner. - -![Edit Button on the User Details page in Testsigma](https://docs.testsigma.com/images/assign-projects/edit-button-user-details-page-testsigma.png) +## **Assigning Existing Users to a Project** -4. A form should appear like the one shown below: -![Update User Details form in Testsigma](https://docs.testsigma.com/images/assign-projects/update-user-details-form-testsigma.png) +1. Navigate to **Settings > Users**, click on the kebab menu corresponding to the user you want to assign a project. +![Kebab Menu](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpkm.png) -From here, you can fill up the required fields, select if you want to make the user a ‘Super Administrator. And then, select the projects to be assigned and the corresponding access role. -5. Once all the required fields are filled, click on the ‘Update’ button - -6. The user will be assigned the selected projects with the selected access roles. +2. From the dropdown, click on **Edit user role**. This will open a prompt. +![Dropdown](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpdd.png) -  ---- -##**Edit the Projects assigned to a user:** -To edit the projects assigned to a user and to update the role for them you have to follow the steps discussed in the section **‘Steps to follow to assign project(s) to an existing user’** above, and check/uncheck the projects assigned and change the access roles for the user from the ‘update user details’ form. +3. On **Edit User Role / Assign Projects** prompt, edit the details and click on **Update**. +![Update](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpudetls.png) +4. The user will be assigned the selected projects with the selected access roles. +--- \ No newline at end of file diff --git a/src/pages/docs/collaboration/deleting-users-from-a-project.md b/src/pages/docs/collaboration/deleting-users-from-a-project.md index bc504d25..1af6ec46 100644 --- a/src/pages/docs/collaboration/deleting-users-from-a-project.md +++ b/src/pages/docs/collaboration/deleting-users-from-a-project.md @@ -44,7 +44,7 @@ In Testsigma, you can delete users from your project. This article will discuss --- -##**Delete user via Settings** +## **Delete user via Settings** 1. Navigate to **Settings** > **Users**. ![Global Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_globalsettingsuser.png) @@ -56,4 +56,6 @@ In Testsigma, you can delete users from your project. This article will discuss 4. On the pop-up window, click on **Yes, Delete** to confirm the deletion. ![Confirmation in Global settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_deletingmemberglobalconfirm.png) -5. The user will be successfully removed from the project. \ No newline at end of file +5. The user will be successfully removed from the project. + +--- \ No newline at end of file diff --git a/src/pages/docs/collaboration/elements-review-management.md b/src/pages/docs/collaboration/elements-review-management.md index 9f604b78..7073292a 100644 --- a/src/pages/docs/collaboration/elements-review-management.md +++ b/src/pages/docs/collaboration/elements-review-management.md @@ -9,96 +9,95 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Pre-requisites" - url: "#pre-requisites" + name: "Prerequisites" + url: "#prerequisites" - type: link - name: "Step to follow to send an element for review to other team members" - url: "#step-to-follow-to-send-an-element-for-review-to-other-team-members" + name: "Steps to Submit Elements for Review" + url: "#steps-to-submit-elements-for-review" - type: link - name: "Steps to follow when you have an element to review" - url: "#steps-to-follow-when-you-have-an-element-to-review" -- type: link - name: "Steps to follow to self-review an element" - url: "#steps-to-follow-to-self-review-an-element" + name: "Steps to Review Element" + url: "#steps-to-review-element" --- --- -Once an element is created in Testsigma, it can be reviewed in two ways: -1. **Self Review:** When you create the elements but are yet to finalize them, mark them for self-review. +Once an element is created in Testsigma, it can be reviewed by your team using the **Element Review Management** feature. This article discusses how to review elements within your team in Testsigma application. + +There are two ways to review an element: + +1. **Self Review:** When you create the elements but have not finalized them, mark them for self-review. -2. **Review management involving other team members:** This is an easy way to make everyone responsible for the quality of test automation. Here, the testers can create elements and can ask their peers, managers as well as clients to review the created elements. +2. **Review management involving other team members:** This is an easy way to make everyone responsible for the quality of test automation. Here, the testers can create elements and ask their peers and managers to review the created elements. -  --- -##**Pre-requisites:** -1. You should know how to create an element. If not, refer to [create elements](https://testsigma.com/docs/elements/android-apps/create-manually/). - -2. To enable review management in Testsigma, make sure the option ‘Test Case Review Management’ is enabled under ‘Settings > Preferences’ -![test case review management and self review management options in Testsigma](https://docs.testsigma.com/images/elements-review-management/test-case-review-management-self-review-management-options-testsigma.png) +## **Prerequisites** -3. Hit the toggle in ‘Self-review management’ to enable self-reviews. +- You should know how to create an element. If not, refer to [create elements](https://testsigma.com/docs/elements/overview/). + + +- To enable review management, make sure the option **Element Review Management** is enabled under **Settings > Preferences**. +![Element Review Management](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/urmelmma.png) -  --- -##**Step to follow to send an element for review to other team members:** -1. Go to the Project - -2. Go to Test Development > Elements - -3. Create a new element - -4. Once you have created the Element, go to ‘Edit Element’ - -5. Click on the ‘Submit for Review’ in the top right corner. -![submit-a-Element-for-review-in-Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/collaboration/elements-review-management/submit-a-Element-for-review-in-Testsigma.png) -6. ‘Submit for Review’ form should come up: +## **Steps to Submit Elements for Review** -![Submit for review pop up for Testsigma](https://docs.testsigma.com/images/elements-review-management/submit-for-review-pop-up-testsigma.png) +1. Navigate to **Create Tests > Elements**. +![Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ersnavelm.png) + + +2. Hover over the element you want to submit for review and click on it. This will open element details overlay. + + +3. On **Element Details** overlay, click on **Edit**. +![Edit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/erscoedit.png) + + +4. On **Update Element** overlay, click on **Submit for Review**. This will open a prompt for submission details. +![Submit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/erssfre.png) + + +5. On **Submit for Review** prompt, select **Reviewer** from the dropdown, add comments (optional) and click on **Submit**. +![Submit for Review](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/erssfrprompt.png) -7. From the reviewer drop-down, select the user that should review your Element, add comments in the comments section, and click on the ‘Submit’ button. - -8. Once submitted, the reviewer will get an email notifying them that a Element has been assigned to them to review. The status of the review can also be tracked from the ‘SUBMITTED FOR REVIEW>ELEMENTS’ section displayed on the dashboard. -  --- -##**Steps to follow when you have an element to review:** -1. When you have an element to review, you shall be notified in an email too. Additionally, you can track the status of the received reviews under the section: ‘WAITING FOR YOUR REVIEW > ELEMENTS’ on the dashboard: -![Submit for review and waiting for review section on dashboard in Testsigma](https://docs.testsigma.com/images/elements-review-management/submit-for-review-waiting-for-review-section-dashboard-testsigma.png) -2. To proceed you can click on the Element link received in the email or click on the element shown under the ‘WAITING FOR YOUR REVIEW’ section: - -3. You will be taken to the Element to review. - -4. Click on the ‘Review’ button on the top right: +## **Steps to Review Element** -![Review-Button-on-Edit-Element-tab-in-Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/collaboration/elements-review-management/Review-Button-on-Edit-Element-tab-in-Testsigma.png) +1. On the **Dashboard**, go to **Assigned for your review** section and click on **Elements**. +![Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ersdnav.png) -5. The ‘Review Element’ form should open: -![Review Element form in Testsigma](https://docs.testsigma.com/images/elements-review-management/review-element-form-testsigma.png) +2. Click on the **element** you are assigned to review. This will open **Elements** page with elements assigned for review. +![Element to review](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/erscoewinreview.png) -**Here you can:** -a. Add your comments +3. Hover over the element and click on the kebab menu and select **Edit** from the dropdown. +![Edit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/erskmedit.png) -b. Check the box ‘send comment notification to assignee and reviewer’ if you want the assignee and reviewer to be notified. -c. Click on ‘Rework’ if the element needs more work before it’s finalized. +4. On **Update Element** ovarlay, click on **Review element**. +![Review Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/rsecorelement.png) -The steps above can be repeated until the Element is approved. -  +5. On the **Update review status** prompt, you can either mark the status as **Approv** or **Rework** as per your review. +![Status](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ersaprw.png) ---- -##**Steps to follow to self-review an element:** -The steps to self-review an element are the same as when you assign another team-member the element for review. The only difference is that the creator assigns the element to review to themselves and all stages of reviews are done by the creator. + +6. Once the status is marked, you'll be redirected to the **Update Element** overlay. Click on **Update Element** to save the review status. +![Update Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/erscouear.png) + + + +[[info | **NOTE**:]] +| The steps to self-review an element are the same as when you assign another team member the element for review. The only difference is that the creator assigns the element to review to themselves, and the creator does all stages of reviews. +--- \ No newline at end of file diff --git a/src/pages/docs/collaboration/invite-team-members.md b/src/pages/docs/collaboration/invite-team-members.md index 4cb39122..cc744079 100644 --- a/src/pages/docs/collaboration/invite-team-members.md +++ b/src/pages/docs/collaboration/invite-team-members.md @@ -1,6 +1,6 @@ --- -title: "Adding Team Members to a Project" -metadesc: "How to add team members to a Project in Testsigma." +title: "Inviting Team Members to a Project" +metadesc: "In Testsigma, you can add team members to your project & assign them different roles | Learn how to add team members to a Project in Testsigma." noindex: false order: 3.0 page_id: "Adding Team Members to a Project" @@ -9,87 +9,51 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Pre-requisites" - url: "#pre-requisites" + name: "Prerequisites" + url: "#prerequisites" - type: link - name: "Adding a team member to one project from the project’s settings" - url: "#adding-a-team-member-to-one-project-from-the-projects-settings" -- type: link - name: "Invite a team member to multiple projects from the global settings" - url: "#invite-a-team-member-to-multiple-projects-from-the-global-settings" + name: "Steps to Invite Team Members" + url: "#steps-to-invite-team-members" --- --- -You can add unlimited team members to your project and assign them different roles and accesses. There are two ways to do so: - -1. To one project from the project’s settings. - -2. To multiple projects from global settings. - -  - ---- -## **Pre-requisites** -1. You need a project in which you want to invite your team members. If you don’t have a project, click [here](https://testsigma.com/docs/projects/overview/) to know how to create a project. -2. You should either have the role of super administrator or test manager and should be assigned to the project. +You can add unlimited team members to your project and assign them different roles and accesses. This article discusses how to add team members to your project in Testsigma. -  --- -## **Adding a team member to one project from the project’s settings:** -1. Login to your account on Testsigma -2. Select the project you need to add your team members to. +## **Prerequisites** -3. Go to **Project Settings** > **Project Members**. -![Project members page in Testsigma](https://docs.testsigma.com/images/invite-team-members/project-members-testsigma.png) +- You should know how to create a [project](https://testsigma.com/docs/projects/overview/). + -4. On the **Project Members** Page, click on **Invite** button on the top right corner +- To add a user to a project, you should have the role of either test manager or admin. *For more information, see [user roles](https://testsigma.com/docs/collaboration/users-roles/).* -5. On the **Add New Member to Project** form that opens, fill in the required details and click on **invite**. - -![Add New Member to Project Form in Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_addingnewmember.png) - -6. The invitee will get the invite email on the specified email address. Once they click on the link sent in the email, they should be able to join the project on Testsigma. - -  --- -## **Invite a team member to multiple projects from the global settings:** -1. Go to **Settings** > **Users**, you should see a page like this: - -![Users page in Testsigma](https://docs.testsigma.com/images/invite-team-members/users-page-testsigma.png) - -2. Add a new user, click on the **New User** button on the top right. - -3. A form should appear like the one shown below: - -![create new user form in Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_createnewuser.png) - -From here, you can fill up the required fields, select if you want to make the user a **Super Administrator**. And then, select the projects to be assigned and the corresponding access role. - -4. Once all the required fields are filled, click on **Invite**. - -5. The user will be sent an email with the link to join the required project(s). - - - - - - +## **Steps to Invite Team Members** +1. Navigate to **Project > Project Settings**, click on **Project Members**. +![Project Members](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/urmpmem.png) +2. Click on **Invite**. +![Invite](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/urminvite.png) +3. On **Invite new member** prompt, enter **Email** and select the **Role** you want to assign. +![Email & Role](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpnewmemeber.png) +4. The invited user should receive an invitation email. +Alternatively, you can also add users from global **Settings**. Learn how to assign projects from [here](https://testsigma.com/docs/collaboration/assign-projects/). +--- \ No newline at end of file diff --git a/src/pages/docs/collaboration/manage-execution-stops.md b/src/pages/docs/collaboration/manage-execution-stops.md index 09ff0d35..9f73b072 100644 --- a/src/pages/docs/collaboration/manage-execution-stops.md +++ b/src/pages/docs/collaboration/manage-execution-stops.md @@ -1,5 +1,5 @@ --- -title: "Control Who Can Stop Execution via Usage Details and Run Results" +title: "Execution Controls (Stopping Test Execution)" page_title: "Control Stopping Executions in Testsigma: Prevent Accidental Stops" metadesc: "Learn how to control stopping executions in Testsigma and prevent accidental stops. Admins have the highest control, while user accounts need to contact the admin." noindex: false @@ -10,44 +10,62 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Enabling Control Who Can Stop Executions" - url: "#enabling-control-who-can-stop-executions" + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Enabling Stop Executions Preference" + url: "#enabling-stop-executions-preference" - type: link name: "Understanding Execution Stopping Permissions" url: "#understanding-execution-stopping-permissions" --- + --- -Super Admins control the stopping of executions by users in **Usage Details** and **Run Results** via the **Control Who Can Stop Executions** feature. This prevents accidental stopping of executions and avoids disruptions in testing. Users cannot access the Stop button and must contact Super Admins to halt execution. This documentation explains how to enable and configure this feature. + +Super Admins control the stopping of executions by users in **Usage Details** and **Run Results** via the **Control Who Can Stop Executions** feature. This prevents accidental stopping of executions and avoids disruptions in testing. Users cannot access the **Stop** button and must contact **Super Admins** to halt execution. This documentation explains how to enable and configure this feature. --- -### **Prerequisites** -Before you enable the Control Who Can Stop Execution feature, you should understand the concept of [Users & Role Management](https://testsigma.com/docs/collaboration/users-roles/). +## **Prerequisites** + + +- You should know about [users & role management](https://testsigma.com/docs/collaboration/users-roles/). + --- -## **Enabling Control Who Can Stop Executions** +## **Enabling Stop Executions Preference** 1. Navigate to **Settings** > **Preferences**. -2. Enable the toggle switch for the **Control Who Can Stop Executions** feature flag, which will be toggled off by default. ![Enable Toggle Control Who Can Stop Executions](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/enable_whocanstop_sa_te.gif) +![Preferences](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/secspref.png) + +2. Enable the toggle switch for the **Control Who Can Stop Executions** feature flag, which will be toggled off by default. +![Enable](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/secprefer.png) + [[info | NOTE:]] -| If you cannot see the option to enable this feature, contact [Testsigma Support](mailto:support@testsigma.com) or use the Instant **Chat** option and request that they enable it for your account. +| If you cannot see the option to enable this feature, contact **support@testsigma.com** or use the instant **Chat** option and request that they enable it for your account. + --- + ## **Understanding Execution Stopping Permissions** 1. Once you enable the feature, the following permissions will be in effect: + - **Account Administrators** and **Super Administrators**, who can stop executions via the Usage Details or Run Results sections, hold the highest control. + - All executions can be viewed by **Test Managers**, **Test Leads**, and **Automation Engineers**, and they can only stop the executions or user sessions initiated by themselves. -2. Users cannot click the **Stop** button to halt the execution. If an user needs to stop the execution and has not initiated it, they must contact the super admin. ![Stop hidden for users](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/enable_whocanstop_runres.gif) + +2. Users cannot click the **Stop** to halt the execution. If a user needs to stop the execution without initiating it, they must contact the Super Admin. + [[info | NOTE:]] -| Super Admins have absolute control and can stop any execution, irrespective of the user. +| **Super Admins** have absolute control and can stop any execution, irrespective of the user. --- diff --git a/src/pages/docs/collaboration/users-roles.md b/src/pages/docs/collaboration/users-roles.md index 223651ff..e33906b8 100644 --- a/src/pages/docs/collaboration/users-roles.md +++ b/src/pages/docs/collaboration/users-roles.md @@ -2,7 +2,7 @@ title: "Users & Role Management" metadesc: "How to manage users and roles in Testsigma." noindex: false -order: 3.1 +order: 3.2 page_id: "Users & Role Management" warning: false contextual_links: @@ -15,8 +15,11 @@ contextual_links: name: "Edit Users to Assign New Roles" url: "#edit-users-to-assign-new-roles" - type: link - name: "Assign Roles to Users" - url: "#assign-roles-to-users" + name: "Assign Roles to Users From Project Settings" + url: "#assign-roles-to-users-from-project-settings" +- type: link + name: "Deleting Users From a Project" + url: "#deleting-users-from-a-project" --- --- @@ -57,20 +60,51 @@ Below are the four roles that can be assigned to a project member in Testsigma: --- -## **Assign Roles to Users** -1. Navigate to **Project > Project Settings**, click on **Project members**. +## **Assign Roles to Users from Project Settings** + +1. Navigate to **Project > Project Settings**, click on **Project Members**. ![Project Members](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/urmpmem.png) + 2. Click on **Invite**. ![Invite](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/urminvite.png) -3. On **Add New Member to Project** prompt, enter **Email** and select the **Role** you want to assign. + +3. On **Invite new member** prompt, enter **Email** and select the **Role** you want to assign. ![Email & Role](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/urmear.png) 4. Click on **Update**. ![New User](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/urmud.png) + [[info | **NOTE**:]] | You can only add users as **Test Manager**, **Test Lead**, and **Automation Engineer/Developer**. To assign **Super Admin** roles, refer to [Assign Projects](https://testsigma.com/docs/collaboration/assign-projects/). The invited user should receive an invitation email. They will need to join via the link sent in the email. Once they have joined they should be able to work on the project according to the role assigned to them. + + + +--- + +## **Deleting Users From a Project** + + +If you're the super administrator of the project, you can delete users. + +1. Navigate to **Project > Project Settings**, click on **Project Members**. +![Project Members](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpmemm.png) + + +2. Hover over the user you want to delete and click on **Delete**. +![Delete](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpcodelete.png) + + +3. On **Delete member**, enter **DELETE** and click on **Delete**. +![Delete](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/autpdlprompt.png) + + +Alternatively, you can also delete user from global settings by navigating to **Settings > Users**. + + + +--- diff --git a/src/pages/docs/getting-started/faqs.md b/src/pages/docs/getting-started/faqs.md index e6d69dd0..6f3101f6 100644 --- a/src/pages/docs/getting-started/faqs.md +++ b/src/pages/docs/getting-started/faqs.md @@ -1,5 +1,5 @@ --- -title: "FAQs" +title: "Frequently Asked Questions" page_title: "Testsigma FAQs" metadesc: "Frequently Asked Questions about Testsigma" noindex: false @@ -36,56 +36,52 @@ contextual_links: --- --- -##**What kind of apps can I test with Testsigma?** -You can use Testsigma to automate testing for web applications, native Android and iOS applications and APIs. You don’t need additional plugins, frameworks or integrations are necessary for any of these types of apps/use-cases. -  +## **What kind of apps can I test with Testsigma?** ---- -##**Does Testsigma support testing apps written with any programming language?** -Yes. Since test scripts are written using simple English, you can test web apps, mobile apps and APIs regardless of the programming language, frameworks or tools used to build them. - -  +You can use Testsigma to automate testing for web applications, native Android and iOS applications, and APIs. You don't need additional plugins, frameworks, or integrations are necessary for any of these types of apps/use-cases. --- -##**How is Testsigma different from other automation tools?** -Testsigma is a first of its kind open-source platform. Most tools & frameworks only support certain use cases and require pairing with other tools to work for your scenarios. Testsigma is a unified test automation ecosystem that enables you to build and scale automation for the complete QA lifecycle, end-to-end. - -  ---- -##**Can I build utilities, extend the platform and integrate with other tools?** -You can use & extend Testsigma however you like! Testsigma integrates with all popular CI/CD, project management & bug reporting tools seamlessly in addition to also supporting custom integrations. +## **Does Testsigma support testing apps written with any programming language?** -  +Yes. Since test scripts are written using simple English, you can test web apps, mobile apps, and APIs regardless of the programming language, frameworks, or tools used to build them. --- -##**Can I create custom add-ons in Testsigma?** -Yes, you can build your own [custom add-ons](https://testsigma.com/docs/addons/what-is-an-addon/) for all your use cases on top of Testsigma with minimum effort. You can also select from a comprehensive list of existing add-ons from our community-powered marketplace. -  +## **How is Testsigma different from other automation tools?** + +Testsigma is a first-of-its-kind open-source platform. Most tools & frameworks only support certain use cases and require pairing with other tools to work for your scenarios. Testsigma is a unified test automation ecosystem that enables you to build and scale automation for the complete QA lifecycle, end-to-end. --- -##**Does Testsigma integrate with Jira and Jenkins?** -Testsigma supports [integrations](https://testsigma.com/docs/desired-capabilities/add-chrome-extension/) with JIRA, Jenkins, CircleCI, Bugzilla, Trello, Browserstack & Slack among other popular tools. You can find the full list of supported integrations [here.](https://testsigma.com/docs/desired-capabilities/add-chrome-extension/) -  +## **Can I build utilities, extend the platform and integrate with other tools?** + +You can use & extend Testsigma however you like! Testsigma integrates seamlessly with all popular CI/CD, project management & bug reporting tools and supports custom integrations. --- -##**What’s the difference between Testsigma open-source and Cloud?** -The open-source platform is deployed on your local workstation or private server and contains all the core capabilities required to build your test automation system. -The [cloud platform](https://testsigma.com/signup) is a fully managed end-to-end solution with enterprise level features from an extensive Test Lab to enhance security and much more. [You can learn more about it here](https://testsigma.com/docs/getting-started/testsigma-community-cloud/) -  +## **Can I create custom add-ons in Testsigma?** + +Yes, you can build [custom add-ons](https://testsigma.com/docs/addons/what-is-an-addon/) for all your use cases on top of Testsigma with minimum effort. You can also select from a comprehensive list of existing add-ons from our community-powered marketplace. --- -##**What if I can’t find a feature for my use case?** -The Testsigma marketplace contains an extensive list of add-ons you can search through for specific use cases that aren’t built into the core platform but can be added to it on an as-needed basis. You can also request for assistance from our community or log a feature request on our support portal. +## **Does Testsigma integrate with Jira and Jenkins?** + +Testsigma supports [integrations](https://testsigma.com/docs/desired-capabilities/add-chrome-extension/) with JIRA, Jenkins, CircleCI, Bugzilla, Trello, Browserstack & Slack, among other popular tools. You can find the full list of supported integrations [here.](https://testsigma.com/docs/desired-capabilities/add-chrome-extension/) +--- +## **What’s the difference between Testsigma open-source and Cloud?** +The open-source platform is deployed on your local workstation or private server and contains all the core capabilities required to build your test automation system. +The [cloud platform](https://testsigma.com/signup) is a fully managed end-to-end solution with enterprise-level features from an extensive Test Lab to enhance security. [You can learn more about it here.](https://testsigma.com/docs/getting-started/testsigma-community-cloud/) +--- +## **What if I can’t find a feature for my use case?** +The Testsigma marketplace contains an extensive list of add-ons you can search through for specific use cases that aren't built into the core platform but can be added as needed. You can also request assistance from our community or log a feature request on our support portal. +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/introduction-cloud.md b/src/pages/docs/getting-started/introduction-cloud.md index 4fdebc8f..beda0cc6 100644 --- a/src/pages/docs/getting-started/introduction-cloud.md +++ b/src/pages/docs/getting-started/introduction-cloud.md @@ -30,36 +30,44 @@ contextual_links: --- --- - Testsigma Cloud is a fully-managed test automation platform that includes all the core features of the open-source platform, without any infra-requirements. It also offers enhanced security, extensive test lab, project and review management, powerful reporting capabilities, and [much more.](https://testsigma.com/products) + +Testsigma Cloud is a fully managed test automation platform that includes all the core features of the open-source platform without any infra-requirements. It also offers enhanced security, extensive test lab, project and review management, powerful reporting capabilities, and [much more.](https://testsigma.com/products) +
  + --- + ## **Setup Testsigma** -The easiest way to get started is by[ signing up for an account on our cloud-hosted version. ](https://testsigma.com/signup) + +The easiest way to get started is by[ signing up for an account on our cloud-hosted version](https://testsigma.com/signup). --- -## **Getting started** - * [Tutorials](https://testsigma.com/tutorials/getting-started/automate-web-applications/) - * [Core Concepts](https://testsigma.com/docs/test-cases/overview/) - * [CI/CD Integrations](https://testsigma.com/docs/continuous-integration/jenkins/) - * [Creating Add-ons](https://testsigma.com/docs/addons/what-is-an-addon/) + +## **Getting Started** + +- [Tutorials](https://testsigma.com/tutorials/getting-started/automate-web-applications/) +- [Core Concepts](https://testsigma.com/docs/test-cases/overview/) +- [CI/CD Integrations](https://testsigma.com/docs/continuous-integration/jenkins/) +- [Creating Add-ons](https://testsigma.com/docs/addons/what-is-an-addon/) --- -##**Getting help** - * Learn how to use, build, and extend the platform. Visit [documentation.](https://testsigma.com/docs/) - * Connect with product experts on the team and in the Community on our [Discord.](https://discord.com/invite/5caWS7R6QX) +## **Getting Help** - * Troubleshooting problems? Report bugs as [Github issues.](https://github.com/testsigmahq/testsigma/issues/) +- Learn how to use, build, and extend the platform. Visit [documentation.](https://testsigma.com/docs/) - * Refer to our [FAQ](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. +- Connect with product experts on the team and in the Community on our [Discord.](https://discord.com/invite/5caWS7R6QX) - * Reach out to us at **[support@testsigma.com](mailto:support@testsigma.com)** +- Troubleshooting problems? Report bugs as [Github issues.](https://github.com/testsigmahq/testsigma/issues/) +- Refer to our [FAQ](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. +- Reach out to us at **[support@testsigma.com](mailto:support@testsigma.com)** +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/introduction-community.md b/src/pages/docs/getting-started/introduction-community.md index c3d7cf14..b9aeb5d3 100644 --- a/src/pages/docs/getting-started/introduction-community.md +++ b/src/pages/docs/getting-started/introduction-community.md @@ -24,28 +24,32 @@ contextual_links: --- --- -Testsigma Community Edition is an open-source end-to-end test automation platform. It packages libraries, APIs, classes, and more that you can install on your workstation and use to start test automation, without building a test framework from scratch. + + +Testsigma Community Edition is an open-source end-to-end test automation platform. It packages libraries, APIs, classes, and more that you can install on your workstation and use to start test automation without building a test framework from scratch. --- -##**Setup Testsigma Community Edition** + +## **Setup Testsigma Community Edition** [Deploy Testsigma on my workstation](https://testsigma.com/docs/getting-started/setup/overview/) --- -##**Getting help** -* Learn how to use, build, and extend the platform. Visit [documentation](https://testsigma.com/docs/). -* Connect with product experts on the team and in the Community on our [Discord](https://discord.com/invite/5caWS7R6QX). -* Troubleshooting problems? Report bugs as [Github issues](https://github.com/testsigmahq/testsigma/issues). -* Refer to our [FAQ ](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. -* Reach out to us at [support@testsigma.com](mailto:support@testsigma.com). +## **Getting help** +- Learn how to use, build, and extend the platform. Visit [documentation](https://testsigma.com/docs/). +- Connect with product experts on the team and in the Community on our [Discord](https://discord.com/invite/5caWS7R6QX). +- Troubleshooting problems? Report bugs as [Github issues](https://github.com/testsigmahq/testsigma/issues). +- Refer to our [FAQs](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. +- Reach out to us at [support@testsigma.com](mailto:support@testsigma.com). ---- -##**Telemetry Opt-In** -As a standard practice, we collect anonymous telemetry data during and after Testsigma is installed on your local machine. You can learn more about Telemetry data and opt-in [here](https://testsigma.com/docs/getting-started/telemetry/). +--- +## **Telemetry Opt-In** +As a standard practice, we collect anonymous telemetry data during and after Testsigma is installed on your local machine. You can learn more about Telemetry data and opt-in [here](https://testsigma.com/docs/getting-started/telemetry/). +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/setup/docker.md b/src/pages/docs/getting-started/setup/docker.md index a67868cd..698ff4e8 100644 --- a/src/pages/docs/getting-started/setup/docker.md +++ b/src/pages/docs/getting-started/setup/docker.md @@ -10,8 +10,8 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Pre-requisites" - url: "#pre-requisitesbr" + name: "Prerequisites" + url: "#prerequisites" - type: link name: "Setting up Testsigma Community Edition with Docker" url: "#setting-up-testsigma-community-edition-with-docker" @@ -40,30 +40,32 @@ contextual_links: This guide will help you setup [Testsigma Server](https://github.com/testsigmahq/testsigma) and MySQL as Docker containers using Docker Compose. This is the easiest way to set up Testsigma on your local machines. --- -##**Pre-requisites**
+ +## **Prerequisites** * [Docker](https://docs.docker.com/install/) * [Docker Compose](https://docs.docker.com/compose/install/) --- -##**Setting up Testsigma Community Edition with Docker** -Create a folder called “testsigma” where you would like to install Testsigma and store the logs and runtime data. +## **Setting up Testsigma Community Edition with Docker** + +Create a folder called **testsigma** where you would like to install Testsigma and store the logs and runtime data. **cd** cmd into this installation folder (testsigma) --- -## **Step1: Download docker-compose.yml file** +## **Step 1: Download docker-compose.yml file** Download docker-compose.yml file into the testsigma installation folder from [here](https://github.com/testsigmahq/testsigma/tree/dev/deploy/docker). Download the appropriate file based on your OS. [[info | NOTE:]] -|- If you are using Apple M1 machines then you should replace the testsigmahq/server image version in docker-compose.yml with the M1 docker image tag. For example if the version is v1.0.0 then you should add "-m1" and make it v1.0.0-m1. So the final image name looks like this "testsigmahq/server:v1.0.0-m1" +| - If you are using Apple M1 machines then you should replace the testsigmahq/server image version in docker-compose.yml with the M1 docker image tag. For example if the version is v1.0.0 then you should add "-m1" and make it v1.0.0-m1. So the final image name looks like this "testsigmahq/server:v1.0.0-m1" --- -## **Step2: Run Testsigma Server** +## **Step 2: Run Testsigma Server** The following command will run Testsigma along with a MySQL database to store data. @@ -88,14 +90,16 @@ You should see a message: “Testsigma is Running!” once the container is read Your Testsigma server should be up and running now. Testsigma server will be accessible at https://local.testsigmaos.com/ui --- -##**Verifying the installation** - By default folders db\_data, ts\_data will be created in the installation folder to store the application data and MySQL data. If you want to change this folder path you can open **docker-compose.yml** and change the db\_data volume path under mysql service and ts\_data path under testsigma_server. +## **Verifying the installation** + +By default folders db\_data, ts\_data will be created in the installation folder to store the application data and MySQL data. If you want to change this folder path you can open **docker-compose.yml** and change the db\_data volume path under mysql service and ts\_data path under testsigma_server. --- + ## **Connecting to External MySQL** - If you want to connect to an external/existing MySQL database, add the below environment variables +If you want to connect to an external/existing MySQL database, add the below environment variables MYSQL\_HOST\_NAME = < mysql \_host\_name> where mysql\_host\_name is your database url
MYSQL\_PORT = < port\_number> where mysql is running
@@ -105,7 +109,7 @@ MYSQL\_PASSWORD = < password>
--- -## **Step3: Install and configure Testsigma Agent** +## **Step 3: Install and configure Testsigma Agent** When we run the Testsigma server using Docker it runs in a separate container(child process), where it cannot access the applications installed in the host machine. But in order to automate Web and Mobile Apps the Testsigma Server (running in docker) has to access Browsers and Mobile Devices connected to the host machine. @@ -117,7 +121,7 @@ Login to https://local.testsigmaos.com/ui and follow the steps mentioned here([S --- -##**Update to new Version(Testsigma Server)** +## **Update to new Version(Testsigma Server)** 1. Stop the Docker images/container with name testsigma in Docker Desktop, alternatively you can use the below commands to kill the processes
 a. `sudo su`
@@ -132,7 +136,7 @@ Login to https://local.testsigmaos.com/ui and follow the steps mentioned here([S --- -##**Update to new Version(Testsigma Agent)** +## **Update to new Version(Testsigma Agent)** 1. Stop the running agent by executing the stop.sh 2. Delete the TestsigmaAgent folder @@ -145,13 +149,15 @@ Login to https://local.testsigmaos.com/ui and follow the steps mentioned here([S |- If you are still facing the issue, delete the [agent manually](https://testsigma.com/docs/agent/force-delete/) and install again. --- -##**Troubleshooting** + +## **Troubleshooting** - If you encounter any errors during this process, check out our guide on [debugging deployment errors](https://testsigma.com/docs/troubleshooting/setup/server-docker-deployment-errors/) and for [logs](https://testsigma.com/docs/troubleshooting/setup/server-docker-deployment-errors/#checking-logs) - If you are still facing any issue, please reach out to [support@testsigma.com](mailto:support@testsigma.com) or join our [Discord Server](https://discord.com/invite/5caWS7R6QX) to speak to the Testsigma team directly! --- -##**Next Steps** + +## **Next Steps** 1. [Get Started with Automating Web Applications](https://testsigma.com/tutorials/getting-started/automate-web-applications/) 2. [Get Started with Automating Mobile Web Applications](https://testsigma.com/tutorials/getting-started/automate-mobile-web-applications/) @@ -160,3 +166,4 @@ Login to https://local.testsigmaos.com/ui and follow the steps mentioned here([S 5. [How to automate tests for Android Apps using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-android-devices/) 6. [How to automate tests for iOS Apps using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-ios-devices/) +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/setup/downloadable-package.md b/src/pages/docs/getting-started/setup/downloadable-package.md index 240d920a..05cf7e08 100644 --- a/src/pages/docs/getting-started/setup/downloadable-package.md +++ b/src/pages/docs/getting-started/setup/downloadable-package.md @@ -10,14 +10,14 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Pre-requisites" - url: "#pre-requisites" + name: "Prerequisites" + url: "#prerequisites" - type: link - name: "Step1: Download the Package" - url: "#step1-download-the-package" + name: "Step 1: Download the Package" + url: "#step-1-download-the-package" - type: link - name: "Step2: Run Services" - url: "#step2-run-services" + name: "Step 2: Run Services" + url: "#step-2-run-services" - type: link name: "Update to new Version" url: "#update-to-new-version" @@ -31,14 +31,16 @@ contextual_links: --- -##**Pre-requisites** + +## **Prerequisites** Create a folder called testsigma where you would like to install Testsigma. **cd** cmd into this installation folder(testsigma) --- -##**Step1: Download the Package** + +## **Step 1: Download the Package** Download the Testsigma zip into the installation folder(testsigma) from https://github.com/testsigmahq/testsigma/releases/latest/ @@ -58,9 +60,9 @@ We need 4 components for the Testsigma community server to work: --- -###MySQL +### MySQL -####**Install MySQL** +#### **Install MySQL** 1. Download and install MySQL from https://dev.mysql.com/downloads/mysql/ @@ -78,12 +80,13 @@ You can also connect with an external/existing MYSQL server instance. Set the fo --- -###Nginx +### Nginx Since we have UI components and API server separately we need a single application to route the requests between them. Nginx is the one that facilitates this. Nginx listens to 443 ports for HTTPS connections and forwards them to the API server, so make sure this port is not occupied by another service. --- -###Testsigma Server + +### Testsigma Server Testsigma follows API first approach, all APIs are served from this service. This service contains all APIs and business logic to support the Testsigma UI and all other backend processes. Testsigma Server is a Spring Boot application that runs on port 9090 by default. Make sure that 9090 is free. If you want to change the port follow the steps below.
@@ -93,7 +96,8 @@ Testsigma follows API first approach, all APIs are served from this service. Thi - Before starting the Testsigma agent, set the environment variable LOCAL\_SERVER\_URL to http://localhost: here you can replace with the port you would like to use.
--- -###Testsigma Agent + +### Testsigma Agent Testsigma Agent is a microservice that processes test case data and runs tests on browsers and mobile devices. The Testsigma agent runs on ports 9393 (HTTP) and 9494 (HTTPS) by default. If you want to change these ports, follow the steps below:
- Before changing the ports, stop Nginx, Testsigma Server, and Testsigma Agent.
@@ -101,20 +105,20 @@ Testsigma Agent is a microservice that processes test case data and runs tests o - Before starting the Testsigma agent you need to set the environment variables TESTSIGMA\_AGENT\_HTTP\_PORT for HTTP port and TESTSIGMA\_AGENT\_HTTPS\_PORT for HTTPS port.
--- -##**Step2: Run Services** -###Windows -####Starting Nginx - - Open a command prompt
- - Navigate to the extracted folder
+## **Step 2: Run Services** +### Windows +#### **Starting Nginx:** +- Open a command prompt
+- Navigate to the extracted folder
- Run start\_nginx.bat to start Nginx
- If you want to stop nginx at any point in time then, run the start\_nginx.bat script
-####**Starting API Server:**
+#### **Starting API Server:**
- Open a command prompt
- Navigate to the extracted folder
- Navigate to the TestsigmaServer folder
- Run start.bat file to start the Testsigma API server
-- You can run stop.bat if you want to stop the API server at any point in time
+- You can run **stop.bat** if you want to stop the API server at any point in time
#### **Starting Local Agent:**
- Open a command prompt
@@ -137,7 +141,7 @@ Testsigma Agent is a microservice that processes test case data and runs tests o - Navigate to the extracted folder
- Navigate to the TestsigmaServer folder
- Run start.sh file to start the Testsigma API server
-- You can run stop.sh if you want to stop the API server at any point in time
+- You can run **stop.sh** if you want to stop the API server at any point in time
#### **Starting Local Agent:**
@@ -148,12 +152,14 @@ Testsigma Agent is a microservice that processes test case data and runs tests o - You can run stop.sh if you want to stop the agent at any point in time
--- -##**Verifying the installation** + +## **Verifying the installation** Your Testsigma server should be up and running now. Testsigma server will be accessible at https://local.testsigmaos.com/ui --- -##**Update to new Version** + +## **Update to new Version** 1. Stop Nginx, TestsigmaServer, TestsigmaAgent 2. Delete the Testsigma Installation folder @@ -162,12 +168,14 @@ Your Testsigma server should be up and running now. Testsigma server will be acc 5. Now login to check the updated version of Testsigma Server here https://local.testsigmaos.com/ui --- -##**Troubleshooting** + +## **Troubleshooting** If you encounter any errors during this process, check out our guide on [debugging deployment errors](https://testsigma.com/docs/troubleshooting/setup/server-docker-deployment-errors/). If you are still facing any issue, please reach out to [support@testsigma.com](mailto:support@testsigma.com) or join our [Discord Server](https://discord.com/invite/5caWS7R6QX) to speak to the Testsigma team directly! --- -##**Next Steps** + +## **Next Steps** 1. [Get Started with Automating Web Applications](https://testsigma.com/tutorials/getting-started/automate-web-applications/) 2. [Get Started with Automating Mobile Web Applications](https://testsigma.com/tutorials/getting-started/automate-mobile-web-applications/) @@ -175,3 +183,6 @@ Your Testsigma server should be up and running now. Testsigma server will be acc 4. [Get Started with Automating iOS Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/) 5. [How to automate tests for Android Apps using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-android-devices/) 6. [How to automate tests for iOS Apps using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-ios-devices/) + + +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/setup/overview.md b/src/pages/docs/getting-started/setup/overview.md index 73cf3ed2..bb966102 100644 --- a/src/pages/docs/getting-started/setup/overview.md +++ b/src/pages/docs/getting-started/setup/overview.md @@ -23,9 +23,9 @@ contextual_links: --- -##**Using Testsigma Cloud** +## **Using Testsigma Cloud** -Recommended as the easiest and fastest way to kickstart your automation journey +This is recommended as the easiest and fastest way to kickstart your automation journey. Comes with a fully managed test lab, enhanced security and robust features that bring additional stability & maintainability to your testing environments. @@ -33,7 +33,8 @@ Comes with a fully managed test lab, enhanced security and robust features that --- -##**Deploy on your Local Servers** + +## **Deploy on your Local Servers** Testsigma Community Edition (CE) is an open-source platform that you can install on your local machine or private server instance using the following options: @@ -42,12 +43,14 @@ Testsigma Community Edition (CE) is an open-source platform that you can install --- -##**Getting help** -If you face any problems or issues when installing Testsigma on any platform, reach out to us at support@testsigma.com or join our [Discord Server](https://discord.com/invite/5caWS7R6QX). +## **Getting help** + +If you face any problems or issues when installing Testsigma on any platform, reach out to us at support@testsigma.com or join our [discord derver](https://discord.com/invite/5caWS7R6QX). * Learn how to use, build, and extend the platform. Visit [documentation](https://testsigma.com/docs/) - * Connect with product experts on the team and in the Community on our [Discord](https://discord.com/invite/5caWS7R6QX). - * Troubleshooting problems? Report bugs as [Github issues](https://github.com/testsigmahq/testsigma/issues). - * Refer to our [FAQ](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. + * Connect with product experts on the team and in the Community on our [discord](https://discord.com/invite/5caWS7R6QX). + * Troubleshooting problems? Report bugs as [github issues](https://github.com/testsigmahq/testsigma/issues). + * Refer to our [FAQs](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/setup/testsigma-cloud.md b/src/pages/docs/getting-started/setup/testsigma-cloud.md index 3e375f5c..0d46c852 100644 --- a/src/pages/docs/getting-started/setup/testsigma-cloud.md +++ b/src/pages/docs/getting-started/setup/testsigma-cloud.md @@ -9,20 +9,11 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Creating an account" - url: "#creating-an-account" + name: "Prerequisites" + url: "#prerequisites" - type: link - name: "Create a new project" - url: "#create-a-new-project" -- type: link - name: "Creating and running a test" - url: "#creating-and-running-a-test" -- type: link - name: "Check your reports" - url: "#check-your-reports" -- type: link - name: "Try running data driven tests" - url: "#try-running-data-driven-tests" + name: "Creating Projects, Tests, and Reports" + url: "#creating-projects-tests-and-reports" - type: link name: "Troubleshooting" url: "#troubleshooting" @@ -30,69 +21,48 @@ contextual_links: name: "Next Steps" url: "#next-steps" --- ---- -This guide walks you through creating an account and using Testsigma Cloud --- -## **Creating an account** -Go to [https://testsigma.com/signup](https://testsigma.com/signup) to create an account. -![Create a new project](https://docs.testsigma.com/images/testsigma-cloud/create-a-new-project.png) +With **Testsigma Cloud**, you can create projects, applications, tests and view results and reports. This article walks you through creating an account and using Testsigma Cloud. --- -## *Create a new project** -* Click on **create a new project** and fill in the name and description -* Select the number of applications to be included. You can turn on versioning if you need it -* Select the type of application you’d like to test from - Web, Mobile-Web, Android, iOS or API -* And that’s it! You’re ready to start testing ---- -## **Creating and running a test** -### Step 1: Create test case +## **Prerequisites** -![Create test case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/getting-started/setup/testsigma-cloud/create-test-case.png) +- You should have a Testsigma account. Go to [Testsigma signup](https://testsigma.com/signup) page to create an account. + ![Signup Page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tssupage.png) -* In the left nav click on **Test Development** and click on **Test cases**. Fill in the required fields. Next, if you want to write NLP test steps for the test case, click on "Write Tests", or else, if you want to record the test steps then click on "Record Test" +--- -### Step 2: Add Test Steps +## **Creating Projects, Tests, and Reports** -[Check out this tutorial](https://testsigma.com/docs/test-cases/step-types/natural-language/) to learn how to create & add test steps +- To create and manage projects, refer to [projects](https://testsigma.com/docs/projects/overview/). +- To create and manage test cases, refer to [manage test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). +- To add test steps, refer to [create test steps](https://testsigma.com/docs/test-cases/create-steps/). +- To run tests, refer to [test runs](https://testsigma.com/docs/runs/adhoc-runs/). +- To view results & debug errors, refer to [view reports and debug errors](https://docs.testsigma.com/images/testsigma-cloud/view-results-and-debug-errors.png) -### Step 3: Run your test -![Run your test](https://docs.testsigma.com/images/testsigma-cloud/run-your-test.png) +--- -* Once you’ve created your test steps, click on the **Run** button -* You can choose from several browser/OS version combinations as well as devices if you’re testing your mobile app -* You can also run your tests locally through the [agent](https://testsigma.com/docs/runs/dry-runs-on-local-devices/) +## **Troubleshooting** -### Step 4: View results & debug errors -![View results and debug errors](https://docs.testsigma.com/images/testsigma-cloud/view-results-and-debug-errors.png) +- Connect with product experts on the team and in the Community on our [Discord](https://discord.com/invite/5caWS7R6QX/) -* After you run your test you’ll automatically see the results show up in real time on your screen -* You can check step wise execution times and other details -* Review your results with screenshots, recorded video or using logs +- Troubleshooting problems? Report bugs as [Github issues](https://github.com/testsigmahq/testsigma/discussions) -[Click here](https://testsigma.com/docs/runs/adhoc-runs/) to learn more about Ad-Hoc runs +- Reach out to us at [support@testsigma.com](mailto:support@testsigma.com) ---- -## **Check your reports** -You can go to the run results section located in the test development tab to take a deep dive into detailed reports of your executions and use various filters to get different insights +- Refer to our [FAQ](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. --- -## **Try running data driven tests** -Testsigma’s integrated test data profiles let you easily create or upload data sets to be used in your test cases. ---- -## **Troubleshooting** +## **Next Steps** -* Connect with product experts on the team and in the Community on our [Discord](https://discord.com/invite/5caWS7R6QX/) -* Troubleshooting problems? Report bugs as [Github issues](https://github.com/testsigmahq/testsigma/discussions) -* Reach out to us at [support@testsigma.com](mailto:support@testsigma.com) -* Refer to our [FAQ](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions. +- [Take the complete course](https://testsigma.com/tutorials/): Learn how to use Testsigma end-to-end, using our tutorials. ---- -## **Next Steps** +- [Create your own add-ons](https://testsigma.com/docs/addons/what-is-an-addon/): Cover more test scenarios by creating add ons in Testsigma. + +- [Integrate with your CI/CD pipeline](https://testsigma.com/docs/continuous-integration/jenkins/): Enable continuous testing by integrating with your CI/CD tools. -* [Take the complete course](https://testsigma.com/tutorials/): Learn how to use Testsigma end-to-end, using our tutorials -* [Create your own add-ons](https://testsigma.com/docs/addons/what-is-an-addon/): Cover more test scenarios by creating add ons in Testsigma -* [Integrate with your CI/CD pipeline](https://testsigma.com/docs/continuous-integration/jenkins/): Enable continuous testing by integrating with your CI/CD tools. \ No newline at end of file +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/telemetry.md b/src/pages/docs/getting-started/telemetry.md index 884df7d9..10ec78c0 100644 --- a/src/pages/docs/getting-started/telemetry.md +++ b/src/pages/docs/getting-started/telemetry.md @@ -18,25 +18,24 @@ contextual_links: --- -As a standard practice, we collect anonymous telemetry data during and after Testsigma CE is installed on your local machine. The data is statistical in nature and cannot be used to uniquely identify a user. +As a standard practice, we collect anonymous telemetry data during and after Testsigma CE is installed on your local machine. The data is statistical and cannot be used to identify a user uniquely. We collect this data to understand how Testsigma CE is being used and what steps we can take to improve and enhance the experience. This data is not shared with 3rd parties. Access to this data is strictly limited to the Testsigma team. -As a user you can choose to opt-out of Telemetry data any time by navigating to Testsigma CE portal admin settings and then navigating to Telemetry section . - +As a user, you can opt out of Telemetry data anytime by navigating to Testsigma CE portal admin settings and then to the Telemetry section. -**Note:** + -- The data collected is completely anonymous and cannot interpret, indicate or uniquely identify a user. - -- Testsigma is a proxy and does not capture any data returned by your APIs, databases, or third-party tools. +[[info | **NOTE**:]] +| - The data collected is anonymous and cannot interpret, indicate, or uniquely identify a user. +| - Testsigma is a proxy and does not capture any data returned by your APIs, databases, or third-party tools. +--- - -#### What data is collected? +## **What data is collected?** -#### Testsigma server +### **Testsigma server** The Testsigma server sends a ping when it first starts and updates every 12 hours as an ‘is-alive’ status and the last server up-time. The TS server also captures anonymous usage data around plugins and integrations but no data is ever captured from the source. @@ -156,12 +155,16 @@ UploadStatRequest: "eventType": "CREATE" } -#### Disable Telemetry +--- + +## **Disable Telemetry** -To disable telemetry data capture you can do so using the following steps: +To turn off telemetry data capture, you can do so using the following steps: - 1. Navigate to Testsigma app in browser +1. Navigate to Testsigma app in browser. - 3. Click Settings icon which is on left navigation bar +2. Click **Settings** icon, which is on left navigation bar. - 4. Check Disable Telemetry option +3. Check the **Disable Telemetry** option. + +--- diff --git a/src/pages/docs/getting-started/terminology.md b/src/pages/docs/getting-started/terminology.md index 0df9c791..60c74c8a 100644 --- a/src/pages/docs/getting-started/terminology.md +++ b/src/pages/docs/getting-started/terminology.md @@ -27,8 +27,8 @@ contextual_links: name: "Elements Repository" url: "#elements-repository" - type: link - name: "Testsigma Test Step Recorder" - url: "#testsigma-test-step-recorder" + name: "Test Recorder" + url: "#test-recorder" - type: link name: "Testsigma Agent" url: "#testsigma-agent" @@ -51,7 +51,8 @@ contextual_links: --- -##**Natural Language Action** + +## **Natural Language Action** The Natural Language Actions provided by Testsigma consists of most of the actions that a user might need while automating their Tests. @@ -65,87 +66,78 @@ The Natural Language Actions provided by Testsigma consists of most of the actio   --- -##**Test Case** -A test case is a list of steps, or user actions, that you list out in a specific order to automate a test scenario. +## **Test Case** -  +A test case is a list of steps or user actions that you list in a specific order to automate a test scenario. --- -##**Step Group** -Step Groups let you save and reuse a set of test steps. For example, let us assume we are automating a lot of scenarios that each require logging into a website. To do that, we can create a Step Group for the test steps necessary to ‘logging in’. This will let you reuse the Step Group in all those Test Cases that require login, instead of adding the same steps repeatedly in every Test Case that needs ‘Log in’. +## **Step Group** -  +Step Groups let you save and reuse a set of test steps. For example, let us assume we are automating a lot of scenarios that each require logging into a website. We can create a Step Group for the test steps necessary to log in. This will let you reuse the Step Group in all those Test Cases requiring login instead of repeatedly adding the same steps in every Test Case that needs Log in. --- -##**Test Data** -Test Data Profiles are primarily used for Data-Driven Testing. You can create test data in tabular format within Testsigma or import Test Data from Excel files into Testsigma. This can be used for data-driven testing. +## **Test Data** -  +Test Data Profiles are primarily used for Data-Driven Testing. You can create test data in tabular format within Testsigma or import Test Data from Excel files into Testsigma. This can be used for data-driven testing. --- -##**Element** -Elements are links, buttons, input fields, etc. on the Web Page or App Screen, as captured by Testsigma. Elements contain locator details such as XPath or CSS Locator, ID, Name etc. along with details used for organizing the elements such as Screen Names, Element review status, etc. +## **Element** -  +Elements are links, buttons, input fields, etc., on the Web Page or App Screen, as captured by Testsigma. Elements contain locator details such as XPath or CSS Locator, ID, Name, etc., along with details used for organizing the elements such as Screen Names, Element review status, etc. --- -##**Elements Repository** -Element Repository is a shared repository that contains all Elements created in a specific Application Version. All Test Cases within the Application Version can use these elements. +## **Elements Repository** -  +Element Repository is a shared repository that contains all Elements created in a specific Application Version. All Test Cases within the Application Version can use these elements. --- -##**Test Recorder** -Test Recorder lets you capture Elements and actions within Testsigma. We recommend using the Test Step Recorder since it’s quicker, easier, and captures more locator details than manually creating elements would. +## **Test Recorder** -  +Test Recorder lets you capture Elements and actions within Testsigma. We recommend using the Test Step Recorder since it's quicker and easier and captures more locator details than manually creating elements. --- -##**Testsigma Agent** -You can run the tests you create on Testsigma on your local Machines. For running the tests locally, you need a Testsigma Agent utility running on the machine for Test Orchestration (queueing Tests, running the Tests, fetching the Test Results e.t.c). +## **Testsigma Agent** + +You can run the tests you create on Testsigma on your local Machines. For running the tests locally, you need a Testsigma Agent utility running on the machine for Test Orchestration (queueing Tests, running the Tests, fetching the Test Results, etc.). -  --- -##**Custom Fields** -You can create user-defined fields for the entities such as Test Cases, Versions, Applications, Projects, etc for better organization. +## **Custom Fields** -  +You can create user-defined fields for the entities, such as Test Cases, Versions, Applications, Projects, etc, for better organization. --- -##**Uploads** -Mobile Apps or entities used in the Test Case can be uploaded here and accessed within the Test Steps. +## **Uploads** -  +Mobile Apps or entities used in the Test Case can be uploaded here and accessed within the Test Steps. --- -##**Environments** -Environments are a high-level abstraction of Test Environment that allows you to run Test Cases once created on multiple Environments such as QA, UAT, Staging servers without any modifications in the Tests. +## **Environments** -  +Environments are a high-level abstraction of a test environment that allows you to run test cases once created on multiple environments such as QA, UAT, and staging servers without any modifications in the tests. --- -##**Ad-hoc Test Runs** -Ad hoc Test Runs are used to check the correctness of the Test Case created. It executes a single Test Case in isolation and shouldn’t have any Prerequisites outside this Test Case. -The user can do ad-hoc runs for a single Test Case to verify that the Test Case works as expected and later mark it as Ready, add it to a Test Suite etc. +## **Ad-hoc Test Runs** -  ---- -##**Plugins** +Ad hoc Test Runs are used to check the correctness of the Test Case created. It executes a single Test Case in isolation and shouldn't have any Prerequisites outside this Test Case. +The user can do ad-hoc runs for a single Test Case to verify that it works as expected and later mark it as Ready, add it to a Test Suite, etc. -Plugins are extensions that enable integration with third-party applications such as Jenkins, MS Teams, Slack e.t.c. +--- +## **Plugins** +Plugins are extensions that enable integration with third-party applications such as Jenkins, MS Teams, Slack, etc. +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/testsigma-community-cloud.md b/src/pages/docs/getting-started/testsigma-community-cloud.md index 22455654..bb30bb9f 100644 --- a/src/pages/docs/getting-started/testsigma-community-cloud.md +++ b/src/pages/docs/getting-started/testsigma-community-cloud.md @@ -12,23 +12,26 @@ contextual_links: name: "Registering for Testsigma Community Cloud" url: "#registering-for-testsigma-community-cloud" --- + --- -As a Testsigma CE user, you can integrate your self-hosted open-source platform with our Community Cloud and get free access to -* **Test Lab:** Upto 200 minutes/month access to 800+ browsers/OS and real Android and iOS devices. -* **Storage:** Store upto 5GB of your data on the cloud for a month, including your apps, attachments, screenshots, video recordings, logs, and more. -* **Visual Testing:** Compare upto 1000 application screens per month to ensure pixel level quality of your UI by saving baseline visuals and comparing all future app versions against it. -* **iOS App Testing:** You can create a Provisioning Profile in Testsigma cloud and run your automated iOS app tests on your physical device. -* **Add-ons Marketplace:** Cover a wide range of automation and test scenarios by installing a comprehensive set of custom add-ons, built and tested by the -Testsigma community and engineering team. -* **Testsigma Discord Community:** Connect with some of the most experienced and creative test automation practitioners across the world. -  +As a Testsigma CE user, you can integrate your self-hosted open-source platform with our Community Cloud and get free access to: +- **Test Lab**: Up to 200 minutes/month access to 800+ browsers/OS and real Android and iOS devices. +- **Storage**: Store up to 5GB of your data on the cloud monthly, including your apps, attachments, screenshots, video recordings, logs, and more. +- **Visual Testing**: Compare up to 1000 application screens per month to ensure the pixel-level quality of your UI by saving baseline visuals and comparing all future app versions against it. +- **iOS App Testing**: You can create a Provisioning Profile in Testsigma cloud and run your automated iOS app tests on your physical device. +- **Add-ons Marketplace**: Cover a wide range of automation and test scenarios by installing a comprehensive set of custom add-ons built and tested by the Testsigma community and engineering team. +- **Testsigma Discord Community**: Connect with some of the most experienced and creative test automation practitioners worldwide. --- -##**Registering for Testsigma Community Cloud** -In your **Testsigma Application:**
- **-** Go to Settings
- **-** Click on **Testsigma Cloud (CE)** option
- **-** Register using one of the options provided
- **-** You’re now connected to the Cloud! +## **Registering for Testsigma Community Cloud** + +On your Testsigma application, +- Go to **Settings**. +- Click on **Testsigma Cloud (CE)** option. +- Register using one of the options provided. + +You’re now connected to the Cloud! + +--- \ No newline at end of file diff --git a/src/pages/docs/getting-started/testsigma-sample-apps.md b/src/pages/docs/getting-started/testsigma-sample-apps.md index 7a33516d..e37badfa 100644 --- a/src/pages/docs/getting-started/testsigma-sample-apps.md +++ b/src/pages/docs/getting-started/testsigma-sample-apps.md @@ -12,7 +12,8 @@ warning: false This article provides a few sample applications for users to practice testing independently. Users can use these sample apps to create independent test cases specific to their needs and requirements, which helps identify any issues or bugs. -
+--- + ## **Here's how you can access and download these sample applications:** @@ -21,7 +22,7 @@ This article provides a few sample applications for users to practice testing in - https://simply-travel.testsigma.com/ - https://mobile-simply-travel.testsigma.com/ -*For more information on how to create test cases, refer to [Test Cases](https://testsigma.com/docs/test-cases/overview/).* +*For more information on how to create test cases, refer to [test cases](https://testsigma.com/docs/test-cases/overview/).* 2. Use the following links for practicing mobile app testing. @@ -29,7 +30,7 @@ This article provides a few sample applications for users to practice testing in - [Sample APK Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/appdebug.apk) -*For more information on uploading mobile apps for testing, refer to [Upload Android and iOS apps](https://testsigma.com/docs/uploads/upload-apps/).* +*For more information on uploading mobile apps for testing, refer to [upload android and iOS apps](https://testsigma.com/docs/uploads/upload-apps/).* 3. Use the following link for practicing API testing: @@ -38,4 +39,6 @@ This article provides a few sample applications for users to practice testing in 4. Also, refer to the following documents to automate:
- [Android Apps](https://testsigma.com/tutorials/getting-started/automate-android-applications/)
- - [iOS Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/)
\ No newline at end of file + - [iOS Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/)
+ +--- \ No newline at end of file diff --git a/src/pages/docs/projects/applications.md b/src/pages/docs/projects/applications.md index 5ebaf229..2ab45a10 100644 --- a/src/pages/docs/projects/applications.md +++ b/src/pages/docs/projects/applications.md @@ -1,7 +1,7 @@ --- title: "Manage Applications" page_title: "Managing Applications in Testsigma" -metadesc: "How to manage Applications within Testsigma projects" +metadesc: "Applications tab provides details about all applications available in the project | Learn how to manage applications within Testsigma projects" noindex: false order: 2.1 page_id: "Manage Applications" @@ -21,55 +21,73 @@ contextual_links: --- -
+--- + + +The **Applications** tab within the **Project settings > Edit Project** menu provides details about all the Applications that are available in the current project. -The **Applications** tab within the **Dashboard > Project settings** menu provides details about all the Applications that are available in the current project. -Note that if your project contains only a single application, the **Applications** tab will be hidden. To enable multiple applications, edit your project details. *For more information, refer to [Project settings](https://testsigma.com/docs/projects/overview/)*. +[[info | **NOTE**:]] +| If your project contains only a single application, the **Applications** tab will be hidden. To enable multiple applications, edit your project details. *For more information, refer to [project settings](https://testsigma.com/docs/projects/overview/)*. + Once the **Applications** tab is enabled, you will be able to see all the applications created under the specific project. -1. Navigate to **Project settings > Applications**. - ![Project Settings Pop Up](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Project_settings_Applications.png) +--- + + +## **Add Application** + +1. Navigate to **Project Settings > Edit Project > Applications**. +![Applications](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apsnav.png) + -
+2. Click on **Add Application**. +![Add Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apscnapp.png) -## **Add application** +3. On **New application** prompt, enter **Application name**, **Description**, **Version name**, and select **Application type**. +![Prompt](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apspromdtls.png) -Depending on your requirements, you can add applications to your project in **Project settings > Applications page**. -1. Click on **+ New Application** to create a new Application under the current Project. -![Create Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/create_application_new.png) -2. Enter a name, description, and type of application. -![Project Description Box](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Project_Description_box.png) +4. Click on **Create**. +![Create](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apscocrete.png) -
+--- + + +## **Edit Application** + + +1. Navigate to **Project Settings > Edit Project > Applications**, and select application you want to edit from the dropdown. +![Edit Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apssapptoedit.png) -## **Edit application** -1. To edit your application, go to **Project settings > Applications** and select application you want to edit. -![Edit Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/edit_application.png) -2. Click on the **Edit** button for the application to open the **Edit application** page. +1. Make the required changes and click on the **Update** to save the changes. +![Edit Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apscoupdate.png) + + +--- + +## **Delete Application** -3. Make the required changes and click on the **Update** button to save the changes. +1. Navigate to **Project Settings > Edit Project > Applications**, select application you want to edit from the dropdown. +![Applications](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apsdapp.png) -![Edit Application Box](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/edit_app_box.png) -
+2. Click on **Delete Application**. +![Delete App](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apsdbutton.png) -## **Delete application** -1. To delete your application, go to **Project settings > Applications** and select application you want to delete. -![Delete box](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/delete_application.png) -2. Clicking on the **Delete** button for the application shows a warning prompt as shown below. In the box highlighted, enter **DELETE**, and click **I understand, delete this application** button to confirm the deletion. +3. Clicking on the **Delete** button for the application shows a warning **Delete project** prompt. Enter **DELETE**, and click **Delete** to confirm the deletion. +![Delete Prompt](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/apsdletion.png) -![Delete Prompt](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/delete_app_dialogue.png) -**NOTE:** -Deleting an Application leads to loss of all data within the application including -* All **Application versions** within the application. -* All the test cases, test data, uploads within all those Application versions. +[[info | **NOTE**:]] +| Deleting an Application leads to loss of all data within the application including: +| - All **application versions** within the application. +| - All the test cases, test data, uploads within all those Application versions. +--- \ No newline at end of file diff --git a/src/pages/docs/projects/settings/requirement-types.md b/src/pages/docs/projects/settings/requirement-types.md index 1cb395c7..f391dc4f 100644 --- a/src/pages/docs/projects/settings/requirement-types.md +++ b/src/pages/docs/projects/settings/requirement-types.md @@ -9,14 +9,14 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Add a new Requirement Type" + name: "Add a New Requirement Type" url: "#add-a-new-requirement-type" -- type: link - name: "Delete a Requirement Type" - url: "#delete-a-requirement-type" - type: link name: "Edit a Requirement Type" url: "#edit-a-requirement-type" +- type: link + name: "Delete a Requirement Type" + url: "#delete-a-requirement-type" --- --- diff --git a/src/pages/docs/test-data/add-values-to-test-data-profile.md b/src/pages/docs/test-data/add-values-to-test-data-profile.md index ecc697a3..e84250f5 100644 --- a/src/pages/docs/test-data/add-values-to-test-data-profile.md +++ b/src/pages/docs/test-data/add-values-to-test-data-profile.md @@ -1,36 +1,71 @@ --- -title: "How to add value to test data profile using NLP" -metadesc: "How to add values to test data profile in Testsigma." +title: "Updating Value in Test Data Profile" +metadesc: "In Testsigma, you can update values of test data profile using specific NLP in a test case. Learn how to update values in test data profiles in Testsigma." noindex: false order: 5.22 page_id: "Add values to test data profile" warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Updating Value in TDP Using Test Case" + url: "#updating-value-in-tdp-using-test-case" --- -
+--- + + +This article discusses how to update the values of a test data profile from a test case. *For more information on the test data profile, refer to [create a test data profile](https://testsigma.com/docs/test-data/create-data-profiles/).* + + +--- + +## **Prerequisites** + + +- You should know how to [create a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). + +- You should know how to [create a test data profile](https://testsigma.com/docs/test-data/create-data-profiles/). + +--- + +## **Updating Value in TDP Using Test Case** -This article discusses how to update the values of a test data profile using NLP's. *For more information on the test data profile, refer to [create a test data profile](https://testsigma.com/docs/test-data/create-data-profiles/).* -## **Steps to add value to test data profile** -1. In the test cases, use *write value test data to test-data-profile column parameter* NLP and follow the steps below: - - Hover over **test data** and select **plain text** from the dropdown menu. - ![Hover Test data](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/hover_testdata.png) +1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Case**. +![Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctdtcnav.png) + + + +2. To update value of a test data profile, we use the following NLP in our test case. +![NLP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tdpvunlp.png) + + + +3. On the above NLP, + + - Hover over **test data** and select **plain text** from the dropdown menu and replace it with the text you want to update. + ![plain text](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tdpvupt.png) + - Hover over the **test data profile** to select the test data profile you want to update. - ![Hover Test data profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/hover_tdp.png) + ![tdp](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tdpvustdp.png) + - Hover over the **parameter** to choose a column in the test data profile. - ![Hover parameter](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/hover_parameter.png) + ![column](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tdpvuparam.png) + + +4. Click on **Run** to execute the test case and update the value of the test data profile. +![Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tdpvurun.png) + -2. Click on **Create**. -![Click on create](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/create_testcase_button.png) -3. Click on **Run** to update the test data profile. *For more information, refer to [Ad-hoc run](https://testsigma.com/docs/runs/adhoc-runs/)* -![Click on Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/click_on_run.png) +5. On successful execution of the test case, the value will be updated in the test data profile. -4. Navigate to **Test development > Test data profile**. - - Select the test data profile you have added value. - ![Navigate to TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/navigate_TDP_.png) -5. You can see the changes in the test data profile. -![Changes in TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/changes_TDP.png) +--- \ No newline at end of file diff --git a/src/pages/docs/test-data/types/concat.md b/src/pages/docs/test-data/types/concat.md index 92ef59b7..fd142f50 100644 --- a/src/pages/docs/test-data/types/concat.md +++ b/src/pages/docs/test-data/types/concat.md @@ -8,38 +8,60 @@ warning: false contextual_links: - type: section name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" - type: link name: "Steps to Concat Test Data" url: "#steps-to-concat-test-data" --- -
+ +--- In Testsigma, users can concat test data, which combines multiple sets of test data. This article discusses how to concat test data. -Here is a quick GIF demonstrating how to concat test data in Testsigma. -![Concat GIF DEMO](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctestdata.gif) +--- + +## **Prerequisites** + +- You should know how to [create a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). + +- You should know how to use a [data generator](https://testsigma.com/docs/test-data/types/data-generator/). + +--- + ## **Steps to Concat Test Data** -1. Navigate to **Test Development > Test cases**, click on **Create**. -![Create TC](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testcase.png) - -2. On the **Test Case create page**, enter the test steps & use the highlighted **NLP** below to concat the Test data. -![Test Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/steps.png) - -3. In this **NLP**, - - Click on **test data**, and select **Data Generator** from the dropdown. - ![Dropdown](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/nlp.png) - - On **Test Data Generators** overlay, select ***!|StringFunctions :: Concat|*** string. - ![Test Data Generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/datagenerators.png) - - Enter **testdata** in all the strings and click on **Save** and **Create**. - ![Inputs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/inputs1.png) - [[info | **NOTE**:]] - |By clicking on **Add input testdata**, you can add multiple inputs to concat. - - Click on **test-data**, choose where you want to store the test data from the dropdown. - ![Storing Data](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/storedata.png) - -4. After adding all the steps, execute the Test Case. - -5. In the **Test Case result page**, you click on the step to validate the result. -![Validate Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/result1.png) \ No newline at end of file + + + +1. Navigate to **Create Tests > Test Cases**, and click on **Create Test Case**. +![Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctdtcnav.png) + + +2. To concat test data, we use the following NLP in our test case. +![NLP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctdstditd.png) + + +3. Click on **test data1**, and select **Data Generator** from the dropdown. +![Data Generator](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctddgen.png) + + +4. On **! Data Generators** overlay, select ***StringFunctions*** for **Function Type** and ***Concat*** for **Function**. +![Concat](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctdsfftc.png) + + +5. Click on **Save**. +![Save](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctdsave.png) + + +6. Click on **test data2**, choose where you want to store the test data from the dropdown. +![Storing Data](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cctdstore.png) + + +7. After adding all the steps, execute the test case and validate the result. + + + +--- \ No newline at end of file diff --git a/src/pages/docs/test-data/update-test-data-profile.md b/src/pages/docs/test-data/update-test-data-profile.md index e83e7bcd..089e9e89 100644 --- a/src/pages/docs/test-data/update-test-data-profile.md +++ b/src/pages/docs/test-data/update-test-data-profile.md @@ -1,39 +1,66 @@ --- -title: "Update test data profile" -metadesc: "How to update a test data profile in Testsigma." +title: "Update Test Data Profile" +metadesc: "In Testsigma, you can replace the old test datav profile with new data sets in one go. This article discusses how to update a test data profile in Testsigma." noindex: false order: 5.21 page_id: "Update Test Data Profile" warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Steps to Update Test Data Profile" + url: "#steps-to-update-test-data-profile" --- -
+--- + The following article discusses about updating an existing test data profile. *For more information on creating a test data profile refer to, [create a test data profile](https://testsigma.com/docs/test-data/create-data-profiles/)*. [[info | **NOTE**:]] -|The existing test data profile will be overwritten with the uploaded test data profile. +| The existing test data profile will be overwritten with the uploaded test data profile. + + +--- + +## **Prerequisites** + +- You should know how to [create a test data profile](https://testsigma.com/docs/test-data/create-data-profiles/). + + +--- + + +## **Steps to Update Test Data Profile** + + +1. Navigate to **Test Data > Test Data Profiles**. +![Nav TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/utdpnavt.png) + + +2. Hover over the test data profile you want to update and click on the kebab menu and select **Update TDP** from the dropdown. +![Test data profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/utdpsutdp.png) + + +3. On **Import Test Data Profile** prompt, click on **Browse file** to select the file you want to replace. +![Prompt](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/utdpbrwse.png) -
-##**Steps to update test data profile** +4. Select the file, enter name and choose the columns you want to encrypt. +![File](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/utdpncten.png) -1. Navigate to **Test development > Test data profiles**. -![Test data profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testdata_button.png) +5. Click on **Import**. +![Import](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/utdpimport.png) -2. Hover the mouse on the **Test data profile** you want to update. -3. Click on **Update** as shown in the image below. -![Update button](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/update_button_in_TDP.png) +6. On the successful update of test data profile, you will receive an email. -4. On the **Login credentials** pop-up window,
- - Click on **Browse** and select the file you want to import. -![Import TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/import_tdp.png)
Alternatively, you can drag or drop the file. - - Select the columns you want to encrypt.![Login credentials pop-up window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/import_tdp_login.png) - - Click on **Import**. - 5. On the successful update of test data profile, you will receive an email. Click **Refresh** to see the updated test data profile on the **All test data profile page**. -![Successful update of TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/successful_upload_tdp.png) \ No newline at end of file +--- \ No newline at end of file