Example: Identifying Process Execution Failures with Certify Results API

This example shows you how to identify applications, windows, and objects that have process execution failures so that you can take corrective action.

Prerequisites

1. Generate a token in Certify Results API. For more information, see Generating a Token in Certify Results API.

2. If you will be using Microsoft® Power BI® Desktop, then you need to download the following:

   https://www.microsoft.com/en-us/download/details.aspx?id=58494

API Endpoints

Microsoft Power BI Desktop Example

1. Open Certify Results API Swagger page:

   http(s)://yourdomain/CertifyResultsAPI/swagger/ui/index

2. Generate a token. For more information, see Generating a Token in Certify Results API.

3. Add the API token to Swagger.

   

4. Enter the required inputs to the GET /api/v1/projects/{projectName}/StepResults/ResultFolders/{resultFolder} endpoint as described in the above API Endpoints section.

5. Click the Try it out! button.

6. Copy the URL that was generated in the Request URL section.

   Example:

   http://certifydemo/CertifyResultsAPI/api/v1/projects/Functional%20Tests/StepResults/ResultFolders/%2FFunctional%20Tests%2FExecution%20Manager?status=failed&status=aborted&startDate=05%2F01%2F2019&endDate=07%2F31%2F2019&includeObjects=true

7. Open Microsoft Power BI Desktop.

8. From the Get Data menu, select Web.

   

   The From Web dialog opens.

   

9. Select the Advanced option.

   

10. In the URL parts field, paste the URL generated in the Request URL section.

11. From the HTTP request header parameters (optional) field, enter token.

12. In the second field, paste the resultsAPIToken value.

13. Click OK.

14. From the Query window, edit the query name to Failed Steps.

    

15. In the Results column, click List.

    

16. Click the To Table button to expand the data.

    

    The To Table dialog opens.

    

17. Click OK.

18. In the Queries window, click the Expand button on the right corner of the first column.

    

19. Select the following columns:
20. WindowName
21. ProcessFullName
22. LogTestStepID
23. ApplicationVersionName
24. ObjectName
25. Narrative
26. Action Name
27. StartDate
28. Status
29. ErrorMessage

20. To convert the StartTime column to the Microsoft Power BI Date Time format, right-click on Column1:StartTime and select from the drop-down menu Split Column > By Delimiter.

    

    The Split Column by Delimiter dialog opens.

    

21. In the Select or enter delimiter field, enter T.

22. Click OK.

23. Click the Close & Apply button.

    

    The Failed Steps query and its columns appear in the Fields section.

    

24. To add TreeMap visualization, click the TreeMap button under the Visualizations section.

    

    A blank TreeMap control appears.

    

25. Drag the Failed Steps Columns into the Group, Details, and Values fields.

    

    TreeMap automatically populates.

    

26. To add Table visualization, click the Table button under the Visualizations section.

    

    A blank Table control is added.

    

27. Drag fields in the Values section.

    

    The Table automatically populates.

    

28. To add two Card visualizations, click the Card button under the Visualizations section.

    

    Two blank Card controls are added.

    

29. Drag the Column1.ProcessFullName field into the Fields section for the first card.

    

30. Change the aggregation for the column to be Count (Distinct).

31. Drag the Column1.ObjectName field into the Fields section for the second card.

    

32. Change the aggregation for the column to be Count (Distinct).

33. Save the file and publish.

 

Related Topics