Performance Test Plan can be used to monitor run times of dashboards/reports and user login in an environment by scheduling it to run periodically. Every time the performance Test Plan runs, it logs in to the BI system and logs out once the requests have been executed. The goal of this Test Plan is not to validate the data but to capture the run time and environment availability.

For information on the BI tools supported by the Performance Test Plan, please see here

High-Level Steps for Adding a Performance Test Plan

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

  1. On the side menu, click Test Plans.  
  2. Click Add New.
  3. In the New Test Plan page, select Performance 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 pagedo 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 Performance Test Plan

This section walks you through the pages and the detailed explanation of options in a Performance Test 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 Performance 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 user from the drop-down list.


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

BI Validator Groups

Select groups that can access the test plan. Only users within the selected group can view and work on this test plan. 


In Options, complete any of the following: 

  • Parallel Pages. Enter the number of pages to run in parallel. 
  • Page time out - If the report running exceeds the time specified, it will shows as timeout. 
  • SLA. Enter SLA in seconds for individual page/report.    
  • Drill down count. This option is available for OBIEE and Business Objects connection only. Allows you to  open the drill down reports to the level mentioned here. The default is 0. For information on how drill-down works, read the knowledgebase article here.    
  • Copy parent report parameters for drill report. This option is available for OBIEE connection only. Allows you to copy same parameters from parent reports for drill-down reports.
  • Row count. Enter number of rows to fetch in a report. 

Add Test Cases

In this page, dashboards/reports/views from a BI Connection are added. For Tableau connection, if users add the workbook, all the views underneath will also get added.

How to Add Test Cases?

  1. Ensure that you are on the Home page. If not, click the Home button.
  2. Do any one of the following:
  • Drag reports (or documents/views) from the Connection Explorer panel (available on the left-hand side) of the BI Connection.
  • Click Add test cases and add the report (or documents/views) 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 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 the test cases are added, you can perform the following additional tasks:


Select the format type of the report. Depending on the BI connection, the report formats available are HTML, PDF, Data, and Excel. For example, the format options for Tableau connection are HTML, PDF and Data. 


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.


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


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

More Options


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


Export button can be used to export the selected report(s). 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

Tableau Specific Only

When running the Performance Test Plan for Tableau, it is possible to select the following Run Types for Views:

  • Metrics. This request will fetch all the performance recording metrics of that tableau view.
  • Initial Request.  This will run the tableau view which fetches the bootstrap request from the tableau server which has all data related to the tableau view, along with initial page load time, custom views, and post load information
  • Tab Change. This will fetch the time taken to switch to selected tab view along with custom views and post load information. 

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 windowTo schedule test plan, click  More available besides the Home button at the right-hand side and select Schedule.

Run Performance Test Plan

In this page, you will run the Performance Test Plan. 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. 

When the Performance Test Plan is executed, it compares the run duration with the SLA and marks the page / report as Pass or Fail.

Every time the performance Test Plan runs, it logs in to the BI system and logs out once the requests have been executed. When there is a failure notification email is sent out to the appropriate users.

Additional Tasks Post Test Plan Execution

After the test plan is run, you can perform the following additional tasks:


Allows you to add/edit comments by using the Edit link under Disposition column.


Clicking the View link in the Result column helps users to view results. 

Tableau Specific Only


This is available for Tableau only. After the test plan is run, the corresponding results for Metrics, Initial Request, and Tab Change are available by clicking the View link in the Metrics column.

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

View Run History

The Run History displays a graph based on the run times to help the user verify the performance. 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. The report rows at the bottom can also be exported.  

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

The Results page contains the following options:


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