This example demonstrates how to implement compose and distribution of an email from within the context of an automated test in execution.

Worksoft SaaS is agnostic to the purpose these emails serve in the context of your business, be it a notification of a positive outcome or a negative outcome.

In this example, first the sender is set, then the subject, recipient list (to, cc, bcc), followed by the email body, and finally, the email is distributed. For email body, a simple text string is used. In real life, the email body usually is not that simple where static text satisfies your needs. Please refer to other examples that cover techniques that will help you build email bodies incrementally, including multi-part mime types (embedding screenshots, attaching files, etc).

Solution:

#	Command	Target	Value
To begin the email service block
1	emailBlockStart
To set the sender for the composed email
2	setSender	info@eureqatest.com
To set the subject for the composed  email
3	setSubject	Worksoft SaaS Notification: Issue identified
To set the ‘To’ recipient list for the composed email
4	setRecipientToList	recipient1@gmail.com
To set the ‘CC’ recipient list for the composed email
5	setRecipientCCList	recipient2@gmail.com, recipient3@gmail.com
To set the ‘BCC’ recipient list for the composed email
6	setRecipientBCCList	recipient4@gmail.com
To create the email body with a variable name
7	createBody	body_template
To create an email body part from Text or HTML string
8	createBodyPartFromTextOrHTML	Hi <mention recipient’s name here>,  <mention your body text here>	body_template
To embed the data file  into the email body
9	createBodyPartFromDataFile	<mention your data file name here>	body_part1
To append the body part into the email body
10	appendBodyPartToBody	body_part1	body_template
To send the composed email to the sender’s specified in “To, CC and BCC” list
11	sendEmail
It indicates the end of the email block
12	emailBlockEnd

Tips, Tricks, Gotchas & Best Practices:  

• The subject can be foreign language characters.
• You can also use CSS styles like underlines, font color, and to highlight anything important in bold letters and the table background color in the email body to make the email look effective.
• For the command createBodyPartFromDataFile in the value field instead of providing the body part name and then providing this as an input to the command appendBodyPartToBody, user can also provide the email body name(template name provided as a variable name in createBody command) directly which will create an email body part from the Data File but the best practice is to use the appendBodyPartToBody command after using the createBodyPartFromDataFile command.

Representative Usage Scenarios for this Example:

Use Case #1:

After scheduling a run/batch of runs in Worksoft SaaS, the user has to login to Worksoft SaaS to know the run details, inputs and the screenshots of each and every test run as part of certification/CTC runs. The user can log in and search for the respective run details if the runs are in a single number.
What would be the case if there were hundreds of runs?

Consider a driver run, in order to trigger the batch of test runs at the scheduled time, we prefer using driver run which in turn triggers the actual runs.

If the user wants to know the run details in the driver runs like Run Definition Name, Testing Context Key, Test Start time and the response of the scheduled run...and so on. Then the user has to check those scheduled runs in Home screen else, checks the count through the Test Cycles screen by searching the Test Cycle Identifier under which runs are grouped. This process involves multiple navigations, ambiguity and time consumption. 

Also in case of failures, while triggering the runs, the triage to identify the root cause for failure would consume a lot of time if more runs are executed.

To enable the user to have access to the information faster w/ minimal actions; Worksoft SaaS allows to customize emails which can be triggered by the execution.

An email can be customized using the above commands in such a way that the below details will be sent to the user within the email. 

1. Run Definition Name
2. Testing Context Key 
3. Test Start time 
4. Response of the scheduled run 
5. Input driver Data File
6. Input file 
7. Output Data Set 
8. Error message