How to setup SAP Heatmap

Learn how to set up a powerful SAP Heatmap using UiPath Test Suite!

Let’s go through the setup of the environment, connection to SAP, connecting the test cases, and leverage UiPath Test Manager for seamless testing. This process will render the SAP Heatmap and let’s see how we could make full use of it.


  • Orchestrator version should be 21.10 or higher.
  • UiPath studio version should be 21.10 or higher.
  • SAP the Heatmap is compatible with the following versions:
    • SAP ECC
    • SAP S/4HANA
    • SAP EWM.

Test manager

Assign test license

To get the test manager to display in the orchestrator, you need to add a license to your tenant with the right access. For thus you could follow the steps to enable the test manager:

Assign the license to the tenant:

  • Go the Admin panel.
    Admin logo

  • Click on the project name on the top left.

  • Click on the License section (This will display all the license available, make sure you’ve got a testing license available)
    Licenses section

  • Scroll all the way down and click on the “license allocation to user.”
    License Allocation

  • Lookup your user and click on the allocate license button.
    Edit license allocation

  • Assign your user the “Tester” license.
    License type

Display the test manager tab in the left menu:

  • Go to the Admin panel.

  • Click on your default tenant.

  • Click on the services section.

  • Lookup the test manager panel and click on the 3 dots on the bottom right and click on the enable.

  • The test manager tab will be displayed on the left side menu.

Create a test project

Once the previous steps have been done, open the test manager and let’s create the first test project. By clicking “+Create new project”, fill in the new project details form:
New project form

  • Name *: Give your new project a name
  • Prefix *: Give it a prefix of at least 3 characters
  • Description *: Give it a short description

Once created the following project summary will be displayed:

Test suite menu tabs

  • Dashboard : this tab will provide an overview of the projects based on a period.
  • Test cases : This will contain all the test cases
  • Test sets: This will contain the list of data sets for each test cases
  • Test results: This will contain all the results for your test cases.
  • Project settings: This is where your setup your project such as the integration / access as well as the custom fields definition.

SAP integration

Once the testing project is created let’s focus on the SAP connection in order to generate the Heatmap. Let’s go through each method for generating the Heatmap.

SAP instance connection

To connect the SAP instance let’s start off by opening the project in test manager and navigate to the projects setting. In the settings tab open the “Integration” tab. This will display all the connectors that UiPath test suite offers:

Let’s click on the SAP connector, and the connectors form will be displayed as such:
Connector form

Let’s start of by fill in the projects name and description, then we’re going to choose the connect to a SAP instance. This will require you to fill in the SAP instance details:

  • Application Server: IP address that your SAP system is working on.
  • System name: Three-letter SAP system ID.
  • Instance Number : SAP system number.
  • Client: SAP client tolog into.
  • User: SAP user name.
  • Password: SAP password.
  • Polling Interval: Time interval when data is brought from the SAP system. The minimum value for this is one hour.

Once all the details are filled in, save it and refresh the page and the Heatmap will be displayed.

SAP .csv import

Using the same steps as connecting an instance to SAP, but this time we’ll tick the “Upload from CSV” radio button:
SAP Heatmap csv form

This step will require you to upload an extraction from you’re SAP system in a csv format, in order to get that CSV we’ll have to follow the following steps:

  • Go to SAP and execute transaction sa38.

    • You land on the ABAP: Program Execution page, where Z_UiPath_CUST_HEATMAP_DOWNLOAD is typed in Program.
  • Run the program Z_UiPath_CUST_HEATMAP_DOWNLOAD.

  • Select the proper tab to generate and download a CSV file from one day, one week, or one month.

  • Once uploaded refresh the page and the Heatmap tab will be displayed.

UiPath SAP Heatmap

Once the tab is displayed let’s open it and have a look at what has been generated:

  • Application components : Containers inside the heatmap that contain all the transactions used inside a specific application component.
  • Transactions : Boxes inside the application containers that contain data about a certain transaction or program, such as: name, SAP code, and the percentage of test relevance in the heatmap.

Yon can zoom in on a selected area of interest and focus only on a specific SAP component or module.

  • Gray: no test cases were executed or test cases don’t exist for this transaction.
  • Red: test cases exist and one or more executions failed.
  • Green: test cases exist and all executions passed.

For any further information please find the UiPath documentation below: