Working with Heatmap

This page guides you through the user journey of interacting with the Heatmap. The page leads you through various stages, including creating test cases in Studio, setting up Heatmap ratios and configurations, examining and testing transactions, and running test sets. Check the following topics to start using the Heatmap.

Create test cases in Studio

To get started with the Heatmap, you need to create test cases for your SAP transactions with UiPath Studio. To ensure the Heatmap accurately shows which transactions are covered by tests and their status, you need to set the Studio project Enable SAP monitoring setting to True.

Linkage and connection between heatmap, test cases and transactions

All transactions inside the heatmap have a unique label automatically assigned to them at runtime. The label has the following format: TRAN:SAP_CODE or PROG:SAPPROGRAM.

The information about real executed transactions and their dependencies are collected at runtime. To allow test cases to link to the executed transactions, go to your Studio project settings, and under UI Automation Classic, set Enable SAP monitoring to True. This setting is available only for Test Automation projects.

Note: Enabling SAP monitoring under UI Automation Classic will also link test cases and transactions for UI Automation modern activities.

For example, a transaction named Create Purchase Order, with ME21N as its SAP code, has the  TRAN:ME21N label. If you want to create a test case for this transaction, the same label appears in the Labels field of the Create Test Case dialog box.

Configure Heatmap ratios and settings

After you create test cases in UiPath Studio for your SAP transactions, you can configure the ratios and settings based on which the Heatmap will display the test relevance and coverage.

Heatmap ratios

The heatmap is created based on the values of the following SAP attributes:

SAP attribute	Description	Default value
Users	The number of users using the transaction.	40
Execution	The number of executions per transaction.	10
Time	The overall processing time it takes for a transaction to execute.	10
Object	The number of development objects used in a transaction, such as screens, functional modules, tables.	10
Intensity	The type of transaction: High intensity transactions are considered the Create type of transaction Medium-intensity transactions are considered the Change type of transactions Low-intensity transactions are considered the Display type of transactions)	30

Important:

The sum of all assignment ratios must equal 100.

SAP FIORI landing pages

Additionally, you can enable or disable the Visibility of SAP Fiori landing pages in the heatmap.

Direct connection to SAP instance

The settings can be adjusted based on the customer needs from the top-right corner of the heatmap .

Connection with CSV file

You configure them when downloading the CSV file from SAP, in the Parameters tab.

Changing the heatmap settings

Changing the heatmap settings involves changing the assignment ratios of the SAP attributes used to generate the heatmap, and switching its visibility regarding SAP FIORI landing pages.

Direct connection to SAP instance

1. Select the gear icon in the top-right to open the Heatmap settings.
2. Change the assignment ratios according to your use case.
   For example, to highlight the most intense transactions (of type Create), rather than the most used ones, change the User ratio to 10, and then the Intensity ratio to 60.
3. Under Visibility, select the Display SAP FIORI landing pages toggle, to display SAP FIORI landing pages in the heatmap.

Connection with CSV file

After you run the Z_UIPATH_CUST_HEATMAP_DOWNLOAD program, go in the Parameters tab and configure the ratios.

Visit Heatmap ratios to learn more about SAP attributes and assignment ratios.

Analyze and test transactions

After you create tests for your SAP transactions, and configure the Heatmap ratios, you can start analyzing the results and testing specific transactions. Check the following sections for information on how to leverage the Heatmap.

Understanding the Heatmap results

The analysis of Heatmap results involves viewing the test coverage of your transactions, filtering test coverage types, and reviewing transaction overviews. Explore the following topics to gain a comprehensive understanding of how to examine Heatmap results.

Viewing test coverage for transactions

To see which transactions have automated tests, and the results:

1. Under the heatmap, select Passed to see the transactions that passed their test results.
2. Under the heatmap, select Failed to see the transactions that failed their test results.
3. Under the heatmap, select No test case executed to see the transactions for which no test case was executed.
4. Under heatmap, select No test case assigned to see the transactions that don't have any test cases assigned to them.
5. Under heatmap, select Show all (selected by default) to see all the above transactions.

Filtering heatmap transactions

1. Open Heatmap and select the number of transactions you want to appear from the All Transactions dropdown:
   1. All transactions (default)
   2. Top 10 transactions
   3. Top 20 transactions
2. Select the start time for transactions from the Last week dropdown:
   1. Last Month (default)
   2. Last Week
   3. Last Day
      The start and end time of transactions is displayed next to the Time Period dropdown.
3. Select the types of transactions that you want to appear from the All transaction types dropdown:
   1. Standard transactions
   2. Custom transactions
4. Select the types of interfaces where you want to see transactions from the All interface types dropdown:
   1. [T] - Transaction in SAP WinGui
   2. [R] - Report/Program in SAP WinGui
   3. [W] - Transaction in SAP WebGui
   4. [F] - Application in SAP Fiori

Checking the overview of a transaction

1. Select a transaction from the heatmap.
2. Under Details of selected transaction: Maintain Transaction Codes, select Overview
3. Check out the Transaction Name and its SAP Code.
   The SAP Code of a transaction is used to generate a unique label

Generating test cases for a specific transaction

Important:

This feature is currently part of an audit process and is not to be considered part of the FedRAMP Authorization until the review is finalized. See here the full list of features currently under review.

You can generate manual tests using Autopilot^TM for transactions viewed as part of the Heatmap. The generated test cases will have the following labels assigned:

• autopilot-generated
• TRAN:<transactionCode>

1. In the Heatmap, select a desired transaction.
2. Select Generate tests.

   The Provide Supporting Documents window opens, prompting you for attachments or other documents necessary for generating test cases.

   Figure 1. Example of the Generate tests button for the selected transaction
   

   

   
   
3. In the Provide Supporting Documents window, select additional attachments.

   These are used when generating tests. You can also upload other files yourself.

   Figure 2. Selecting a document in the Provide supporting documents window
   

   

   
   
4. Select Next and provide additional instructions that Autopilot^TM should use when generating test cases. Choose from a prompt from the Prompt library or type these instructions in the Provide Additional Guidance window.

   For instance, you can specify Autopilot^TM the number of test cases that you want to generate. The maximum number of test cases is 50.

   Figure 3. Additional instructions entered in the Provide additional guidance window
   

   

   
   
5. Select Generate tests to initiate the process.

   When the generation finishes, you will receive a Test Case generation completed notification. Depending on your notification preferences, you can receive the notification both in-app and via email.

6. Select the Test generation completed notification to review the generated test cases.
   1. Expand each test case in the Generate tests panel, and review the generated test cases.
   2. If you are satisfied with their content, select Create tests.
   Figure 4. Selecting the tests that you want to create and expanding a test case
   

   

   
   
7. If you are not satisfied with the generated test cases, select Refine tests, and provide additional details about your use case.
   1. Attach more relevant documents for Autopilot^TM to use.
   2. Click Next and type additional details in the Provide instructions text box.
   3. After refining the steps, select Regenerate tests.
   4. Click the Test generation completed notification to access the regenerated test cases.
   5. Expand each test case and review them.
   6. Select the test cases that you are satisfied with, and then select Create tests.

The test cases that are generated will feature these labels:

• autopilot-generated
• TRAN:<transactionCode>

For instance, if the label of the chosen transaction is TRAN:SE38, this same label will be applied to all test cases generated from it.

Creating test cases and test sets

After you analyze the results displayed in the Heatmap, you can start improving your testing portfolio, by creating test cases and test sets for uncovered or failed transactions. Check the following pages for steps on creating test cases and test sets for a specific transaction.

Creating test cases for a specific transaction

1. Select a transaction from the heatmap.
2. Under Details of selected transaction: Maintain Transaction Codes, select Test Cases.
3. Select Create Test Case and configure the test case that you want to create.
   You can add other labels next to the one already assigned to the test case.

   Important:

   When you create a test case for a specific transaction, make sure you leave the label already assigned to the transaction untouched. Otherwise, the test case that you create won't be linked to the transaction.

   For this example, the label that is already assigned is TRAN:SE16.

Learn more about linking test cases to transactions here.

Creating test sets for a specific transaction

1. Create test cases for a specific transaction.
2. Select the transaction for which you created the test cases.
3. Under Details of selected transaction: Maintain Transaction Codes, select Test Sets, and configure the test set that you want to create.
   Tip:

   To ease the process of linking a test set to a transaction, add the label of the transaction to the test set that you want to link. This way you can search for the test set you just created, using that specific label.

   For this example, the same label we used to create the test cases (TRAN:SE16) we added to the test set.
   
   

   

   
   
4. After you create the test set, navigate to Test Sets in Test Manager.
5. Search for the test set you created and open it.
   You can search for the test set using the label that you added at Step 3.
6. Select Tasks > Assign Test Cases > Static Assignment.
7. Search for the test cases that you created at Step 1 and assign them to this test set.
   
   

   

   
   
8. Navigate back to the Heatmap page, select the transaction, and check out the test set assigned to it.

Linking Orchestrator test set to a transaction

1. Select a transaction, and under Details of selected transaction: Maintain Transaction Codes, select Test Sets.
2. Select Link, choose the Orchestrator test sets that you want to link, and select Link.

Execute test sets for a transaction

1. Link a test set to a transaction.
2. Select More Options inline with the test set that you want to execute.
3. Select one of the following:
   • Execute Manually
   • Execute Automated
4. Check out the test results in the heatmap.

Heatmap attachments

The SAP data that generates the heatmap can be found in Test Manager's Dashboard, under Attachments:

• For ConnectSapInstance as Data Source: three JSON files are attached (for Day, Week and Month)
• For UploadFromCSV as Data Source: the uploaded CSV file is attached.