Skip to content

Commit

Permalink
Updated docs as per new UI (#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bharathk08
bharathk08 authored Oct 11, 2023
1 parent 14dbb8c commit a224155
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 52 deletions.
81 changes: 52 additions & 29 deletions src/pages/docs/elements/import-export.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,41 @@ contextual_links:
name: "Import File Format"
url: "#import-file-format"
- type: link
name: "Import Elements"
url: "#import-elements"
name: "Steps to Import Elements"
url: "#steps-to-import-elements"
- type: link
name: "Export Elements"
url: "#export-elements"
name: "Steps to Export Elements"
url: "#steps-to-export-elements"

---

---

One of the most common use cases for the Import functionality is to copy Elements between Application Versions within Testsigma. You can export the Elements from the source Version and import them into the target Version across the same or different Projects.

Another common use case is to perform bulk-update on the Elements easily. You can export the Elements, make modifications for each element in the exported file as required and import it back to make changes for a set of Elements together easily.
[[info | NOTE:]]
|If you are trying to update the Elements using Import-Export, make sure to keep the UUID column intact so that the correct Element gets updated while importing back. You may change the other fields as required.
One of the most common use cases for the Import functionality is to copy elements between application versions within Testsigma. You can export the elements from the source version and import them into the target version across the same or different projects.


Another common use case is to perform bulk-update on the elements easily. You can export the elements, modify each element in the exported file as required, and import it back to make changes for a set of elements easily.


[[info | **NOTE**:]]
| If you are trying to update the elements using Import/Export, keep the UUID column intact so that the correct element gets updated while importing back. You may change the other fields as required.


Another less common application is when we want to load the Test locators for the UAT provided by the development team. The development team can add custom attributes to the elements to increase the application's testability and provide that to the testing team. This can be easily loaded using the Element Import functionality. They can create many Elements together by adding the Element details to a Spreadsheet file of suitable format and importing it, which creates all elements with the required details within the project.

Another less common application is when we want to load the Test locators for the Application under Test provided by the development team. The development team can add custom attributes to the elements for increasing the testability of the Application and provide that to the testing team. This can be easily loaded using the Element Import functionality. They can create a large number of Elements together by adding the Element details to a Spreadsheet file of suitable format and importing it which in turn creates all of the Elements with the required details within the Project.

*If you are trying to create new Elements in bulk, make sure to clear both the UUID columns.*

<br>

---


## **Prerequisites**
- You should have a file to import.

---

## **Import File Format**
The Import file has the following Columns:

Expand All @@ -48,40 +60,51 @@ The Import file has the following Columns:
| Created Using / createType | Mentions how the Element was created |

[[info | NOTE:]]
|A Sample Element Import Template file has been provided in the Element Import dialog.
| A Sample Element Import Template file has been provided in the Element Import dialog.

<br>

---
## **Import Elements**
From the Elements page, click on the Import button to open the Import Element Dialog which appears as shown below:
![Import Elements overlay in Elements page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/elements/import-export/elements-page-import-elements-overlay.png)

1. Click on the Choose File button to upload the Excel file containing the Elements and click on the Upload button to upload the file.

[[info | NOTE:]]
|We need to use a specific Elements file Template for importing the data. Click on the Sample File link to download the Elements file template, update your Elements data and re-upload the file to Import your Elements.
## **Steps to Import Elements**
1. Navigate to **Create Tests > Elements**.
![Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imelnavelem.png)

2. Once the file is uploaded, you will get two options to handle the duplicate Elements in the sheet as shown below:
2. From the **Elements** page, click on the **Import** button to open the Import dialog.
![Import Dialog](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imelid.png)

![Import Elements overlay focussed](https://docs.testsigma.com/images/import-export/elements-page-import-elements-overlay-focussed.png)
3. Click on **Browse File** to upload the file containing the **Elements**.
![Browse Files](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imelbrf.png)

**Overwrite:** Select this option if you want to overwrite the data in the Elements list on Testsigma when there is a clash between uploaded Elements and existing Elements.
4. Once the file is uploaded, you will get two options to handle the duplicate elements.
![Options](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imelto.png)
- Select the Overwrite option if you want to overwrite the data in the elements list.
- Select the Ignore option if you want to ignore the data from the elements file.

**Ignore:** Select this option if you want to ignore the data from the Elements file when there is a clash between uploaded Elements and existing Elements.
5. Click on **Import**.
![Import](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/elimcone.png)


3. Click on the **Import** button to upload the file and import the data into the Elements list.
It will show a success message saying that the import has started. The Elements will be imported in the background and you will receive an Email once the Import process is complete.
The elements will be imported in the background and you will receive an email once the import is complete.

<br>

---
## **Export Elements**
From the Elements page, click on the Export button to export all the Elements to a Spreadsheet file.

It will show a success message saying that the export has started. The Elements will be exported in the background and you will receive an Email once the Export process is complete.

## **Steps to Export Elements**
1. Navigate to **Create Tests > Elements**.
![Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imelnavelem.png)


2. From the **Elements** page, click on the **Export**.
![Export](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/imelexp.png)


It will show a success message saying that the export has started. The Elements will be exported in the background, and you will receive an email once the export process is complete.


Here's a quick GIF demonstrating how to import & export elements.
![Import & Export Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ImportExportElementsWorkFlow.gif)

---


76 changes: 53 additions & 23 deletions src/pages/docs/test-data/import-data-profiles.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Import test data profile"
metadesc: "How to import a test data profile to use it as test data in a test case in Testsigma."
title: "Import Test Data Profile"
metadesc: "In Testsigma, you can also import a test data profile and use it in your tests. This article discusses how to import a test data profile with right file format"
noindex: false
order: 5.22
page_id: "Import test data profile"
Expand All @@ -9,26 +9,32 @@ contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites:"
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to follow:"
url: "#steps-to-follow"
name: "Import File Format"
url: "#import-file-format"
- type: link
name: "Steps to Import Test Data Profile"
url: "#steps-to-import-test-data-profile"
---

---

Apart from creating a test data profile on Testsigma, you can also import a test data profile and view the profile in Testsigma. *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/).*<br> The following article discusses on how to import a test data profile.
Apart from creating a test data profile, you can also import a test data profile and use it in your tests. This article discusses how to import a test data profile in Testsigma application. *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/)*.

---

## **Prerequisites**
- You should know about test data profiles.
- You should have a file to import.


<br>
---

To import a test data profile, you first need an XLSX file that has the data in a supported format.
## **Import File Format**

Below is an example of the data that an XLSX file should have. Testsigma expects:
1. Name - Name of the test data set that the corresponding row would contain
2. Description - Description for that row of that test data
3. ExpectedToFail - would have either ‘YES’ or ‘NO’, depending on whether you expect the test case to fail with this test data or you expect it to pass.
4. Now you begin adding columns for the test data that you need to pass as parameters to your test case. For example, here we added ‘Username’ and ‘Password’
To import a test data profile, you first need an XLSX file that has the data in a supported format. Below is an example of the data that an XLSX file should have.

|Name|Description|ExpectedToFail|Username|Password|
|----|-----------|--------------|--------|--------|
Expand All @@ -43,19 +49,43 @@ Below is an example of the data that an XLSX file should have. Testsigma expects
|Iteration9|Ninth value|YES|username9|password9|
|Iteration10|Tenth value|NO|username10|password10|


The following are the mandatory fields that should be present in the XLSX file.
- **Name**: Name of the test data set that the corresponding row would contain
- **Description**: Description for that row of that test data
- **ETF**: This would be either ‘YES’ or ‘NO’, depending on whether you expect the test case to fail with this test data or you expect it to pass.


---

1. Navigate to **Test development > Test data profiles**.
![TDP Button](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testdata_button.png)

## **Steps to Import Test Data Profile**

1. Navigate to **Test Data > Test Data Profiles**.
![Test Data Profiles](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/itdpnav.png)


2. Click on **Import**.
![Import TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/import_testdata_profile.png)
![Import](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/itdpcoimp.png)


3. On **Import Test Data Profile** prompt,
- Click on **Browse File** to upload the file.
![Browse File](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/itdppbf.png)

- Once the file is uploaded, enter **Name** and select the columns you want to encrypt. Here, we have selected the **Password** field to encrypt.
![Name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/itdpsce.png)

- Click on **Import**.
![Import](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/itdpimport.png)



On the successful import of the test data profile, you will receive an email. Refresh the test data profiles page to see the imported test data profile.


Here's a quick GIF demonstrating how to import test data profile.
![Import Test Data Profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ImportTDPWF.gif)

3. On the **Import** pop-up window, <br>
- Click on **Browse** and select the file you want to import. Alternatively, you can drag or drop the file.
![Browse TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Browse_TDP.png)
- Select the columns you want to encrypt.![Import pop-up window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Import_pop-up.png)
- Click on **Import**.

4. On the successful import of test data profile, you will receive an email. Click **Refresh** to see the imported test data profile on the **All test data profile page**.
![Successful Import of TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/successful_import_TDP.png)
---

0 comments on commit a224155

Please sign in to comment.