diff --git a/src/pages/docs/test-data/data-generators/address-function-type.md b/src/pages/docs/test-data/data-generators/address-function-type.md index 18a01c4f..ca902b1e 100644 --- a/src/pages/docs/test-data/data-generators/address-function-type.md +++ b/src/pages/docs/test-data/data-generators/address-function-type.md @@ -79,7 +79,7 @@ contextual_links: --- -The Address Function Type provides various functions that generate realistic and varied address components. These functions help in creating complete and detailed addresses, which are crucial for ensuring the proper handling of various address formats and elements in different applications. Each function focuses on a specific address part, allowing for the creation of comprehensive and authentic address data for diverse purposes. +Address functions generate various components of address data, such as street names, city names, and postal codes. These functions help create realistic and comprehensive address information for testing and data simulation purposes. You can generate complete addresses or individual elements like building numbers and ZIP codes. --- @@ -1003,7 +1003,7 @@ Before utilising the different data generator functions, it's essential to under ## **Building Number** -- Allows you to generate random building numbers. It provides numeric identifiers for buildings or addresses in applications that require specific location details. +- Allows you to generates a random building number for address data and ensures that the generated addresses include a realistic building number. + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: DAYS,
Format: 'dd/MM/yyyy'		15/08/2024
At most: 60,
Unit: DAYS,
Format: 'dd/MM/yyyy'		08/09/2024
At most: 90,
Unit: DAYS,
Format: 'dd/MM/yyyy'		14/10/2024
At most: 30,
Unit: DAYS,
Format: 'dd/MM/yyyy'/td> + 		09/08/2024
+
+ +--- + +## **Future** + +- Enables you to generate dates up to a specified number of days in the future from today's date. +- Generate dates for future events or reminders without specifying a reference date, making it ideal. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		15/08/2024
At most: 60,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		08/09/2024
At most: 90,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		14/10/2024
At most: 30,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		09/08/2024
+
+ +--- + +## **Current** + +- Allows you to generate today's date in the specified format. +- This is useful when timestamping, or a specific format requires today's date. + +Here's a comprehensive example using the provided code template. The examples for all DateFunctions are presented in a tabular format: + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Format: 'dd/MM/yyyy'20/07/2024
Format: 'dd/MM/yyyy'16/07/2024
Format: 'dd/MM/yyyy'30/04/2020
Format: 'dd/MM/yyyy'12/12/2024
+
+ + +--- + +## **Between** + +- Enables you to generate dates within a specified range. +- It is helpful in scenarios where you need to generate dates for a defined period, such as scheduling appointments or analyzing trends within a specific timeframe. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'		14/05/2022
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'		22/08/2022
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'		11/11/2022
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'		02/03/2022
+
+ +--- + +## **Past** + +- Allows you to generate past dates relative to the current date. +- This function helps create historical records, such as back at events or unanalyzed over a past period. + +Here's a comprehensive example using the provided code template. The examples for all DateFunctions are presented in a tabular format: + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'		11/05/2024
At most: 30,
Unit: days,
Format: 'dd/MM/yyyy'		16/06/2024
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'		17/05/2024
At most: 90,
Unit: days,
Format: 'dd/MM/yyyy'		17/04/2024
+
+ +--- + +## **Past** + +- Allows you to generate past dates relative to a specified reference date. +- It is ideal when you need to anchor your past dates to a specific point in time, which can be helpful for historical simulations or data analysis starting from a particular date. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		15/08/2024
At most: 60,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		08/09/2024
At most: 90,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		14/10/2024
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		09/08/2024
+
+ +--- + +## **Birthday** + +- Allows you to generate random dates formatted as birthdays. +- Ideal for scenarios that require random date generation, such as populating test data or simulating user profiles with birthdates. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Offset: 30,
Format: 'dd/MM/yyyy'		16/07/1994
Offset: 25,
Format: 'dd/MM/yyyy'		16/07/1999
Offset: 40,
Format: 'dd/MM/yyyy'		16/07/1984
Offset: 18,
Format: 'dd/MM/yyyy'		16/07/2006
+
+ +--- + +## **Date Before Today** + +- Allows you to generate a date of a specified number of days before today. +- Generating historical dates relative to the current date is helpful for data analysis or scheduling based on past events. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Format: 'dd/MM/yyyy'		16/06/2024
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'		17/05/2024
At most: 90,
Unit: days,
Format: 'dd/MM/yyyy'		17/04/2024
At most: 45,
Unit: days,
Format: 'dd/MM/yyyy'		01/06/2024
+
+ +--- + +## **Date After Today** + +- Allows you to generate a date that is a specified number of days after today's date. +- You can use it to calculate future dates relative to the current date, such as when you schedule future tasks or events. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Format: 'dd/MM/yyyy'		15/08/2024
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'		14/09/2024
At most: 90,
Unit: days,
Format: 'dd/MM/yyyy'		14/10/2024
At most: 45,
Unit: days,
Format: 'dd/MM/yyyy'		30/08/2024
+
+ +--- + +## **Date Before Given Today** + +- Allows you to generate a date that is a specified number of days before a given reference date. +- It is helpful for scenarios where you need to calculate deadlines or events relative to a specific date in the past. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		10/06/2024
At most: 60,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		11/05/2024
At most: 90,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		11/04/2024
At most: 45,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		26/05/2024
+
+ +--- + +## **Date After Given Today** + +- Allows you to generate a date that is a specified number of days after a given reference date. +- It helps project dates or events forward from a specific reference point, such as milestones or project deadlines. + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		09/08/2024
At most: 60,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		08/09/2024
At most: 90,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		08/10/2024
At most: 45,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'		24/08/2024
+
+ +--- + + + diff --git a/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md b/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md index b601ade7..08cb0e5b 100644 --- a/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md @@ -105,19 +105,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 10 + username length: 10 johnsmith1 - username length: 6 + username length: 6 sarah5 - username length: 10 + username length: 10 sarahglenn - username length: 6 + username length: 6 robert @@ -175,19 +175,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 8 + username length: 8 abc12345@example.com - username length: 12 + username length: 12 xyz67890abcd@example.com - username length: 10 + username length: 10 pqrs9876@example.com - username length: 6 + username length: 6 mno345@example.com @@ -247,19 +247,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 10,
Domain: mydomain.com + username length: 10,
Domain: mydomain.com user1234ab@mydomain.com - username length: 8,
Domain: example.org + username length: 8,
Domain: example.org test5678@example.org - username length: 12,
Domain: mail.com + username length: 12,
Domain: mail.com alpha890beta@mail.com - username length: 6,
Domain: customdomain.com + username length: 6,
Domain: customdomain.com abc456@customdomain.com @@ -319,19 +319,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 6,
Domain: sample.com + username length: 6,
Domain: sample.com user12@sample.com - username length: 8,
Domain: example.com + username length: 8,
Domain: example.com test4567@example.com - username length: 10,
Domain: domain.org + username length: 10,
Domain: domain.org randomuser@domain.org - username length: 7,
Domain: mail.net + username length: 7,
Domain: mail.net abc1234@mail.net @@ -391,19 +391,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 12 + username length: 12 randomuser@domain.com - username length: 10 + username length: 10 sampleuser@domain.com - username length: 8 + username length: 8 testuser@domain.com - username length: 6 + username length: 6 user01@domain.com diff --git a/src/pages/docs/test-data/data-generators/friends-function-type.md b/src/pages/docs/test-data/data-generators/friends-function-type.md new file mode 100644 index 00000000..858e2804 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/friends-function-type.md @@ -0,0 +1,145 @@ +--- +title: "Friends Function Type" +pagetitle: "Generate and Manage Email Addresses with EmailFunctions" +metadesc: "Friends function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +noindex: false +order: 5.46 +page_id: "friends-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Friends as a Function Type for Data Generator" + url: "#selecting-friends-as-a-function-type-for-data-generator" +- type: link + name: "Character" + url: "#character" +- type: link + name: "Locationsr" + url: "#locations" +--- + +--- + +TestDataFromProfile functions enable users to retrieve specific test data from designated profiles, allowing for easy access and utilization of predefined datasets for testing purposes. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting Friends as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **Friends** from the **Function Type** dropdown list. ![select friends function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/friends_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Character** + +- Enables you to create diverse, random character names, which facilitates the testing of character-related features and ensures varied data inputs. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Locations** + +- Allows you to generate random locations, aiding in the testing of location-based functionalities and ensuring comprehensive coverage. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + diff --git a/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md b/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md new file mode 100644 index 00000000..7492c617 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md @@ -0,0 +1,675 @@ +--- +title: "MailboxAliasFunctions Function Type" +pagetitle: "Generate and Manage Email Addresses with EmailFunctions" +metadesc: "MailboxAliasFunctions function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +noindex: false +order: 5.43 +page_id: "mailboxaliasfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting MailboxAliasFunctions as a Function Type for Data Generator" + url: "#selecting-mailboxaliasfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Generate Mailbox Alias" + url: "#generate-mailbox-alias" +- type: link + name: "Get Email Content" + url: "#get-email-content" +- type: link + name: "Get Email Subject" + url: "#get-email-subject" +- type: link + name: "Get OTP" + url: "#get-otp" +- type: link + name: "URL with Text" + url: "#url-with-text" +- type: link + name: "URL which Contains" + url: "#url-which-contains" +- type: link + name: "URL matching Regex" + url: "#url-matching-regex" +- type: link + name: "Get Sender Email" + url: "#get-sender-email" +- type: link + name: "Get Sender Name" + url: "#get-sender-name" +--- + +--- + +MailBoxAlias Functions enable dynamic interaction with email data in testing and automation. Users can create, retrieve, and manipulate email aliases and their content during test execution. These functions enhance testing efficiency by facilitating seamless email testing and validation processes. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. Additionally, familiarize yourself with [MailBoxFunctions](https://testsigma.com/docs/test-data/types/mailbox/) for accessing and manipulating email content and metadata. + +--- + +## **Selecting MailboxAliasFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **MailboxAliasFunctions** from the **Function Type** dropdown list. ![select mailboxaliasfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/mailboxaliasfuntions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Generate Mailbox Alias** + +- Allows you to create a unique email alias associated with your primary email account during a test step. +- Each alias generates a separate mailbox, enabling multiple email addresses to direct emails to the same inbox for testing and automation purposes. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Selected MailBoxmailboxalias123@example.com
Selected MailBoxuser1alias456@example.com
Selected MailBoxtestuseralias789@example.com
Selected MailBoxdemoalias101@example.com
+
+ + +--- + +## **Get Email Content** + +- Enables you to retrieve the subject line of an email message based on specified runtime variables using this feature. +- It captures email subjects dynamically during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30		Hello! This is the content of your email.
Runtime Variable: promotions,
Timeout: 30		Get 50% off on your next purchase.
Runtime Variable: updates,
Timeout: 30		Your order has been shipped.
Runtime Variable: spam,
Timeout: 30		Congratulations! You've won a prize.
+
+ +--- + +## **Get Email Subject** + +- Allows you to retrieve the subject line of an email message based on specified runtime variables. +- It is used to capture email subjects dynamically during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30		Your Order Confirmation
Runtime Variable: promotions,
Timeout: 30		Special Offer Just for You
Runtime Variable: updates,
Timeout: 30		Account Verification Required
Runtime Variable: spam,
Timeout: 30		You've Been Selected!
+
+ +--- + +## **Get OTP** + +- Enables you to extract an OTP from an email message based on a provided regex pattern and runtime variables. +- It facilitates the automated retrieval of OTPs for testing authentication flows. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: \d{6},
Runtime Variable: inbox,
Timeout: 30		123456
Regex: \d{4},
Runtime Variable: inbox,
Timeout: 30		7890
Regex: \d{5},
Runtime Variable: promotions,
Timeout: 30		54321
Regex: \d{6},
Runtime Variable: updates,
Timeout: 30		654321
+
+ +--- + +## **URL with Text** + +- Allows you to retrieve a URL from an email containing specified text. +- It searches for URLs embedded in email content that match the provided text criteria. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Text: Verify,
Runtime Variable: inbox,
Timeout: 30		https://example.com/verify
Text: Confirm,
Runtime Variable: promotions,
Timeout: 30		https://example.com/confirm
Text: Reset,
Runtime Variable: updates,
Timeout: 30		https://example.com/reset
Text: Activate,
Runtime Variable: spam,
Timeout: 30		https://example.com/activate
+
+ +--- + +## **URL which Contains** + +- Enables you to retrieve a URL from an email message containing specified substrings or parameters. +- It searches for URLs embedded in email content that include the provided substring. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Substring: verify,
Runtime Variable: inbox,
Timeout: 30		https://example.com/verify
Substring: confirm,
Runtime Variable: promotions,
Timeout: 30		https://example.com/confirm
Substring: reset,
Runtime Variable: updates,
Timeout: 30		https://example.com/reset
Substring: activate,
Runtime Variable: spam,
Timeout: 30		https://example.com/activate
+
+ +--- + +## **URL Matching Regex** + +- Allows you to retrieve a URL from an email message that matches a specified regex pattern. +- It enables flexible URL extraction based on custom regex patterns defined by the user. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: r'https://\w+\.com/\w+',
Runtime Variable: inbox,
Timeout: 30		https://example.com/verify
Regex: r'https://\w+\.com/\w+',
Runtime Variable: promotions,
Timeoutv: 30		https://promo.com/deal
Regex: r'https://\w+\.com/\w+',
Runtime Variable: updates,
Timeout: 30		https://updates.com/info
Regex: r'https://\w+\.com/\w+',
Runtime Variable: spam,
Timeout: 30		https://spam.com/win
+
+ +--- + +## **Get Sender Email** + +- Enables you to retrieve the sender's email address from an email message based on specified runtime variables. +- It simplifies fetching sender information during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30		sender@example.com
Runtime Variable: promotions,
Timeout: 30		promo@example.com
Runtime Variable: updates,
Timeout: 30		updates@example.com
Runtime Variable: spam,
Timeout: 30		spam@example.com
+
+ +--- + +## **Get Sender Name** + +- Allows you to retrieve the sender's name from an email message based on specified runtime variables. +- It facilitates fetching sender information during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30		John Doe
Runtime Variable: promotions,
Timeout: 30		Promo Sender
Runtime Variable: updates,
Timeout: 30		Update Sender
Runtime Variable: spam,
Timeout: 30		Spam Sender
+
+ +--- + diff --git a/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md index 64f5468f..02929056 100644 --- a/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md @@ -1,7 +1,7 @@ --- title: "MailboxFunctions Function Type" -pagetitle: "Generate and Manage Email Addresses with EmailFunctions" -metadesc: "EmailFunctions function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +pagetitle: "Explore MailBoxFunctions for Efficient Email Handling" +metadesc: "Explore how MailBoxFunctions streamlines email data retrieval for improved workflow efficiency and clarity. Discover examples and detailed instructions." noindex: false order: 5.42 page_id: "mailboxfunctions-function-type" @@ -52,7 +52,7 @@ contextual_links: --- -Testsigma's MailBoxFunctions enables you to interact with email functionalities programmatically. This function type lets you perform various operations related to email content, subject, URLs, and verification through specified mailbox configurations. +MailBoxFunctions are specialized tools that facilitate efficient email management. They enable you to retrieve sender details and perform operations within email systems, seamlessly optimizing workflow and enhancing productivity. --- @@ -124,22 +124,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \d{4},
Select MailBox,
Timeout: 60 + Regex: \d{4},
Select MailBox,
Timeout: 60 1234 - Regex: \d{6},
Select MailBox,
Timeout: 120 + Regex: \d{6},
Select MailBox,
Timeout: 120 987654 - Regex: \d{5},
Select MailBox,
Timeout: 90 + Regex: \d{5},
Select MailBox,
Timeout: 90 54321 - Regex: \d{4,6},
Select MailBox,
Timeout: 180 + Regex: \d{4,6},
Select MailBox,
Timeout: 180 1234, 56789, 456789 @@ -199,22 +199,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \bhttps:\/\/example\.com\b,
Select MailBox,
Timeout: 60 + Regex: \bhttps:\/\/example\.com\b,
Select MailBox,
Timeout: 60 https://example.com - Regex: \bhttp:\/\/test\.com\/\w+,
select MailBox,
Timeout: 120 + Regex: \bhttp:\/\/test\.com\/\w+,
select MailBox,
Timeout: 120 http://test.com/12345 - Regex: \bhttps:\/\/www\.website\.com\/\w+,
Select MailBox,
Timeout: 90 + Regex: \bhttps:\/\/www\.website\.com\/\w+,
Select MailBox,
Timeout: 90 https://www.website.com/page123 - Regex: \bhttps:\/\/\w+\.com\/\w+,
Select MailBox,
Timeout: 180 + Regex: \bhttps:\/\/\w+\.com\/\w+,
Select MailBox,
Timeout: 180 https://example.com/page1, https://test.com/12345, https://anotherwebsite.com/home @@ -273,22 +273,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \bSubject: Order #[0-9]+\b,
Select MailBox,
Compare String: Subject: Order #12345,
Timeout: 60 seconds + Regex: \bSubject: Order #[0-9]+\b,
Select MailBox,
Compare String: Subject: Order #12345,
Timeout: 60 seconds true - Regex: \bSubject: OTP - [0-9]{4}\b,
Select MailBox,
Compare String: Subject: OTP - 5678,
Timeout: 120 seconds + Regex: \bSubject: OTP - [0-9]{4}\b,
Select MailBox,
Compare String: Subject: OTP - 5678,
Timeout: 120 seconds true - Regex: \bSubject: Invitation to event\b,
Select MailBox,
Compare String: Subject: Invitation to event,
Timeout: 90 seconds + Regex: \bSubject: Invitation to event\b,
Select MailBox,
Compare String: Subject: Invitation to event,
Timeout: 90 seconds true - Regex: \bSubject: Verification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Subject: Verification Code: 123456,
Timeout: 180 seconds + Regex: \bSubject: Verification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Subject: Verification Code: 123456,
Timeout: 180 seconds true @@ -347,22 +347,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \bOrder #[0-9]+\b,
Select MailBox,
Compare String: Order #12345,
Timeout: 60 + Regex: \bOrder #[0-9]+\b,
Select MailBox,
Compare String: Order #12345,
Timeout: 60 true - Regex: \bOTP - [0-9]{4}\b,
Select MailBox,
Compare String: OTP - 5678,
Timeout: 120 + Regex: \bOTP - [0-9]{4}\b,
Select MailBox,
Compare String: OTP - 5678,
Timeout: 120 true - Regex: \bInvitation to event\b,
Select MailBox,
Compare String: Invitation to event,
Timeout: 90 + Regex: \bInvitation to event\b,
Select MailBox,
Compare String: Invitation to event,
Timeout: 90 true - Regex: \bVerification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Verification Code: 123456,
Timeout: 180 + Regex: \bVerification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Verification Code: 123456,
Timeout: 180 true @@ -422,22 +422,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBox
Timeout: 60 + Select MailBox
Timeout: 60 Email content from MailBox - Select MailBox
Timeout: 120 + Select MailBox
Timeout: 120 Email content from MailBox - Select MailBox
Timeout: 90 + Select MailBox
Timeout: 90 Email content from MailBox - Select MailBox
Timeout: 180 + Select MailBox
Timeout: 180 Email content from MailBox @@ -497,22 +497,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBox
Timeout: 60 + Select MailBox
Timeout: 60 Email subject from MailBox - Select MailBox
Timeout: 120 + Select MailBox
Timeout: 120 Email subject from MailBox - Select MailBox
Timeout: 90 + Select MailBox
Timeout: 90 Email subject from MailBox - Select MailBox
Timeout: 180 + Select MailBox
Timeout: 180 Email subject from MailBox @@ -571,22 +571,22 @@ Before utilising the different data generator functions, it's essential to under - Text: "Click here for more info",
Select MailBox,
Timeout: 60 + Text: "Click here for more info",
Select MailBox,
Timeout: 60 URL linked to "Click here for more info" from MailBox - Text: "Visit our website",
Select MailBox,
Timeout: 120 + Text: "Visit our website",
Select MailBox,
Timeoutv: 120 URL linked to "Visit our website" from MailBox - Text: "Check out the new products",
Select MailBox,
Timeout: 90 + Text: "Check out the new products",
Select MailBox,
Timeout: 90 URL linked to "Check out the new products" from MailBox - Text: "Click here or here for updates",
Select MailBox,
Timeout: 180 + Text: "Click here or here for updates",
Select MailBox,
Timeout: 180 URLs linked to "Click here or here for updates" from MailBox @@ -646,22 +646,22 @@ Before utilising the different data generator functions, it's essential to under - Substring: "more info",
Select MailBox,
Timeout: 60 + Substring: "more info",
Select MailBox,
Timeout: 60 URLs containing "more info" MailBox - Substring: "website",
Select MailBox,
Timeout: 120 + Substring: "website",
Select MailBox,
Timeout: 120 URLs containing "website" from MailBox - Substring: "products",
Select MailBox,
Timeout: 90 + Substring: "products",
Select MailBox,
Timeout: 90 URLs containing "products" from MailBox - Substring: "updates",
Select MailBox,
Timeout: 180 + Substring: "updates",
Select MailBox,
Timeout: 180 URLs containing "updates" from MailBox @@ -721,22 +721,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \d{4},
Select MailBox,
Timeout: 60 + Regex: \d{4},
Select MailBox,
Timeout: 60 URLs containing numbers (e.g., 1234) from MailBox within 60 - Regex: \w{6},
Select MailBox,
Timeout: 120 + Regex: \w{6},
Select MailBox,
Timeout: 120 URLs containing alphanumeric strings (e.g., abc123) from MailBox within 120 - Regex: https?,
Select MailBox,
Timeout: 90 + Regex: https?,
Select MailBox,
Timeout: 90 URLs starting with "http" or "https" from MailBox within 90 - Regex: \.com$,
Select MailBox,
Timeout: 180 + Regex: \.com$,
Select MailBox,
Timeout: 180 URLs ending with ".com" from MailBox within 180 @@ -795,22 +795,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBoxFunctions,
Timeout: 60 seconds + Select MailBoxFunctions,
Timeout: 60 seconds sender1@example.com - Select MailBoxFunctions,
Timeout: 120 seconds + Select MailBoxFunctions,
Timeout: 120 seconds sender2@example.com - Select MailBoxFunctions,
Timeout: 90 seconds + Select MailBoxFunctions,
Timeout: 90 seconds sender3@example.com - Select MailBoxFunctions,
Timeout: 180 seconds + Select MailBoxFunctions,
Timeout: 180 seconds sender4@example.com @@ -869,22 +869,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBoxFunctions,
Timeout: 60 seconds + Select MailBoxFunctions,
Timeout: 60 seconds John Doe - Select MailBoxFunctions,
Timeout: 120 seconds + Select MailBoxFunctions,
Timeout: 120 seconds Jane Smith - Select MailBoxFunctions,
Timeout: 90 seconds + Select MailBoxFunctions,
Timeout: 90 seconds Alice Johnson - Select MailBoxFunctions,
Timeout: 180 seconds + Select MailBoxFunctions,
Timeout: 180 seconds Bob Brown diff --git a/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md b/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md new file mode 100644 index 00000000..bdced8b7 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md @@ -0,0 +1,184 @@ +--- +title: "StringFunctions Function Type" +pagetitle: "Transform Text Easily with StringFunctions" +metadesc: "StringFunctions in Testsigma enable dynamic string manipulation, including concatenation and variable substitution, which is ideal for flexible data generation." +noindex: false +order: 5.44 +page_id: "stringfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting StringFunctions as a Function Type for Data Generator" + url: "#selecting-stringfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Concat" + url: "#concat" +- type: link + name: "Param Substituter" + url: "#param-substituter" +--- + +--- + +StringFunctions allow you to manipulate and transform text strings effortlessly. These functions enable you to combine strings and perform dynamic substitutions of placeholders with actual values, supporting various testing and data generation needs. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. Additionally, familiarize yourself with [Parameters](https://testsigma.com/docs/test-data/types/parameter/), [Runtime](https://testsigma.com/docs/test-data/types/runtime/) and [Environments](https://testsigma.com/docs/test-data/types/environment/). + +--- + +## **Selecting StringFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **StringFunctions** from the **Function Type** dropdown list. ![select stringfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/stringfunctions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Concat** + +- Enables you to concatenate multiple strings or data fields into a single string output, allowing you to combine strings to form composite data inputs. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Test Data 1: Hello,
Test Data 2: World		HelloWorld
Test Data 1: @ User1User123
Test Data 1: $ DataDataGeneration
Test Data 1: * Travelhttps://simply-travel.testsigma.com/
+
+ +--- + +## **Param Substituter** + +- Allows you to replace placeholders in the input string with their respective values. +- It supports Parameters, Runtime Variables, and Environment Variables, enabling dynamic substitution of variables into predefined strings for flexible data generation. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
String: I am @|name|. Born on *|dob| at $|place|I am John. Born on 01/01/1990 at New York
String: Welcome, @|username|! Today is *|date|."Welcome, User123! Today is 2024-07-18."
String: Order ID: #|orderId|, Status: *|status|"Order ID: #5678, Status: Shipped
String: Hello @|firstName|, your appointment is on *|appointmentDate|Hello Alice, your appointment is on 2024-07-25
+
+ + +--- + + diff --git a/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md b/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md new file mode 100644 index 00000000..54f0dd87 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md @@ -0,0 +1,164 @@ +--- +title: "TestDataFromProfile Function Type" +pagetitle: "Generate and Manage Email Addresses with EmailFunctions" +metadesc: "TestDataFromProfile function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +noindex: false +order: 5.45 +page_id: "testdatafromprofile-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting TestDataFromProfile as a Function Type for Data Generator" + url: "#selecting-testdatafromprofile-as-a-function-type-for-data-generator" +- type: link + name: "Get Test Data by SetName" + url: "#get-test-data-by-setname" +- type: link + name: "Get Test Data by RowNumber" + url: "#get-test-data-by-rownumber" +--- + +--- + +TestDataFromProfile functions enable users to retrieve specific test data from designated profiles, allowing for easy access and utilization of predefined datasets for testing purposes. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. Additionally, familiarize yourself with [Test Data Profile](https://testsigma.com/docs/test-data/create-data-profiles/). + +--- + +## **Selecting TestDataFromProfile as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **TestDataFromProfile** from the **Function Type** dropdown list. ![select testdatafromprofile function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testdatafromprofile_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Get Test Data by SetName** + +- Enables you to fetch test data by specifying the test data profile, dataset, parameter, and dataset index and returning corresponding data from the selected profile and dataset. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Profile: Customer Data Profile,
Dataset: Active Customers,
Parameter: Customer ID,
Data Set: 1		12345
Profile: Order Data Profile,
Dataset: Pending Orders,
Parameter: Order ID,
Data Set: 2		67890
Profile: Employee Data Profile,
Dataset: Current Employees,
Parameter: "Employee ID",
Data Set: 3		54321
Profile: Product Data Profile,
Dataset: Available Products,
Parameter: Product Code,
Data Set: 4		P001
+
+ +--- + +## **Get Test Data by RowNumber** + +- Allows you to retrieve test data by specifying the row number within the profile and returning data from that row. + + + +
+
+ ℹ️Example: +
+
    +
  • Input: None (This function does not require any specific input)
    • +
  • Output:
    • +
      +
    • Neha Grant
      • +
    • Vern Sanford
      • +
    • Michael Johnson
      • +
    • Sarah Davis
      • +
    +
+
+ +--- +