Worksoft SaaS Analytics, while rich in charts & graphs also provide raw data in the form of excel through Transactions Detail Report. This excel data is available at each Test Cycle and by default has 8 sheets (i.e., Test_Cycle_Summary, Summaries_by_Run_Definition, Summaries_by_Scenario, Summaries_by_Application_Module, Test_Cycle_Transaction_Log, Scenario_Transaction_Log, Test_Script_Transaction_Log, Failed_Instruction_Log) with the last sheet in the list created only when there are any failed test runs in the Test Cycle.

In most of the cases, default sheets created by Worksoft SaaS may be sufficient but you may also have a business case wherein you need the data in a different format or need additional fields/attributes that are not available in the sheets with different aggregation options either to satisfy other groups in your company or for you to do some analysis by creating pivot tables, etc.

To satisfy such needs, Worksoft SaaS allows you to extend the basic functionality by adding additional sheet(s) or more to the excel report. Worksoft SaaS not only allows you to choose what fields/attributes to be shown in the sheet but also allows you to specify the formatting options and summary options.

There are four QaCONNECT Services available in the Analytics section of the Docs page which help you to download/preview the custom template, generate the custom template & delete it when the template is not used by you or your team members in the Project.

QaCONNECT Services for configuring the Transactions Detail Report:

1. Worksoft SaaS provides you four sample JSONs based on different usage contexts which can be downloaded using this QaCONNECT Service. You need to trigger this service by specifying all the mandatory fields and file names as Sample1/Sample2/Sample3/Sample4 based on the requirement.

   
   

   S.No	Description	File Names to be specified to the download the JSON
   1	Summary of Execution Times by Application Modules and Testing Context	Sample1
   2	Summary of Capacity Utilization by Application Modules and Device	Sample2
   3	Summary of Bug Triage Report	Sample3
   4	Summary of the type of Browser and Device Versions used	Sample4

   Sample1:

   Using the QaCONNECT service you can generate the additional sheet by using the sample JSON specified as 'Sample1' which provides the filtered data in the below output format which allows you to view the summary of the Execution Times of the Test Runs based on Application Modules and Testing Context.

   
   

   Sample2:

   Using the QaCONNECT service you can generate the additional sheet by using the sample JSON specified as 'Sample2' filters the data in the below output format summarizes the capacity utilized based on the Application Modules and the Device version.

   
   

   Sample3:

   Using the QaCONNECT service, you can generate the additional sheet by using the sample JSON specified as 'Sample3' filters the data in the below output format with the fail counts of the executed tests on the test cycle.

   
   

   Sample4:

   Using the QaCONNECT service, you can generate the additional sheet by using the sample JSON specified as 'Sample4' filters the data in the below output format which allows you to view the summary of the type of Browser Versions and Device Versions executed for the different test runs tagged to a Test Cycle.
   

   
   

2. Triggering this service with the request JSON and all the mandatory fields allows you to view the additional template in the Transactions Detail Report for the newly generated Test Cycle Test Outcomes Report(s).

   
   

3. You have already created a custom template for the additional sheet(s) in the Transactions Detail Report and now you wish to modify the request JSON by incorporating few changes to the existing JSON. In such cases, using this QaCONNECT service, you can get/retrieve the existing template JSON and make the necessary changes to it by giving your Domain and Project details in the Request URL.

   
   

4. To delete any of the additional custom sheets from the Transactions Detail Report, you can use this service. You need to specify the project name and the sheet name in the Request JSON.
   You need not specify the specific sheet name to have all the custom sheets to be deleted.

   
   

Getting started with generating the custom template(s):

You can specify the input to the request JSON in different formats based on the way you wish to see the data in the Transactions Detail Report.

Below are the different cases with the JSONs & generated custom template(s).

In the example shown below, under the 'attributesForSelectClause' section allows you to view the data in the report of the specified 'key' attributes.

Output generated in the Transactions Detail Report:

To view multiple attributes information in the sheet, you just need to add multiple keys in the 'attributesForSelectClause' section as shown below.

Output generated in the Transactions Detail Report:

In a similar fashion, the below example explains to you about multiple columns by specifying the key attributes in the JSON.

Below generated Custom Sheet in the Transactions Detail Report is displaying the test runs tagged to a Test Cycle based on Cloud, Environment, Device/OS and Status of the Test Runs. Please note that if there are no values for the given attributes, the respective columns are shown empty as shown for the 'Issue Category'.

To the above example, you can perform the aggregations based on your requirements. In this example, the below attribute is appended to the existing JSON under 'attributesForAggregation' section and you can see the column name 'Fail Count' being distinguished in the custom sheet which is generated in the Transactions Detail Report. Here, 'attachedTo' attribute represents of which entity(Test Run/Scenario/Run Definition) the execution outcomes are to be displayed. In the same way, there are different attributes under 'aggregateTypeKey' to perform aggregations by referring to Docs page.

You can see the new column 'Fail Count' displaying the values of the Test Runs tagged to a Test Cycle.

To the data shown in the customized sheet of the Transactions Detail Report, you can add filtering conditions using different filter operators and in our example, for filtering of the failed Test Runs the below JSON is used.

Output generated in the Transactions Detail Report:

As you see in the above custom generated sheet, the Test Runs scheduled on different testing platforms like Desktop, Mobile Devices, and Mobile Tablets are shown in the single table. You can also create different tables for each specific platform or based on your requirements.

Output generated in the Transactions Detail Report:

Points to be considered during the Custom Template Configuration:

• When you are specifying the ‘Sheet Name’ with spaces, Worksoft SaaS will replace the spaces with an underscore to ensure that it remains as a link which provides you the navigation from the ‘Test_Cycle_Summary’ sheet to the respective sheet(s).
• On specifying the ‘orderBy’ parameter for any one of the attributes in the JSON, the respective attribute would be taken into consideration and shown in the specified sequence whereas the rest of the attributes are shown in the default sequence (Ascending Order).
• ‘Test Execution Duration’ is in ‘Seconds’ format only
• From the available list of key parameters, you have to specify either ‘attributesForSelectClause’ or ‘attributesForAggregation’ as a mandate parameter to trigger the service.
• When you want to either view the data or perform aggregations or filter the data, the 'key' attribute in the JSON is a mandatory parameter.
• The 'attachedTo' attribute in the JSON is a mandatory parameter only when the specified ‘key’ attributes are used for 'Select'/'Aggregate'/'Filter' conditions.
• The 'aggregateTypeKey' is a mandatory parameter for the ‘key’ attribute in the JSON upon which the aggregations are to be performed.
• The 'filterPattern' and ‘filterOperator’ used for performing the filtering of the data using the ‘key’ attribute are mandatory parameters.
• The ‘tableName’ in the JSON is a mandatory parameter without which the heading for each table would not be shown.

The other common parameters used in any of the above two sections in the JSON are ‘displayName’, ‘OrderBy’, ‘level’ will allow you to set the desired column name, the sequence of data and the label level respectively. Also, please note that all the fields are ‘Case-Sensitive.’

For all of the key attributes, there are many options available for performing the aggregations and filters. To know more about the options for each parameter in detail, refer to the Analytics section of the QaCONNECT REST API Docs page.

Additional Attributes for triaging the failures

You can also include the additional attributes into your customized sheet which draws the information about the issues that were created to the failed tests based on the environment. Based on the requirements, you can generate the sheet with any of the attributes available for the Bug Triage Report.