Physical Query Test Plan provides a means to group and execute a set of BI reports request for regression testing. The main goal of this Test Plan is to find the differences in the Logical Query, Physical Query and Report XML when compared with the Benchmarked data. User can drag reports from a BI Connection of BI Connection Explorer or add pages with prompted data using the intuitive user interface.

When a report is benchmarked, report meta-data such as report catalog XML, logical query and physical query gets downloaded and saved. This Test Plan is dependent on the usage tracking to retrieve the physical query. If there are any differences found between the current and the benchmarked data, differences are shown with view links when the Physical Query Test Plan is executed.

The result data gets saved when ever the Physical Query Test Plan is executed. The run history of all the previous runs are also maintained.


Usage tracking information of the BI connection is required for capturing the physical query.

For information on BI tools supported by the Physical Query Test Plan, please see here.

High-Level Steps for Adding a Physical Query Test Plan

Below are the high-level steps for adding a Physical Query Test Plan.

  1. On the side menu, click Test Plans.  
  2. Click Add New.
  3. In the New Test Plan page, select Physical Query Test Plan.
  4. In the Properties page, do the following:
    1. In the Basic Information screen, enter all the required details and click Next
    2. In the Options screen, complete the desired fields and click Save.
  5. In the Home page, do the following:
    1. Click Add test cases to add reports/views/documents to the test plan.
    2. Click Run to execute the test plan. 
  6. Click the > arrow menu button (next to Home) and select Run History to view the test plan results and manage test run history.

Setting up and Working with Physical Query Test Plan

This section walks you through the pages and the detailed explanation of options in a Physical QueryTest Plan.

Set up Properties

The Properties are divided into Basic Information and Options.

Basic Information

In Basic Information, complete the following:

Test Plan Name

Enter a name for the Physical Query Test Plan.


Create a label for easy identification and grouping of test plan. To create a label, click the Click to add label link, enter a name, and press Enter


Select a connection to the BI tool from the drop-down list.

Bi Validator Groups

Assign group(s) to the test plan. Groups selected here will allow users part of those groups to access the test plan.


In Options, complete any of the following:

  • No. of rules in parallel. Enter number of rules to run in parallel.
  • Time out. Enter a timeout value in seconds. When the report/dashboard that is being executed exceeds the timeout value, a warning message will be displayed.

Add Test Cases

When a report is benchmarked, report meta-data such as report catalog XML, logical query and physical query gets downloaded and saved. This test plan is dependent on the usage tracking to retrieve the physical query. 

How to Add Test Cases?

Reports can be added to a Physical Query Test Plan using the following steps:

  1. Ensure that you are on the Home page. If not, click the Home button.
  2. Do any one of the following:
  • Drag Dashboard pages (or Documents) from the Connection Explorer (available on the left-hand side) of the BI Connection.
  • Click Add test cases. Add the report from within the browser window that opens, click Capture, and then click Add Test Page(s) to Test Plan.
  • Click the + icon to add pages from within a browser window that opens. This method allows users to select prompts for the dashboards and capture the dashboard page URLs before adding them to the Dashboard Test Plan. This feature is only available for OBIEE connection.
  • Copy dashboard prompted links from the browser window into a notepad and import them.

Additional Tasks Post Test Case Addition

After adding the test cases, you can perform the following tasks:

Add Description

Click the Edit link under the Description column if there are any details need to be added. When finished, click Save.

User selection

Select the user from the drop-down list under the User column to run the report for that particular user.


Click the Benchmark button to benchmark the selected reports. When you do so, the report metadata such as report Catalog XML, Logical Query and Physical Query gets downloaded and saved. The benchmarking status can be known by looking at the Message column. If the metadata is not found, benchmarking will not happen and the status will be displayed as Fail. However, you can still move on to the Run page and execute the test plan with the metadata which was benchmarked. Only the metadata which was benchmarked is compared in the execution process and if there are differences, they will be shown. In case of benchmark error for metadata, the Run will show as "No differences".

Parallel rules

Enter how many number of reports/dashboards to run in parallel.

Report XML Benchmark

Click the View/Update link to view or update XML query.

Logical Query Benchmark

Click the View/Update link to view or update logical benchmarked query.

Physical Query Benchmark

Click the View/Update link to update Physical benchmarked query.

Add / Edit Parameters

Clicking the Edit link under Parameters column opens the a pop-up containing a list of report parameters, where users can add, edit, and delete parameters. For more information, see the how-to-procedure here.


Click the  Delete icon to delete the selected report(s).

More Options

Clicking  More displays the following options:


Allows you to refresh the page (if any benchmark schedule is running in the background). 


Allows you to import reports into the test plan using a text file containing report URLs. For more Import information, see the how-to-procedure here.


Allows you to export the selected report(s) in Excel format. For information on where the export options are available in a test plan and how to use them, please see the how-to-procedure here

Configure Notifications

Allows you to set up email addresses of the recipients for whom you want to send notifications about the test plan. To configure notifications, click  More available besides the Home button at the right-hand side and select Notify.

Schedule Test Plan

Allows you to schedule test plan run process at specified time/date selected from the schedule window. To schedule a test plan, click and select Schedule. To schedule test plan, click  More available besides the Home button at the right-hand side and select Schedule.

Run Physical Query Test Plan

In this page, the test plan is run. After adding the test cases, you click the Run button on the Home page to execute test cases. When you click Run, you will be navigated to the Run page, where you will need to click either Run or Run Test Cases. By any chance if you are not in the Home page, click More available besides the Home button at the right-hand side and select Run. At any point, click the Stop button to stop the on-going execution of test cases. 

When the Physical Query Test Plan is executed, any differences found between the current and the benchmarked data are shown with View links in the respective columns for Report XML Differences, Logical Query Differences, and Physical Query Differences. If there are no differences, then the text "No Differences" will be specified in the Report XML Differences, Logical Query Differences, and Physical Query Differences columns. 

Information Users in Multi-User environment can also run the test plan using the Command Line Interface.

This page contains the following options: 


If there are any related differences, then a View link is shown along with a red bubble in the columns Report XML differences, Logical Query differences, and Physical Query differences


User can add/edit comments by using the Edit link under Disposition column.

View Run History

In this page, the run history of the test plan is shown. Different time stamps of the test plan are available on the left-hand side. Each time stamp indicates when the test plan was run. By default, the latest Test Plan run details are shown.  To view previous runs details, select a particular time stamp that interests you.  Each run time stamp displays counts for all status, passed, fail, warning, error and running status. When selecting any status count, dashboards will be shown based on the selected status category.

To view Run History, click  More available besides the Home button at the right-hand side and select Run History.  

In this page, you can perform the following actions:


Click the  Refresh icon to refresh test plan results.


Select the time stamp and click the  Delete icon to remove the test run.

Delete All

Click the  Delete All icon to remove the complete test run history.


© Datagaps. All rights reserved.
Send feedback on this topic to Datagaps Support